Package org.opensearch.client.opensearch.core

Class ScrollResponse<TDocument>

java.lang.Object

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

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

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

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

Nested Class Summary

Nested Classes

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

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<ScrollResponse<Object>>	_DESERIALIZER	Json deserializer for ScrollResponse based on named deserializers provided by the calling JsonMapper.

Method Summary

Modifier and Type	Method	Description
static <TDocument> JsonpDeserializer<ScrollResponse<TDocument>>	createScrollResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a JSON deserializer for ScrollResponse
static <TDocument> ScrollResponse<TDocument>	of(Function<ScrollResponse.Builder<TDocument>,ObjectBuilder<ScrollResponse<TDocument>>> fn)
protected static <TDocument> void	setupScrollResponseDeserializer(ObjectDeserializer<ScrollResponse.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)

Methods inherited from class org.opensearch.client.opensearch.core.SearchResponse

createSearchResponseDeserializer, searchResponseOf, setupSearchResponseDeserializer

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<ScrollResponse<Object>> _DESERIALIZER

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

Method Details

of

public static <TDocument> ScrollResponse<TDocument> of(Function<ScrollResponse.Builder<TDocument>,ObjectBuilder<ScrollResponse<TDocument>>> fn)

createScrollResponseDeserializer

public static <TDocument>
JsonpDeserializer<ScrollResponse<TDocument>> createScrollResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create a JSON deserializer for ScrollResponse

setupScrollResponseDeserializer

protected static <TDocument> void setupScrollResponseDeserializer(ObjectDeserializer<ScrollResponse.Builder<TDocument>> op,
 JsonpDeserializer<TDocument> tDocumentDeserializer)