Package org.opensearch.client.opensearch.core

Class ScrollRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.ScrollRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class ScrollRequest
extends RequestBase
implements PlainJsonSerializable

Allows to retrieve a large numbers of results from a single search request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScrollRequest.Builder	Builder for ScrollRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ScrollRequest>	_DESERIALIZER	Json deserializer for ScrollRequest
static final SimpleEndpoint<ScrollRequest,?>	_ENDPOINT	Endpoint "scroll".

Method Summary

Modifier and Type	Method	Description
static <TDocument> Endpoint<ScrollRequest,ScrollResponse<TDocument>,ErrorResponse>	createScrollEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create an "scroll" endpoint.
static ScrollRequest	of(Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn)
final Time	scroll()	Period to retain the search context for scrolling.
final String	scrollId()	Required - Scroll ID of the search.
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 void	setupScrollRequestDeserializer(ObjectDeserializer<ScrollRequest.Builder> op)
ScrollRequest.Builder	toBuilder()

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

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<ScrollRequest> _DESERIALIZER

Json deserializer for ScrollRequest

_ENDPOINT

public static final SimpleEndpoint<ScrollRequest,?> _ENDPOINT

Endpoint "scroll".

Method Details

of

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

scroll

@Nullable
public final Time scroll()

Period to retain the search context for scrolling.

API name: scroll

scrollId

public final String scrollId()

Required - Scroll ID of the search.

API name: scroll_id

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)

toBuilder

public ScrollRequest.Builder toBuilder()

setupScrollRequestDeserializer

protected static void setupScrollRequestDeserializer(ObjectDeserializer<ScrollRequest.Builder> op)

createScrollEndpoint

public static <TDocument>
Endpoint<ScrollRequest,ScrollResponse<TDocument>,ErrorResponse> createScrollEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create an "scroll" endpoint.