Package co.elastic.clients.elasticsearch.async_search

Class AsyncSearch.Builder<TDocument>

java.lang.Object

co.elastic.clients.elasticsearch.async_search.AsyncSearch.Builder<TDocument>

All Implemented Interfaces:

ObjectBuilder<AsyncSearch<TDocument>>

Enclosing class:

AsyncSearch<TDocument>

public static class AsyncSearch.Builder<TDocument>
extends java.lang.Object
implements ObjectBuilder<AsyncSearch<TDocument>>

Builder for AsyncSearch.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AsyncSearch.Builder<TDocument>	aggregations(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: aggregations
AsyncSearch<TDocument>	build()	Builds a AsyncSearch.
AsyncSearch.Builder<TDocument>	clusters(ClusterStatistics value)	API name: _clusters
AsyncSearch.Builder<TDocument>	clusters(java.util.function.Function<ClusterStatistics.Builder,ObjectBuilder<ClusterStatistics>> fn)	API name: _clusters
AsyncSearch.Builder<TDocument>	fields(java.util.Map<java.lang.String,JsonData> value)	API name: fields
AsyncSearch.Builder<TDocument>	hits(HitsMetadata<TDocument> value)	Required - API name: hits
AsyncSearch.Builder<TDocument>	hits(java.util.function.Function<HitsMetadata.Builder<TDocument>,ObjectBuilder<HitsMetadata<TDocument>>> fn)	Required - API name: hits
AsyncSearch.Builder<TDocument>	maxScore(java.lang.Double value)	API name: max_score
AsyncSearch.Builder<TDocument>	numReducePhases(java.lang.Long value)	API name: num_reduce_phases
AsyncSearch.Builder<TDocument>	pitId(java.lang.String value)	API name: pit_id
AsyncSearch.Builder<TDocument>	profile(Profile value)	API name: profile
AsyncSearch.Builder<TDocument>	profile(java.util.function.Function<Profile.Builder,ObjectBuilder<Profile>> fn)	API name: profile
AsyncSearch.Builder<TDocument>	putAggregations(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to aggregations(Map), creating the map if needed.
AsyncSearch.Builder<TDocument>	putFields(java.lang.String key, JsonData value)	Add a key/value to fields(Map), creating the map if needed.
AsyncSearch.Builder<TDocument>	putSuggest(java.lang.String key, java.util.List<Suggestion<TDocument>> value)	Add a key/value to suggest(Map), creating the map if needed.
AsyncSearch.Builder<TDocument>	scrollId(java.lang.String value)	API name: _scroll_id
AsyncSearch.Builder<TDocument>	shards(ShardStatistics value)	Required - API name: _shards
AsyncSearch.Builder<TDocument>	shards(java.util.function.Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	Required - API name: _shards
AsyncSearch.Builder<TDocument>	suggest(java.util.Map<java.lang.String,java.util.List<Suggestion<TDocument>>> value)	API name: suggest
AsyncSearch.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
AsyncSearch.Builder<TDocument>	terminatedEarly(java.lang.Boolean value)	API name: terminated_early
AsyncSearch.Builder<TDocument>	timedOut(boolean value)	Required - API name: timed_out
AsyncSearch.Builder<TDocument>	took(long value)	Required - API name: took

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

aggregations

public AsyncSearch.Builder<TDocument> aggregations(@Nullable
java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

API name: aggregations

putAggregations

public AsyncSearch.Builder<TDocument> putAggregations(java.lang.String key,
jakarta.json.JsonValue value)

Add a key/value to aggregations(Map), creating the map if needed.

clusters

public AsyncSearch.Builder<TDocument> clusters(@Nullable
ClusterStatistics value)

API name: _clusters

clusters

public AsyncSearch.Builder<TDocument> clusters(java.util.function.Function<ClusterStatistics.Builder,ObjectBuilder<ClusterStatistics>> fn)

API name: _clusters

fields

public AsyncSearch.Builder<TDocument> fields(@Nullable
java.util.Map<java.lang.String,JsonData> value)

API name: fields

putFields

public AsyncSearch.Builder<TDocument> putFields(java.lang.String key,
JsonData value)

Add a key/value to fields(Map), creating the map if needed.

hits

public AsyncSearch.Builder<TDocument> hits(HitsMetadata<TDocument> value)

Required - API name: hits

hits

public AsyncSearch.Builder<TDocument> hits(java.util.function.Function<HitsMetadata.Builder<TDocument>,ObjectBuilder<HitsMetadata<TDocument>>> fn)

Required - API name: hits

maxScore

public AsyncSearch.Builder<TDocument> maxScore(@Nullable
java.lang.Double value)

API name: max_score

numReducePhases

public AsyncSearch.Builder<TDocument> numReducePhases(@Nullable
java.lang.Long value)

API name: num_reduce_phases

profile

public AsyncSearch.Builder<TDocument> profile(@Nullable
Profile value)

API name: profile

profile

public AsyncSearch.Builder<TDocument> profile(java.util.function.Function<Profile.Builder,ObjectBuilder<Profile>> fn)

API name: profile

pitId

public AsyncSearch.Builder<TDocument> pitId(@Nullable
java.lang.String value)

API name: pit_id

scrollId

public AsyncSearch.Builder<TDocument> scrollId(@Nullable
java.lang.String value)

API name: _scroll_id

shards

public AsyncSearch.Builder<TDocument> shards(ShardStatistics value)

Required - API name: _shards

shards

public AsyncSearch.Builder<TDocument> shards(java.util.function.Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)

Required - API name: _shards

suggest

public AsyncSearch.Builder<TDocument> suggest(@Nullable
java.util.Map<java.lang.String,java.util.List<Suggestion<TDocument>>> value)

API name: suggest

putSuggest

public AsyncSearch.Builder<TDocument> putSuggest(java.lang.String key,
java.util.List<Suggestion<TDocument>> value)

Add a key/value to suggest(Map), creating the map if needed.

terminatedEarly

public AsyncSearch.Builder<TDocument> terminatedEarly(@Nullable
java.lang.Boolean value)

API name: terminated_early

timedOut

public AsyncSearch.Builder<TDocument> timedOut(boolean value)

Required - API name: timed_out

took

public AsyncSearch.Builder<TDocument> took(long value)

Required - API name: took

tDocumentSerializer

public AsyncSearch.Builder<TDocument> tDocumentSerializer(@Nullable
JsonpSerializer<TDocument> value)

Serializer for TDocument. If not set, an attempt will be made to find a serializer from the JSON context.

build

public AsyncSearch<TDocument> build()

Builds a AsyncSearch.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

java.lang.NullPointerException - if some of the required fields are null.