Package com.atlan.model.tasks

Class TaskSearchRequest

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.tasks.TaskSearchRequest

All Implemented Interfaces:

Serializable

public class TaskSearchRequest
extends AtlanObject

Class from which to configure and run a search against Atlan's task queue.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TaskSearchRequest.TaskSearchRequestBuilder<C extends TaskSearchRequest,B extends TaskSearchRequest.TaskSearchRequestBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TaskSearchRequest(TaskSearchRequest.TaskSearchRequestBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static TaskSearchRequest.TaskSearchRequestBuilder<?,?>	_internal()
static TaskSearchRequest.TaskSearchRequestBuilder<?,?>	builder(co.elastic.clients.elasticsearch._types.query_dsl.Query query)	Build a search using the provided query and default options.
static TaskSearchRequest.TaskSearchRequestBuilder<?,?>	builder(IndexSearchDSL dsl)	Build a search using the provided DSL and default options.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
IndexSearchDSL	getDsl()	Parameters for the search itself.
int	hashCode()
TaskSearchResponse	search()	Run the search.
TaskSearchResponse	search(AtlanClient client)	Run the search.
TaskSearchRequest.TaskSearchRequestBuilder<?,?>	toBuilder()
String	toString()

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TaskSearchRequest

protected TaskSearchRequest(TaskSearchRequest.TaskSearchRequestBuilder<?,?> b)

Method Details

builder

public static TaskSearchRequest.TaskSearchRequestBuilder<?,?> builder(co.elastic.clients.elasticsearch._types.query_dsl.Query query)

Build a search using the provided query and default options.

Parameters:

query - the query to use for the search

Returns:

the search request, with default options

builder

public static TaskSearchRequest.TaskSearchRequestBuilder<?,?> builder(IndexSearchDSL dsl)

Build a search using the provided DSL and default options.

Parameters:

dsl - the query details to use for the search

Returns:

the search request, with default options

search

public TaskSearchResponse search()
                          throws AtlanException

Run the search.

Returns:

the matching task queue records

Throws:

AtlanException

search

public TaskSearchResponse search(AtlanClient client)
                          throws AtlanException

Run the search.

Parameters:

client - connectivity to the Atlan tenant on which to search the task queue

Returns:

the matching task queue records

Throws:

AtlanException

_internal

public static TaskSearchRequest.TaskSearchRequestBuilder<?,?> _internal()

toBuilder

public TaskSearchRequest.TaskSearchRequestBuilder<?,?> toBuilder()

getDsl

public IndexSearchDSL getDsl()

Parameters for the search itself.

equals

public boolean equals(Object o)

Overrides:

equals in class AtlanObject

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AtlanObject

hashCode

public int hashCode()

Overrides:

hashCode in class AtlanObject

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class AtlanObject