Package co.elastic.clients.elasticsearch._types

Class StandardRetriever.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RetrieverBase.AbstractBuilder<StandardRetriever.Builder>

co.elastic.clients.elasticsearch._types.StandardRetriever.Builder

All Implemented Interfaces:

WithJson<StandardRetriever.Builder>, ObjectBuilder<StandardRetriever>

Enclosing class:

StandardRetriever

public static class StandardRetriever.Builder
extends RetrieverBase.AbstractBuilder<StandardRetriever.Builder>
implements ObjectBuilder<StandardRetriever>

Builder for StandardRetriever.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StandardRetriever	build()	Builds a StandardRetriever.
final StandardRetriever.Builder	collapse(FieldCollapse value)	Collapses the top documents by a specified key into a single top document per key.
final StandardRetriever.Builder	collapse(Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)	Collapses the top documents by a specified key into a single top document per key.
final StandardRetriever.Builder	query(Query value)	Defines a query to retrieve a set of top documents.
final StandardRetriever.Builder	query(QueryVariant value)	Defines a query to retrieve a set of top documents.
final StandardRetriever.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	Defines a query to retrieve a set of top documents.
final StandardRetriever.Builder	searchAfter(boolean value, boolean... values)	Defines a search after object parameter used for pagination.
final StandardRetriever.Builder	searchAfter(double value, double... values)	Defines a search after object parameter used for pagination.
final StandardRetriever.Builder	searchAfter(long value, long... values)	Defines a search after object parameter used for pagination.
final StandardRetriever.Builder	searchAfter(FieldValue value, FieldValue... values)	Defines a search after object parameter used for pagination.
final StandardRetriever.Builder	searchAfter(String value, String... values)	Defines a search after object parameter used for pagination.
final StandardRetriever.Builder	searchAfter(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	Defines a search after object parameter used for pagination.
final StandardRetriever.Builder	searchAfter(List<FieldValue> list)	Defines a search after object parameter used for pagination.
protected StandardRetriever.Builder	self()
final StandardRetriever.Builder	sort(SortOptions value, SortOptions... values)	A sort object that that specifies the order of matching documents.
final StandardRetriever.Builder	sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	A sort object that that specifies the order of matching documents.
final StandardRetriever.Builder	sort(List<SortOptions> list)	A sort object that that specifies the order of matching documents.
final StandardRetriever.Builder	terminateAfter(Integer value)	Maximum number of documents to collect for each shard.

Methods inherited from class co.elastic.clients.elasticsearch._types.RetrieverBase.AbstractBuilder

filter, filter, filter, filter, minScore, name

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

query

public final StandardRetriever.Builder query(@Nullable
 Query value)

Defines a query to retrieve a set of top documents.

API name: query

query

public final StandardRetriever.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

Defines a query to retrieve a set of top documents.

API name: query

query

public final StandardRetriever.Builder query(QueryVariant value)

Defines a query to retrieve a set of top documents.

API name: query

searchAfter

public final StandardRetriever.Builder searchAfter(List<FieldValue> list)

Defines a search after object parameter used for pagination.

API name: search_after

Adds all elements of list to searchAfter.

searchAfter

public final StandardRetriever.Builder searchAfter(FieldValue value,
 FieldValue... values)

Defines a search after object parameter used for pagination.

API name: search_after

Adds one or more values to searchAfter.

searchAfter

public final StandardRetriever.Builder searchAfter(String value,
 String... values)

Defines a search after object parameter used for pagination.

API name: search_after

Adds one or more values to searchAfter.

searchAfter

public final StandardRetriever.Builder searchAfter(long value,
 long... values)

Defines a search after object parameter used for pagination.

API name: search_after

Adds one or more values to searchAfter.

searchAfter

public final StandardRetriever.Builder searchAfter(double value,
 double... values)

Defines a search after object parameter used for pagination.

API name: search_after

Adds one or more values to searchAfter.

searchAfter

public final StandardRetriever.Builder searchAfter(boolean value,
 boolean... values)

Defines a search after object parameter used for pagination.

API name: search_after

Adds one or more values to searchAfter.

searchAfter

public final StandardRetriever.Builder searchAfter(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

Defines a search after object parameter used for pagination.

API name: search_after

Adds a value to searchAfter using a builder lambda.

terminateAfter

public final StandardRetriever.Builder terminateAfter(@Nullable
 Integer value)

Maximum number of documents to collect for each shard.

API name: terminate_after

sort

public final StandardRetriever.Builder sort(List<SortOptions> list)

A sort object that that specifies the order of matching documents.

API name: sort

Adds all elements of list to sort.

sort

public final StandardRetriever.Builder sort(SortOptions value,
 SortOptions... values)

A sort object that that specifies the order of matching documents.

API name: sort

Adds one or more values to sort.

sort

public final StandardRetriever.Builder sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)

A sort object that that specifies the order of matching documents.

API name: sort

Adds a value to sort using a builder lambda.

collapse

public final StandardRetriever.Builder collapse(@Nullable
 FieldCollapse value)

Collapses the top documents by a specified key into a single top document per key.

API name: collapse

collapse

public final StandardRetriever.Builder collapse(Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)

Collapses the top documents by a specified key into a single top document per key.

API name: collapse

self

protected StandardRetriever.Builder self()

Specified by:

self in class RetrieverBase.AbstractBuilder<StandardRetriever.Builder>

build

public StandardRetriever build()

Builds a StandardRetriever.

Specified by:

build in interface ObjectBuilder<StandardRetriever>

Throws:

NullPointerException - if some of the required fields are null.