Package com.atlan.api

Class RequestsEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HeraclesEndpoint

com.atlan.api.RequestsEndpoint

public class RequestsEndpoint
extends HeraclesEndpoint

API endpoints for interacting with Atlan's requests.

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
RequestsEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
boolean	approve(String guid, String message)	Approve the specified request in Atlan.
boolean	approve(String guid, String message, RequestOptions options)	Approve the specified request in Atlan.
void	create(AtlanRequest request)	Create a new request.
void	create(AtlanRequest request, RequestOptions options)	Create a new request.
void	create(List<AtlanRequest> requests)	Create multiple new requests.
void	create(List<AtlanRequest> requests, RequestOptions options)	Create multiple new requests.
AtlanRequest	get(String guid)	Retrieve a single request by its unique identifier (GUID).
AtlanRequest	get(String guid, RequestOptions options)	Retrieve a single request by its unique identifier (GUID).
AtlanRequestResponse	list()	Retrieve the list of requests defined in Atlan as you would via the Admin UI.
AtlanRequestResponse	list(RequestOptions options)	Retrieve the list of requests defined in Atlan as you would via the Admin UI.
AtlanRequestResponse	list(String filter)	Retrieves a list of the requests defined in Atlan.
AtlanRequestResponse	list(String filter, RequestOptions options)	Retrieves a list of the requests defined in Atlan.
AtlanRequestResponse	list(String filter, String sort, int offset, int limit)	Retrieves a list of the requests defined in Atlan.
AtlanRequestResponse	list(String filter, String sort, int offset, int limit, RequestOptions options)	Retrieves a list of the requests defined in Atlan.
AtlanRequestResponse	listActionable()	Retrieve the list of requests that can be acted upon.
AtlanRequestResponse	listActionable(RequestOptions options)	Retrieve the list of requests that can be acted upon.
AtlanRequestResponse	listActionable(String filter)	Retrieve the list of requests that can be acted upon.
AtlanRequestResponse	listActionable(String filter, RequestOptions options)	Retrieve the list of requests that can be acted upon.
AtlanRequestResponse	listActionable(String filter, String sort, int offset, int limit)	Retrieve the list of requests that can be acted upon.
AtlanRequestResponse	listActionable(String filter, String sort, int offset, int limit, RequestOptions options)	Retrieve the list of requests that can be acted upon.
boolean	reject(String guid, String message)	Reject the specified request in Atlan.
boolean	reject(String guid, String message, RequestOptions options)	Reject the specified request 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

RequestsEndpoint

public RequestsEndpoint(AtlanClient client)

Method Details

get

public AtlanRequest get(String guid)
                 throws AtlanException

Retrieve a single request by its unique identifier (GUID).

Parameters:

guid - of the request to retrieve

Returns:

the unique request, or null if none exists with that GUID

Throws:

AtlanException - on any API communication issue

get

public AtlanRequest get(String guid,
 RequestOptions options)
                 throws AtlanException

Retrieve a single request by its unique identifier (GUID).

Parameters:

guid - of the request to retrieve

options - to override default client settings

Returns:

the unique request, or null if none exists with that GUID

Throws:

AtlanException - on any API communication issue

list

public AtlanRequestResponse list(String filter,
 String sort,
 int offset,
 int limit)
                          throws AtlanException

Retrieves a list of the requests defined in Atlan.

Parameters:

filter - which requests to retrieve

sort - property by which to sort the results

offset - starting point for results to return, for paging

limit - maximum number of results to be returned

Returns:

a list of requests that match the provided criteria

Throws:

AtlanException - on any API communication issue

list

public AtlanRequestResponse list(String filter,
 String sort,
 int offset,
 int limit,
 RequestOptions options)
                          throws AtlanException

Retrieves a list of the requests defined in Atlan.

Parameters:

filter - which requests to retrieve

sort - property by which to sort the results

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 requests that match the provided criteria

Throws:

AtlanException - on any API communication issue

list

public AtlanRequestResponse list(String filter)
                          throws AtlanException

Retrieves a list of the requests defined in Atlan.

Parameters:

filter - which requests to retrieve

Returns:

a list of requests that match the provided criteria

Throws:

AtlanException - on any API communication issue

list

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

Retrieves a list of the requests defined in Atlan.

Parameters:

filter - which requests to retrieve

options - to override default client settings

Returns:

a list of requests that match the provided criteria

Throws:

AtlanException - on any API communication issue

list

public AtlanRequestResponse list()
                          throws AtlanException

Retrieve the list of requests defined in Atlan as you would via the Admin UI.

Returns:

a list of all the requests in Atlan

Throws:

AtlanException - on any API communication issue

list

public AtlanRequestResponse list(RequestOptions options)
                          throws AtlanException

Retrieve the list of requests defined in Atlan as you would via the Admin UI.

Parameters:

options - to override default client settings

Returns:

a list of all the requests in Atlan

Throws:

AtlanException - on any API communication issue

listActionable

public AtlanRequestResponse listActionable(String filter,
 String sort,
 int offset,
 int limit)
                                    throws AtlanException

Retrieve the list of requests that can be acted upon.

Parameters:

filter - which requests to retrieve

sort - property by which to sort the results

offset - starting point for results to return, for paging

limit - maximum number of results to be returned

Returns:

a list of actionable requests that match the provided criteria

Throws:

AtlanException - on any API communication issue

listActionable

public AtlanRequestResponse listActionable(String filter,
 String sort,
 int offset,
 int limit,
 RequestOptions options)
                                    throws AtlanException

Retrieve the list of requests that can be acted upon.

Parameters:

filter - which requests to retrieve

sort - property by which to sort the results

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 actionable requests that match the provided criteria

Throws:

AtlanException - on any API communication issue

listActionable

public AtlanRequestResponse listActionable(String filter)
                                    throws AtlanException

Retrieve the list of requests that can be acted upon.

Parameters:

filter - which requests to retrieve

Returns:

a list of actionable requests that match the provided criteria

Throws:

AtlanException - on any API communication issue

listActionable

public AtlanRequestResponse listActionable(String filter,
 RequestOptions options)
                                    throws AtlanException

Retrieve the list of requests that can be acted upon.

Parameters:

filter - which requests to retrieve

options - to override default client settings

Returns:

a list of actionable requests that match the provided criteria

Throws:

AtlanException - on any API communication issue

listActionable

public AtlanRequestResponse listActionable()
                                    throws AtlanException

Retrieve the list of requests that can be acted upon.

Returns:

a list of actionable requests based on default criteria

Throws:

AtlanException - on any API communication issue

listActionable

public AtlanRequestResponse listActionable(RequestOptions options)
                                    throws AtlanException

Retrieve the list of requests that can be acted upon.

Parameters:

options - to override default client settings

Returns:

a list of actionable requests based on default criteria

Throws:

AtlanException - on any API communication issue

create

public void create(AtlanRequest request)
            throws AtlanException

Create a new request.

Parameters:

request - the details of the new request

Throws:

AtlanException - on any API communication issue

create

public void create(AtlanRequest request,
 RequestOptions options)
            throws AtlanException

Create a new request.

Parameters:

request - the details of the new request

options - to override default client settings

Throws:

AtlanException - on any API communication issue

create

public void create(List<AtlanRequest> requests)
            throws AtlanException

Create multiple new requests.

Parameters:

requests - the details of the new requests to create

Throws:

AtlanException - on any API communication issue

create

public void create(List<AtlanRequest> requests,
 RequestOptions options)
            throws AtlanException

Create multiple new requests.

Parameters:

requests - the details of the new requests to create

options - to override default client settings

Throws:

AtlanException - on any API communication issue

approve

public boolean approve(String guid,
 String message)
                throws AtlanException

Approve the specified request in Atlan.

Parameters:

guid - unique identifier (GUID) of the request to approve

message - (optional) message to include with the approval

Returns:

true if the approval succeeded, otherwise false

Throws:

AtlanException - on any API interaction issues

approve

public boolean approve(String guid,
 String message,
 RequestOptions options)
                throws AtlanException

Approve the specified request in Atlan.

Parameters:

guid - unique identifier (GUID) of the request to approve

message - (optional) message to include with the approval

options - to override default client settings

Returns:

true if the approval succeeded, otherwise false

Throws:

AtlanException - on any API interaction issues

reject

public boolean reject(String guid,
 String message)
               throws AtlanException

Reject the specified request in Atlan.

Parameters:

guid - unique identifier (GUID) of the request to reject

message - (optional) message to include with the rejection

Returns:

true if the rejection succeeded, otherwise false

Throws:

AtlanException - on any API interaction issues

reject

public boolean reject(String guid,
 String message,
 RequestOptions options)
               throws AtlanException

Reject the specified request in Atlan.

Parameters:

guid - unique identifier (GUID) of the request to reject

message - (optional) message to include with the rejection

options - to override default client settings

Returns:

true if the rejection succeeded, otherwise false

Throws:

AtlanException - on any API interaction issues