Package com.atlan.model.tasks

Class FluentTasks.FluentTasksBuilder

java.lang.Object

com.atlan.model.tasks.FluentTasks.FluentTasksBuilder

Enclosing class:

FluentTasks

public static class FluentTasks.FluentTasksBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
FluentTasks.FluentTasksBuilder	aggregate(String aggregateKey, co.elastic.clients.elasticsearch._types.aggregations.Aggregation aggregateValue)
FluentTasks.FluentTasksBuilder	aggregations(Map<? extends String,? extends co.elastic.clients.elasticsearch._types.aggregations.Aggregation> aggregations)
FluentTasks	build()
FluentTasks.FluentTasksBuilder	clearAggregations()
FluentTasks.FluentTasksBuilder	clearSorts()
FluentTasks.FluentTasksBuilder	clearWhereNots()
FluentTasks.FluentTasksBuilder	clearWheres()
FluentTasks.FluentTasksBuilder	clearWhereSomes()
FluentTasks.FluentTasksBuilder	client(AtlanClient client)	Client through which to retrieve the assets.
long	count()	Return the total number of assets that will match the supplied criteria, using the most minimal query possible (retrieves minimal data).
FluentTasks.FluentTasksBuilder	minSomes(int minSomes)	The minimum number of criteria in the "whereSomes" that must match on each search result.
FluentTasks.FluentTasksBuilder	pageSize(Integer pageSize)	Number of results to retrieve per underlying API request.
FluentTasks.FluentTasksBuilder	sort(co.elastic.clients.elasticsearch._types.SortOptions sort)
FluentTasks.FluentTasksBuilder	sorts(Collection<? extends co.elastic.clients.elasticsearch._types.SortOptions> sorts)
Stream<AtlanTask>	stream()	Run the fluent search to retrieve assets that match the supplied criteria.
Stream<AtlanTask>	stream(boolean parallel)	Run the fluent search to retrieve assets that match the supplied criteria.
TaskSearchRequest	toRequest()	Translate the Atlan fluent search into an Atlan search request.
TaskSearchRequest.TaskSearchRequestBuilder<?,?>	toRequestBuilder()	Translate the Atlan fluent search into an Atlan search request builder.
String	toString()
FluentTasks.FluentTasksBuilder	where(co.elastic.clients.elasticsearch._types.query_dsl.Query where)
FluentTasks.FluentTasksBuilder	whereNot(co.elastic.clients.elasticsearch._types.query_dsl.Query whereNot)
FluentTasks.FluentTasksBuilder	whereNots(Collection<? extends co.elastic.clients.elasticsearch._types.query_dsl.Query> whereNots)
FluentTasks.FluentTasksBuilder	wheres(Collection<? extends co.elastic.clients.elasticsearch._types.query_dsl.Query> wheres)
FluentTasks.FluentTasksBuilder	whereSome(co.elastic.clients.elasticsearch._types.query_dsl.Query whereSome)
FluentTasks.FluentTasksBuilder	whereSomes(Collection<? extends co.elastic.clients.elasticsearch._types.query_dsl.Query> whereSomes)

Methods inherited from class java.lang.Object

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

Method Details

toRequestBuilder

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

Translate the Atlan fluent search into an Atlan search request builder.

Returns:

an Atlan search request builder that encapsulates the fluent search

toRequest

public TaskSearchRequest toRequest()

Translate the Atlan fluent search into an Atlan search request.

Returns:

an Atlan search request that encapsulates the fluent search

count

public long count()
           throws AtlanException

Return the total number of assets that will match the supplied criteria, using the most minimal query possible (retrieves minimal data).

Returns:

the count of assets that will match the supplied criteria

Throws:

AtlanException - on any issues interacting with the Atlan APIs

stream

public Stream<AtlanTask> stream()
                         throws AtlanException

Run the fluent search to retrieve assets that match the supplied criteria.

Returns:

a stream of assets that match the specified criteria, lazily-fetched

Throws:

AtlanException - on any issues interacting with the Atlan APIs

stream

public Stream<AtlanTask> stream(boolean parallel)
                         throws AtlanException

Run the fluent search to retrieve assets that match the supplied criteria.

Parameters:

parallel - if true, returns a parallel stream

Returns:

a stream of assets that match the specified criteria, lazily-fetched

Throws:

AtlanException - on any issues interacting with the Atlan APIs

client

public FluentTasks.FluentTasksBuilder client(AtlanClient client)

Client through which to retrieve the assets.

Returns:

this.

sort

public FluentTasks.FluentTasksBuilder sort(co.elastic.clients.elasticsearch._types.SortOptions sort)

sorts

public FluentTasks.FluentTasksBuilder sorts(Collection<? extends co.elastic.clients.elasticsearch._types.SortOptions> sorts)

clearSorts

public FluentTasks.FluentTasksBuilder clearSorts()

aggregate

public FluentTasks.FluentTasksBuilder aggregate(String aggregateKey,
 co.elastic.clients.elasticsearch._types.aggregations.Aggregation aggregateValue)

aggregations

public FluentTasks.FluentTasksBuilder aggregations(Map<? extends String,? extends co.elastic.clients.elasticsearch._types.aggregations.Aggregation> aggregations)

clearAggregations

public FluentTasks.FluentTasksBuilder clearAggregations()

pageSize

public FluentTasks.FluentTasksBuilder pageSize(Integer pageSize)

Number of results to retrieve per underlying API request.

Returns:

this.

where

public FluentTasks.FluentTasksBuilder where(co.elastic.clients.elasticsearch._types.query_dsl.Query where)

wheres

public FluentTasks.FluentTasksBuilder wheres(Collection<? extends co.elastic.clients.elasticsearch._types.query_dsl.Query> wheres)

clearWheres

public FluentTasks.FluentTasksBuilder clearWheres()

whereNot

public FluentTasks.FluentTasksBuilder whereNot(co.elastic.clients.elasticsearch._types.query_dsl.Query whereNot)

whereNots

public FluentTasks.FluentTasksBuilder whereNots(Collection<? extends co.elastic.clients.elasticsearch._types.query_dsl.Query> whereNots)

clearWhereNots

public FluentTasks.FluentTasksBuilder clearWhereNots()

whereSome

public FluentTasks.FluentTasksBuilder whereSome(co.elastic.clients.elasticsearch._types.query_dsl.Query whereSome)

whereSomes

public FluentTasks.FluentTasksBuilder whereSomes(Collection<? extends co.elastic.clients.elasticsearch._types.query_dsl.Query> whereSomes)

clearWhereSomes

public FluentTasks.FluentTasksBuilder clearWhereSomes()

minSomes

public FluentTasks.FluentTasksBuilder minSomes(int minSomes)

The minimum number of criteria in the "whereSomes" that must match on each search result. (Defaults to 1.)

Returns:

this.

build

public FluentTasks build()

toString

public String toString()

Overrides:

toString in class Object