Package com.atlan.api

Class RolesEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HeraclesEndpoint

com.atlan.api.RolesEndpoint

public class RolesEndpoint
extends HeraclesEndpoint

API endpoints for interacting with Atlan's roles.

Nested Class Summary

Nested classes/interfaces inherited from class com.atlan.api.AbstractEndpoint

AbstractEndpoint.RawResponse

Field Summary

Fields inherited from class com.atlan.api.AbstractEndpoint

client

Constructor Summary

Constructors

Constructor	Description
RolesEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
RoleResponse	list()	Retrieve all roles defined in Atlan.
RoleResponse	list(RequestOptions options)	Retrieve all roles defined in Atlan.
RoleResponse	list(String filter)	Retrieves a list of the roles defined in Atlan.
RoleResponse	list(String filter, RequestOptions options)	Retrieves a list of the roles defined in Atlan.
RoleResponse	list(String filter, String sort, boolean count, int offset, int limit)	Retrieves a list of the roles defined in Atlan.
RoleResponse	list(String filter, String sort, boolean count, int offset, int limit, RequestOptions options)	Retrieves a list of the roles defined in Atlan.

Methods inherited from class com.atlan.api.HeraclesEndpoint

getBaseUrl

Methods inherited from class com.atlan.api.AbstractEndpoint

getBaseUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RolesEndpoint

public RolesEndpoint(AtlanClient client)

Method Details

list

public RoleResponse list(String filter,
 String sort,
 boolean count,
 int offset,
 int limit)
                  throws AtlanException

Retrieves a list of the roles defined in Atlan.

Parameters:

filter - which roles to retrieve

sort - property by which to sort the results

count - whether to return the total number of records (true) or not (false)

offset - starting point for results to return, for paging

limit - maximum number of results to be returned

Returns:

a list of roles that match the provided criteria

Throws:

AtlanException - on any API communication issue

list

public RoleResponse list(String filter,
 String sort,
 boolean count,
 int offset,
 int limit,
 RequestOptions options)
                  throws AtlanException

Retrieves a list of the roles defined in Atlan.

Parameters:

filter - which roles to retrieve

sort - property by which to sort the results

count - whether to return the total number of records (true) or not (false)

offset - starting point for results to return, for paging

limit - maximum number of results to be returned

options - to override default client settings

Returns:

a list of roles that match the provided criteria

Throws:

AtlanException - on any API communication issue

list

public RoleResponse list(String filter)
                  throws AtlanException

Retrieves a list of the roles defined in Atlan.

Parameters:

filter - which roles to retrieve

Returns:

a list of roles that match the provided criteria

Throws:

AtlanException - on any API communication issue

list

public RoleResponse list(String filter,
 RequestOptions options)
                  throws AtlanException

Retrieves a list of the roles defined in Atlan.

Parameters:

filter - which roles to retrieve

options - to override default client settings

Returns:

a list of roles that match the provided criteria

Throws:

AtlanException - on any API communication issue

list

public RoleResponse list()
                  throws AtlanException

Retrieve all roles defined in Atlan.

Returns:

a list of all the roles in Atlan

Throws:

AtlanException - on any API communication issue

list

public RoleResponse list(RequestOptions options)
                  throws AtlanException

Retrieve all roles defined in Atlan.

Parameters:

options - to override default client settings

Returns:

a list of all the roles in Atlan

Throws:

AtlanException - on any API communication issue