Package co.elastic.clients.elasticsearch.core.search

Class ResponseBody.AbstractBuilder<TDocument,BuilderT extends ResponseBody.AbstractBuilder<TDocument,BuilderT>>

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.core.search.ResponseBody.AbstractBuilder<TDocument,BuilderT>

All Implemented Interfaces:

WithJson<BuilderT>

Direct Known Subclasses:

MultiSearchItem.Builder, ScrollResponse.Builder, SearchApplicationSearchResponse.Builder, SearchResponse.Builder

Enclosing class:

ResponseBody<TDocument>

public abstract static class ResponseBody.AbstractBuilder<TDocument,BuilderT extends ResponseBody.AbstractBuilder<TDocument,BuilderT>>
extends WithJsonObjectBuilderBase<BuilderT>

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
final BuilderT	aggregations(String key, Aggregate value)	API name: aggregations
final BuilderT	aggregations(String key, Function<Aggregate.Builder,ObjectBuilder<Aggregate>> fn)	API name: aggregations
final BuilderT	aggregations(Map<String,Aggregate> map)	API name: aggregations
final BuilderT	clusters(ClusterStatistics value)	API name: _clusters
final BuilderT	clusters(Function<ClusterStatistics.Builder,ObjectBuilder<ClusterStatistics>> fn)	API name: _clusters
final BuilderT	fields(String key, JsonData value)	API name: fields
final BuilderT	fields(Map<String,JsonData> map)	API name: fields
final BuilderT	hits(HitsMetadata<TDocument> value)	Required - The returned documents and metadata.
final BuilderT	hits(Function<HitsMetadata.Builder<TDocument>,ObjectBuilder<HitsMetadata<TDocument>>> fn)	Required - The returned documents and metadata.
final BuilderT	maxScore(Double value)	API name: max_score
final BuilderT	numReducePhases(Long value)	API name: num_reduce_phases
final BuilderT	pitId(String value)	API name: pit_id
final BuilderT	profile(Profile value)	API name: profile
final BuilderT	profile(Function<Profile.Builder,ObjectBuilder<Profile>> fn)	API name: profile
final BuilderT	scrollId(String value)	The identifier for the search and its search context.
protected abstract BuilderT	self()
final BuilderT	shards(ShardStatistics value)	Required - A count of shards used for the request.
final BuilderT	shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	Required - A count of shards used for the request.
final BuilderT	suggest(String key, List<Suggestion<TDocument>> value)	API name: suggest
final BuilderT	suggest(Map<String,List<Suggestion<TDocument>>> map)	API name: suggest
final BuilderT	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
final BuilderT	terminatedEarly(Boolean value)	API name: terminated_early
final BuilderT	timedOut(boolean value)	Required - If true, the request timed out before completion; returned results may be partial or empty.
final BuilderT	took(long value)	Required - The number of milliseconds it took Elasticsearch to run the request.

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

AbstractBuilder

public AbstractBuilder()

Method Details

took

public final BuilderT took(long value)

Required - The number of milliseconds it took Elasticsearch to run the request. This value is calculated by measuring the time elapsed between receipt of a request on the coordinating node and the time at which the coordinating node is ready to send the response. It includes:

• Communication time between the coordinating node and data nodes
• Time the request spends in the search thread pool, queued for execution
• Actual run time

It does not include:

• Time needed to send the request to Elasticsearch
• Time needed to serialize the JSON response
• Time needed to send the response to a client

API name: took

timedOut

public final BuilderT timedOut(boolean value)

Required - If true, the request timed out before completion; returned results may be partial or empty.

API name: timed_out

shards

public final BuilderT shards(ShardStatistics value)

Required - A count of shards used for the request.

API name: _shards

shards

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

Required - A count of shards used for the request.

API name: _shards

hits

public final BuilderT hits(HitsMetadata<TDocument> value)

Required - The returned documents and metadata.

API name: hits

hits

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

Required - The returned documents and metadata.

API name: hits

aggregations

public final BuilderT aggregations(Map<String,Aggregate> map)

API name: aggregations

Adds all entries of map to aggregations.

aggregations

public final BuilderT aggregations(String key,
 Aggregate value)

API name: aggregations

Adds an entry to aggregations.

aggregations

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

API name: aggregations

Adds an entry to aggregations using a builder lambda.

clusters

public final BuilderT clusters(@Nullable
 ClusterStatistics value)

API name: _clusters

clusters

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

API name: _clusters

fields

public final BuilderT fields(Map<String,JsonData> map)

API name: fields

Adds all entries of map to fields.

fields

public final BuilderT fields(String key,
 JsonData value)

API name: fields

Adds an entry to fields.

maxScore

public final BuilderT maxScore(@Nullable
 Double value)

API name: max_score

numReducePhases

public final BuilderT numReducePhases(@Nullable
 Long value)

API name: num_reduce_phases

profile

public final BuilderT profile(@Nullable
 Profile value)

API name: profile

profile

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

API name: profile

pitId

public final BuilderT pitId(@Nullable
 String value)

API name: pit_id

scrollId

public final BuilderT scrollId(@Nullable
 String value)

The identifier for the search and its search context. You can use this scroll ID with the scroll API to retrieve the next batch of search results for the request. This property is returned only if the scroll query parameter is specified in the request.

API name: _scroll_id

suggest

public final BuilderT suggest(Map<String,List<Suggestion<TDocument>>> map)

API name: suggest

Adds all entries of map to suggest.

suggest

public final BuilderT suggest(String key,
 List<Suggestion<TDocument>> value)

API name: suggest

Adds an entry to suggest.

terminatedEarly

public final BuilderT terminatedEarly(@Nullable
 Boolean value)

API name: terminated_early

tDocumentSerializer

public final BuilderT 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 abstract BuilderT self()

Specified by:

self in class WithJsonObjectBuilderBase<BuilderT extends ResponseBody.AbstractBuilder<TDocument,BuilderT>>