Class ScrollRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.ScrollRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class ScrollRequest extends RequestBase implements JsonpSerializable
Allows to retrieve a large numbers of results from a single search request.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ScrollRequest.Builder
Builder forScrollRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<ScrollRequest>
_DESERIALIZER
Json deserializer forScrollRequest
static 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(java.util.function.Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn)
Time
scroll()
Period to retain the search context for scrolling.java.lang.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)
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forScrollRequest
-
_ENDPOINT
Endpoint "scroll
".
-
-
Method Details
-
of
public static ScrollRequest of(java.util.function.Function<ScrollRequest.Builder,ObjectBuilder<ScrollRequest>> fn) -
scroll
Period to retain the search context for scrolling.API name:
scroll
-
scrollId
public final java.lang.String scrollId()Required - Scroll ID of the search.API name:
scroll_id
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupScrollRequestDeserializer
-
createScrollEndpoint
public static <TDocument> Endpoint<ScrollRequest,ScrollResponse<TDocument>,ErrorResponse> createScrollEndpoint(JsonpDeserializer<TDocument> tDocumentDeserializer)Create an "scroll
" endpoint.
-