Package co.elastic.clients.elasticsearch.async_search

Class AsyncSearch.Builder<TDocument>

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<AsyncSearch.Builder<TDocument>>

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

All Implemented Interfaces:

WithJson<AsyncSearch.Builder<TDocument>>, ObjectBuilder<AsyncSearch<TDocument>>

Enclosing class:

AsyncSearch<TDocument>

public static class AsyncSearch.Builder<TDocument>
extends WithJsonObjectBuilderBase<AsyncSearch.Builder<TDocument>>
implements ObjectBuilder<AsyncSearch<TDocument>>

Builder for AsyncSearch.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AsyncSearch.Builder<TDocument>	aggregations(String key, Aggregate value)	Partial aggregations results, coming from the shards that have already completed the execution of the query.
final AsyncSearch.Builder<TDocument>	aggregations(String key, Function<Aggregate.Builder,ObjectBuilder<Aggregate>> fn)	Partial aggregations results, coming from the shards that have already completed the execution of the query.
final AsyncSearch.Builder<TDocument>	aggregations(Map<String,Aggregate> map)	Partial aggregations results, coming from the shards that have already completed the execution of the query.
AsyncSearch<TDocument>	build()	Builds a AsyncSearch.
final AsyncSearch.Builder<TDocument>	clusters(ClusterStatistics value)	API name: _clusters
final AsyncSearch.Builder<TDocument>	clusters(Function<ClusterStatistics.Builder,ObjectBuilder<ClusterStatistics>> fn)	API name: _clusters
final AsyncSearch.Builder<TDocument>	fields(String key, JsonData value)	API name: fields
final AsyncSearch.Builder<TDocument>	fields(Map<String,JsonData> map)	API name: fields
final AsyncSearch.Builder<TDocument>	hits(HitsMetadata<TDocument> value)	Required - API name: hits
final AsyncSearch.Builder<TDocument>	hits(Function<HitsMetadata.Builder<TDocument>,ObjectBuilder<HitsMetadata<TDocument>>> fn)	Required - API name: hits
final AsyncSearch.Builder<TDocument>	maxScore(Double value)	API name: max_score
final AsyncSearch.Builder<TDocument>	numReducePhases(Long value)	Indicates how many reductions of the results have been performed.
final AsyncSearch.Builder<TDocument>	pitId(String value)	API name: pit_id
final AsyncSearch.Builder<TDocument>	profile(Profile value)	API name: profile
final AsyncSearch.Builder<TDocument>	profile(Function<Profile.Builder,ObjectBuilder<Profile>> fn)	API name: profile
final AsyncSearch.Builder<TDocument>	scrollId(String value)	API name: _scroll_id
protected AsyncSearch.Builder<TDocument>	self()
final AsyncSearch.Builder<TDocument>	shards(ShardStatistics value)	Required - Indicates how many shards have run the query.
final AsyncSearch.Builder<TDocument>	shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	Required - Indicates how many shards have run the query.
final AsyncSearch.Builder<TDocument>	suggest(String key, List<Suggestion<TDocument>> value)	API name: suggest
final AsyncSearch.Builder<TDocument>	suggest(Map<String,List<Suggestion<TDocument>>> map)	API name: suggest
final AsyncSearch.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
final AsyncSearch.Builder<TDocument>	terminatedEarly(Boolean value)	API name: terminated_early
final AsyncSearch.Builder<TDocument>	timedOut(boolean value)	Required - API name: timed_out
final AsyncSearch.Builder<TDocument>	took(long value)	Required - API name: took

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

aggregations

public final AsyncSearch.Builder<TDocument> aggregations(Map<String,Aggregate> map)

Partial aggregations results, coming from the shards that have already completed the execution of the query.

API name: aggregations

Adds all entries of map to aggregations.

aggregations

public final AsyncSearch.Builder<TDocument> aggregations(String key,
 Aggregate value)

Partial aggregations results, coming from the shards that have already completed the execution of the query.

API name: aggregations

Adds an entry to aggregations.

aggregations

public final AsyncSearch.Builder<TDocument> aggregations(String key,
 Function<Aggregate.Builder,ObjectBuilder<Aggregate>> fn)

Partial aggregations results, coming from the shards that have already completed the execution of the query.

API name: aggregations

Adds an entry to aggregations using a builder lambda.

clusters

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

API name: _clusters

clusters

public final AsyncSearch.Builder<TDocument> clusters(Function<ClusterStatistics.Builder,ObjectBuilder<ClusterStatistics>> fn)

API name: _clusters

fields

public final AsyncSearch.Builder<TDocument> fields(Map<String,JsonData> map)

API name: fields

Adds all entries of map to fields.

fields

public final AsyncSearch.Builder<TDocument> fields(String key,
 JsonData value)

API name: fields

Adds an entry to fields.

hits

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

Required - API name: hits

hits

public final AsyncSearch.Builder<TDocument> hits(Function<HitsMetadata.Builder<TDocument>,ObjectBuilder<HitsMetadata<TDocument>>> fn)

Required - API name: hits

maxScore

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

API name: max_score

numReducePhases

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

Indicates how many reductions of the results have been performed. If this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response.

API name: num_reduce_phases

profile

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

API name: profile

profile

public final AsyncSearch.Builder<TDocument> profile(Function<Profile.Builder,ObjectBuilder<Profile>> fn)

API name: profile

pitId

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

API name: pit_id

scrollId

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

API name: _scroll_id

shards

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

Required - Indicates how many shards have run the query. Note that in order for shard results to be included in the search response, they need to be reduced first.

API name: _shards

shards

public final AsyncSearch.Builder<TDocument> shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)

Required - Indicates how many shards have run the query. Note that in order for shard results to be included in the search response, they need to be reduced first.

API name: _shards

suggest

public final AsyncSearch.Builder<TDocument> suggest(Map<String,List<Suggestion<TDocument>>> map)

API name: suggest

Adds all entries of map to suggest.

suggest

public final AsyncSearch.Builder<TDocument> suggest(String key,
 List<Suggestion<TDocument>> value)

API name: suggest

Adds an entry to suggest.

terminatedEarly

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

API name: terminated_early

timedOut

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

Required - API name: timed_out

took

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

Required - API name: took

tDocumentSerializer

public final 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.

self

protected AsyncSearch.Builder<TDocument> self()

Specified by:

self in class WithJsonObjectBuilderBase<AsyncSearch.Builder<TDocument>>

build

public AsyncSearch<TDocument> build()

Builds a AsyncSearch.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

NullPointerException - if some of the required fields are null.