Package org.opensearch.client.opensearch.core.search

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

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.SearchResult.AbstractBuilder<TDocument,BuilderT>

Direct Known Subclasses:

MultiSearchItem.Builder, ScrollResponse.Builder, SearchResponse.Builder, SearchTemplateResponse.Builder

Enclosing class:

SearchResult<TDocument>

public abstract static class SearchResult.AbstractBuilder<TDocument,BuilderT extends SearchResult.AbstractBuilder<TDocument,BuilderT>>
extends ObjectBuilderBase

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
final BuilderT	aggregations(String key, Function<Aggregate.Builder,ObjectBuilder<Aggregate>> fn)	API name: aggregations
final BuilderT	aggregations(String key, Aggregate value)	API name: aggregations
final BuilderT	aggregations(Map<String,Aggregate> map)	API name: aggregations
final BuilderT	clusters(Function<ClusterStatistics.Builder,ObjectBuilder<ClusterStatistics>> fn)	API name: _clusters
final BuilderT	clusters(ClusterStatistics value)	API name: _clusters
final BuilderT	documents(List<TDocument> list)	API name: documents
final BuilderT	documents(TDocument value, TDocument... values)	API name: documents
final BuilderT	fields(String key, JsonData value)	API name: fields
final BuilderT	fields(Map<String,JsonData> map)	API name: fields
final BuilderT	hits(Function<HitsMetadata.Builder<TDocument>,ObjectBuilder<HitsMetadata<TDocument>>> fn)	Required - API name: hits
final BuilderT	hits(HitsMetadata<TDocument> value)	Required - API name: hits
final BuilderT	maxScore(Double value)	API name: max_score
final BuilderT	numReducePhases(Long value)	API name: num_reduce_phases
final BuilderT	phaseTook(Function<PhaseTook.Builder,ObjectBuilder<PhaseTook>> fn)	API name: phase_took
final BuilderT	phaseTook(PhaseTook value)	API name: phase_took
final BuilderT	pitId(String value)	API name: pit_id
final BuilderT	profile(Function<Profile.Builder,ObjectBuilder<Profile>> fn)	API name: profile
final BuilderT	profile(Profile value)	API name: profile
final BuilderT	scrollId(String value)	API name: _scroll_id
protected abstract BuilderT	self()
final BuilderT	shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	Required - API name: _shards
final BuilderT	shards(ShardStatistics value)	Required - API name: _shards
final BuilderT	suggest(String key, List<Suggest<TDocument>> value)	API name: suggest
final BuilderT	suggest(Map<String,List<Suggest<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 - API name: timed_out
final BuilderT	took(long value)	Required - API name: took

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBuilder

public AbstractBuilder()

Method Details

took

public final BuilderT took(long value)

Required - API name: took

timedOut

public final BuilderT timedOut(boolean value)

Required - API name: timed_out

shards

public final BuilderT shards(ShardStatistics value)

Required - API name: _shards

shards

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

Required - API name: _shards

hits

public final BuilderT hits(HitsMetadata<TDocument> value)

Required - API name: hits

hits

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

Required - 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

documents

public final BuilderT documents(List<TDocument> list)

API name: documents

Adds all elements of list to documents.

documents

public final BuilderT documents(TDocument value,
 TDocument... values)

API name: documents

Adds one or more values to documents.

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)

API name: _scroll_id

suggest

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

API name: suggest

Adds all entries of map to suggest.

suggest

public final BuilderT suggest(String key,
 List<Suggest<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.

phaseTook

public final BuilderT phaseTook(@Nullable
 PhaseTook value)

API name: phase_took

phaseTook

public final BuilderT phaseTook(Function<PhaseTook.Builder,ObjectBuilder<PhaseTook>> fn)

API name: phase_took

self

protected abstract BuilderT self()