Package org.opensearch.client.opensearch._global

Class SearchResponse<TDocument>

java.lang.Object

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

All Implemented Interfaces:

ToJsonp

public class SearchResponse<TDocument>
extends java.lang.Object
implements ToJsonp

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.

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,jakarta.json.JsonValue>	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,jakarta.json.JsonValue>	fields()	API name: fields
HitsMetadata<TDocument>	hits()	API name: hits
java.lang.Number	maxScore()	API name: max_score
java.lang.Number	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
protected static <TDocument, BuilderT extends SearchResponse.AbstractBuilder<TDocument, BuilderT>> void	setupSearchResponseDeserializer(DelegatingDeserializer<BuilderT> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
ShardStatistics	shards()	API name: _shards
java.util.Map<java.lang.String,java.util.List<Suggest<TDocument>>>	suggest()	API name: suggest
java.lang.Boolean	terminatedEarly()	API name: terminated_early
java.lang.Boolean	timedOut()	API name: timed_out
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.lang.Number	took()	API name: took

Methods inherited from class java.lang.Object

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

Constructor Details

SearchResponse

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

Method Details

took

public java.lang.Number took()

API name: took

timedOut

public java.lang.Boolean timedOut()

API name: timed_out

shards

public ShardStatistics shards()

API name: _shards

hits

public HitsMetadata<TDocument> hits()

API name: hits

aggregations

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

API name: aggregations

clusters

@Nullable public ClusterStatistics clusters()

API name: _clusters

documents

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

API name: documents

fields

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

API name: fields

maxScore

@Nullable public java.lang.Number maxScore()

API name: max_score

numReducePhases

@Nullable public java.lang.Number numReducePhases()

API name: num_reduce_phases

profile

@Nullable public Profile profile()

API name: profile

pitId

@Nullable public java.lang.String pitId()

API name: pit_id

scrollId

@Nullable public java.lang.String scrollId()

API name: _scroll_id

suggest

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

API name: suggest

terminatedEarly

@Nullable public java.lang.Boolean terminatedEarly()

API name: terminated_early

toJsonp

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

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

protected void toJsonpInternal(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(DelegatingDeserializer<BuilderT> op, JsonpDeserializer<TDocument> tDocumentDeserializer)