Package com.atlan.api

Class TaskEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.AtlasEndpoint

com.atlan.api.TaskEndpoint

public class TaskEndpoint
extends AtlasEndpoint

API endpoints for operating on tasks.

Nested Class Summary

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

AbstractEndpoint.RawResponse, AbstractEndpoint.ThrowingSupplier<T,E extends Exception>

Field Summary

Fields inherited from class com.atlan.api.AbstractEndpoint

client

Constructor Summary

Constructors

Constructor	Description
TaskEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
TaskSearchResponse	search(TaskSearchRequest request)	Run the requested search.
TaskSearchResponse	search(TaskSearchRequest request, RequestOptions options)	Run the requested search.
FluentTasks.FluentTasksBuilder	select()	Start a fluent task queue search that will return all tasks.

Methods inherited from class com.atlan.api.AtlasEndpoint

getBaseUrl

Methods inherited from class com.atlan.api.AbstractEndpoint

executeWithRetries, getBaseUrl, getClient

Methods inherited from class java.lang.Object

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

Constructor Details

TaskEndpoint

public TaskEndpoint(AtlanClient client)

Method Details

select

public FluentTasks.FluentTasksBuilder select()

Start a fluent task queue search that will return all tasks. Additional conditions can be chained onto the returned filter before any task retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.

Returns:

a fluent task queue search that includes all tasks

search

public TaskSearchResponse search(TaskSearchRequest request)
                          throws AtlanException

Run the requested search.

Parameters:

request - detailing the search query, parameters, and so on to run

Returns:

the results of the search

Throws:

AtlanException - on any API interaction problems

search

public TaskSearchResponse search(TaskSearchRequest request,
 RequestOptions options)
                          throws AtlanException

Run the requested search.

Parameters:

request - detailing the search query, parameters, and so on to run

options - to override default client settings

Returns:

the results of the search

Throws:

AtlanException - on any API interaction problems