Package org.opensearch.client.opensearch._global

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

java.lang.Object

org.opensearch.client.opensearch._global.SearchResponse.AbstractBuilder<TDocument,BuilderT>

Direct Known Subclasses:

SearchResponse.Builder

Enclosing class:

SearchResponse<TDocument>

protected abstract static class SearchResponse.AbstractBuilder<TDocument,BuilderT extends SearchResponse.AbstractBuilder<TDocument,BuilderT>>
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
BuilderT	addDocuments(TDocument value)	Add a value to documents(List), creating the list if needed.
BuilderT	aggregations(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: aggregations
BuilderT	clusters(java.util.function.Function<ClusterStatistics.Builder,ObjectBuilder<ClusterStatistics>> fn)	API name: _clusters
BuilderT	clusters(ClusterStatistics value)	API name: _clusters
BuilderT	documents(java.util.List<TDocument> value)	API name: documents
BuilderT	documents(TDocument... value)	API name: documents
BuilderT	fields(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: fields
BuilderT	hits(java.util.function.Function<HitsMetadata.Builder<TDocument>,ObjectBuilder<HitsMetadata<TDocument>>> fn)	API name: hits
BuilderT	hits(HitsMetadata<TDocument> value)	API name: hits
BuilderT	maxScore(java.lang.Number value)	API name: max_score
BuilderT	numReducePhases(java.lang.Number value)	API name: num_reduce_phases
BuilderT	pitId(java.lang.String value)	API name: pit_id
BuilderT	profile(java.util.function.Function<Profile.Builder,ObjectBuilder<Profile>> fn)	API name: profile
BuilderT	profile(Profile value)	API name: profile
BuilderT	putAggregations(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to aggregations(Map), creating the map if needed.
BuilderT	putFields(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to fields(Map), creating the map if needed.
BuilderT	putSuggest(java.lang.String key, java.util.List<Suggest<TDocument>> value)	Add a key/value to suggest(Map), creating the map if needed.
BuilderT	scrollId(java.lang.String value)	API name: _scroll_id
protected abstract BuilderT	self()
BuilderT	shards(java.util.function.Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	API name: _shards
BuilderT	shards(ShardStatistics value)	API name: _shards
BuilderT	suggest(java.util.Map<java.lang.String,java.util.List<Suggest<TDocument>>> value)	API name: suggest
BuilderT	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
BuilderT	terminatedEarly(java.lang.Boolean value)	API name: terminated_early
BuilderT	timedOut(java.lang.Boolean value)	API name: timed_out
BuilderT	took(java.lang.Number value)	API name: took

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

took

public BuilderT took(java.lang.Number value)

API name: took

timedOut

public BuilderT timedOut(java.lang.Boolean value)

API name: timed_out

shards

public BuilderT shards(ShardStatistics value)

API name: _shards

shards

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

API name: _shards

hits

public BuilderT hits(HitsMetadata<TDocument> value)

API name: hits

hits

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

API name: hits

aggregations

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

API name: aggregations

putAggregations

public BuilderT putAggregations(java.lang.String key, jakarta.json.JsonValue value)

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

clusters

public BuilderT clusters(@Nullable ClusterStatistics value)

API name: _clusters

clusters

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

API name: _clusters

documents

public BuilderT documents(@Nullable java.util.List<TDocument> value)

API name: documents

documents

public BuilderT documents(TDocument... value)

API name: documents

addDocuments

public BuilderT addDocuments(TDocument value)

Add a value to documents(List), creating the list if needed.

fields

public BuilderT fields(@Nullable java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

API name: fields

putFields

public BuilderT putFields(java.lang.String key, jakarta.json.JsonValue value)

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

maxScore

public BuilderT maxScore(@Nullable java.lang.Number value)

API name: max_score

numReducePhases

public BuilderT numReducePhases(@Nullable java.lang.Number value)

API name: num_reduce_phases

profile

public BuilderT profile(@Nullable Profile value)

API name: profile

profile

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

API name: profile

pitId

public BuilderT pitId(@Nullable java.lang.String value)

API name: pit_id

scrollId

public BuilderT scrollId(@Nullable java.lang.String value)

API name: _scroll_id

suggest

public BuilderT suggest(@Nullable java.util.Map<java.lang.String,java.util.List<Suggest<TDocument>>> value)

API name: suggest

putSuggest

public BuilderT putSuggest(java.lang.String key, java.util.List<Suggest<TDocument>> value)

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

terminatedEarly

public BuilderT terminatedEarly(@Nullable java.lang.Boolean value)

API name: terminated_early

tDocumentSerializer

public 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()