Package org.opensearch.client.opensearch.core

Class SearchResponse<TDocument>

java.lang.Object

org.opensearch.client.opensearch.core.search.SearchResult<TDocument>

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

Direct Known Subclasses:

MultiSearchItem, ScrollResponse

@JsonpDeserializable
public class SearchResponse<TDocument>
extends SearchResult<TDocument>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchResponse.Builder<TDocument>	Builder for SearchResponse.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.core.search.SearchResult

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static <TDocument> JsonpDeserializer<SearchResponse<TDocument>>	createSearchResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a JSON deserializer for SearchResponse
static <TDocument> SearchResponse<TDocument>	searchResponseOf(Function<SearchResponse.Builder<TDocument>,ObjectBuilder<SearchResponse<TDocument>>> fn)
protected static <TDocument, BuilderT extends SearchResult.AbstractBuilder<TDocument, BuilderT>> void	setupSearchResponseDeserializer(ObjectDeserializer<BuilderT> op, JsonpDeserializer<TDocument> tDocumentDeserializer)

Methods inherited from class org.opensearch.client.opensearch.core.search.SearchResult

aggregations, clusters, documents, fields, hits, maxScore, numReducePhases, phaseTook, pitId, profile, scrollId, serialize, serializeInternal, setupSearchResultDeserializer, shards, suggest, terminatedEarly, timedOut, took

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SearchResponse<Object>> _DESERIALIZER

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

Constructor Details

SearchResponse

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

Method Details

searchResponseOf

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

createSearchResponseDeserializer

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

Create a JSON deserializer for SearchResponse

setupSearchResponseDeserializer

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