Package com.atlan.model.search

Class IndexSearchDSL.IndexSearchDSLBuilder<C extends IndexSearchDSL,B extends IndexSearchDSL.IndexSearchDSLBuilder<C,B>>

java.lang.Object

com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>

com.atlan.model.search.IndexSearchDSL.IndexSearchDSLBuilder<C,B>

Direct Known Subclasses:

WorkflowSearchRequest.WorkflowSearchRequestBuilder

Enclosing class:

IndexSearchDSL

public abstract static class IndexSearchDSL.IndexSearchDSLBuilder<C extends IndexSearchDSL,B extends IndexSearchDSL.IndexSearchDSLBuilder<C,B>>
extends AtlanObject.AtlanObjectBuilder<C,B>

Constructor Summary

Constructors

Constructor	Description
IndexSearchDSLBuilder()

Method Summary

Modifier and Type	Method	Description
protected B	$fillValuesFrom(C instance)
B	aggregation(String aggregationKey, co.elastic.clients.elasticsearch._types.aggregations.Aggregation aggregationValue)
B	aggregations(Map<? extends String,? extends co.elastic.clients.elasticsearch._types.aggregations.Aggregation> aggregations)
abstract C	build()
B	clearAggregations()
B	clearPageOffsets()
B	clearSort()
B	from(Integer from)	Starting point for paging.
B	pageOffset(Object pageOffset)
B	pageOffsets(Collection<? extends Object> pageOffsets)
B	query(co.elastic.clients.elasticsearch._types.query_dsl.Query query)	Query to run.
protected abstract B	self()
B	size(Integer size)	Number of results to return per page.
B	sort(Collection<? extends co.elastic.clients.elasticsearch._types.SortOptions> sort)
B	sortOption(co.elastic.clients.elasticsearch._types.SortOptions sortOption)
String	toString()
B	trackTotalHits(Boolean trackTotalHits)	When true, specify the precise number of results in the response, otherwise estimate and max-out at 10,000.

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

rawJsonObject

Methods inherited from class java.lang.Object

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

Constructor Details

IndexSearchDSLBuilder

public IndexSearchDSLBuilder()

Method Details

$fillValuesFrom

protected B $fillValuesFrom(C instance)

Overrides:

$fillValuesFrom in class AtlanObject.AtlanObjectBuilder<C extends IndexSearchDSL,B extends IndexSearchDSL.IndexSearchDSLBuilder<C,B>>

from

public B from(Integer from)

Starting point for paging. Defaults to 0 (very first result) if not overridden.

Returns:

this.

size

public B size(Integer size)

Number of results to return per page. Defaults to 300 results per page if not overridden.

Returns:

this.

trackTotalHits

public B trackTotalHits(Boolean trackTotalHits)

When true, specify the precise number of results in the response, otherwise estimate and max-out at 10,000. (Defaults to true.)

Returns:

this.

aggregation

public B aggregation(String aggregationKey,
 co.elastic.clients.elasticsearch._types.aggregations.Aggregation aggregationValue)

aggregations

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

clearAggregations

public B clearAggregations()

query

public B query(co.elastic.clients.elasticsearch._types.query_dsl.Query query)

Query to run.

Returns:

this.

sortOption

public B sortOption(co.elastic.clients.elasticsearch._types.SortOptions sortOption)

sort

public B sort(Collection<? extends co.elastic.clients.elasticsearch._types.SortOptions> sort)

clearSort

public B clearSort()

pageOffset

public B pageOffset(Object pageOffset)

pageOffsets

public B pageOffsets(Collection<? extends Object> pageOffsets)

clearPageOffsets

public B clearPageOffsets()

self

protected abstract B self()

Specified by:

self in class AtlanObject.AtlanObjectBuilder<C extends IndexSearchDSL,B extends IndexSearchDSL.IndexSearchDSLBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class AtlanObject.AtlanObjectBuilder<C extends IndexSearchDSL,B extends IndexSearchDSL.IndexSearchDSLBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class AtlanObject.AtlanObjectBuilder<C extends IndexSearchDSL,B extends IndexSearchDSL.IndexSearchDSLBuilder<C,B>>