Package org.opensearch.client.opensearch.core

Class SearchResponse<TDocument>

java.lang.Object

org.opensearch.client.opensearch.core.SearchResponse<TDocument>

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

MultiSearchItem, ScrollResponse

@JsonpDeserializable
public class SearchResponse<TDocument>
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SearchResponse.AbstractBuilder<TDocument,BuilderT extends SearchResponse.AbstractBuilder<TDocument,BuilderT>>
static class	SearchResponse.Builder<TDocument>	Builder for SearchResponse.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<SearchResponse<java.lang.Object>>	_DESERIALIZER	Json deserializer for SearchResponse based on named deserializers provided by the calling JsonMapper.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SearchResponse(SearchResponse.AbstractBuilder<TDocument,?> builder)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,Aggregate>	aggregations()	API name: aggregations
ClusterStatistics	clusters()	API name: _clusters
static <TDocument> JsonpDeserializer<SearchResponse<TDocument>>	createSearchResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a JSON deserializer for SearchResponse
java.util.List<TDocument>	documents()	API name: documents
java.util.Map<java.lang.String,JsonData>	fields()	API name: fields
HitsMetadata<TDocument>	hits()	Required - API name: hits
java.lang.Double	maxScore()	API name: max_score
java.lang.Long	numReducePhases()	API name: num_reduce_phases
java.lang.String	pitId()	API name: pit_id
Profile	profile()	API name: profile
java.lang.String	scrollId()	API name: _scroll_id
static <TDocument> SearchResponse<TDocument>	searchResponseOf(java.util.function.Function<SearchResponse.Builder<TDocument>,ObjectBuilder<SearchResponse<TDocument>>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <TDocument,BuilderT extends SearchResponse.AbstractBuilder<TDocument,BuilderT>> void	setupSearchResponseDeserializer(ObjectDeserializer<BuilderT> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
ShardStatistics	shards()	Required - API name: _shards
java.util.Map<java.lang.String,java.util.List<Suggestion<TDocument>>>	suggest()	API name: suggest
java.lang.Boolean	terminatedEarly()	API name: terminated_early
boolean	timedOut()	Required - API name: timed_out
long	took()	Required - API name: took

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<SearchResponse<java.lang.Object>> _DESERIALIZER

Json deserializer for SearchResponse based on named deserializers provided by the calling JsonMapper.

Constructor Detail

SearchResponse

protected SearchResponse(SearchResponse.AbstractBuilder<TDocument,?> builder)

Method Detail

searchResponseOf

public static <TDocument> SearchResponse<TDocument> searchResponseOf(java.util.function.Function<SearchResponse.Builder<TDocument>,ObjectBuilder<SearchResponse<TDocument>>> fn)

took

public final long took()

Required - API name: took

timedOut

public final boolean timedOut()

Required - API name: timed_out

shards

public final ShardStatistics shards()

Required - API name: _shards

hits

public final HitsMetadata<TDocument> hits()

Required - API name: hits

aggregations

public final java.util.Map<java.lang.String,Aggregate> aggregations()

API name: aggregations

clusters

@Nullable
public final ClusterStatistics clusters()

API name: _clusters

documents

public final java.util.List<TDocument> documents()

API name: documents

fields

public final java.util.Map<java.lang.String,JsonData> fields()

API name: fields

maxScore

@Nullable
public final java.lang.Double maxScore()

API name: max_score

numReducePhases

@Nullable
public final java.lang.Long numReducePhases()

API name: num_reduce_phases

profile

@Nullable
public final Profile profile()

API name: profile

pitId

@Nullable
public final java.lang.String pitId()

API name: pit_id

scrollId

@Nullable
public final java.lang.String scrollId()

API name: _scroll_id

suggest

public final java.util.Map<java.lang.String,java.util.List<Suggestion<TDocument>>> suggest()

API name: suggest

terminatedEarly

@Nullable
public final java.lang.Boolean terminatedEarly()

API name: terminated_early

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

createSearchResponseDeserializer

public static <TDocument> JsonpDeserializer<SearchResponse<TDocument>> createSearchResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create a JSON deserializer for SearchResponse

setupSearchResponseDeserializer

protected static <TDocument,BuilderT extends SearchResponse.AbstractBuilder<TDocument,BuilderT>> void setupSearchResponseDeserializer(ObjectDeserializer<BuilderT> op,
                                                                                                                                                  JsonpDeserializer<TDocument> tDocumentDeserializer)