ClearScrollRequest (java-client 8.5.0 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.ClearScrollRequest

All Implemented Interfaces:: JsonpSerializable

@JsonpDeserializable
public class ClearScrollRequest
extends RequestBase
implements JsonpSerializable

Explicitly clears the search context for a scroll.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class ClearScrollRequest.Builder
Builder for ClearScrollRequest.

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<ClearScrollRequest>`	`_DESERIALIZER`	Json deserializer for `ClearScrollRequest`
`static Endpoint<ClearScrollRequest,ClearScrollResponse,ErrorResponse>`	`_ENDPOINT`	Endpoint "`clear_scroll`".

Method Summary

Modifier and Type	Method	Description
`static ClearScrollRequest`	`of(java.util.function.Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)`
`java.util.List<java.lang.String>`	`scrollId()`	API name: `scroll_id`
`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`	`setupClearScrollRequestDeserializer(ObjectDeserializer<ClearScrollRequest.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
  
  public static final JsonpDeserializer<ClearScrollRequest> _DESERIALIZER
  
  Json deserializer for ClearScrollRequest
- _ENDPOINT
  
  public static final Endpoint<ClearScrollRequest,ClearScrollResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "clear_scroll".
Method Details
- of
  
  public static ClearScrollRequest of(java.util.function.Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)
- scrollId
  
  public final java.util.List<java.lang.String> scrollId()
  
  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)
- setupClearScrollRequestDeserializer
  
  protected static void setupClearScrollRequestDeserializer(ObjectDeserializer<ClearScrollRequest.Builder> op)