Class ClearScrollRequest
java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.core.ClearScrollRequest
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,ToCopyableBuilder<ClearScrollRequest.Builder,ClearScrollRequest>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class ClearScrollRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<ClearScrollRequest.Builder,ClearScrollRequest>
Explicitly clears the search context for a scroll.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<ClearScrollRequest> Json deserializer forClearScrollRequeststatic final Endpoint<ClearScrollRequest, ClearScrollResponse, ErrorResponse> Endpoint "clear_scroll". -
Method Summary
Modifier and TypeMethodDescriptionstatic ClearScrollRequest.Builderbuilder()booleaninthashCode()static ClearScrollRequestscrollId()API name:scroll_idvoidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
applyQueryParameters, errorTrace, humanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forClearScrollRequest -
_ENDPOINT
Endpoint "clear_scroll".
-
-
Method Details
-
of
public static ClearScrollRequest of(Function<ClearScrollRequest.Builder, ObjectBuilder<ClearScrollRequest>> fn) -
scrollId
API name:scroll_id -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ClearScrollRequest.Builder,ClearScrollRequest> - Returns:
- a new builder instance.
-
builder
-
setupClearScrollRequestDeserializer
protected static void setupClearScrollRequestDeserializer(ObjectDeserializer<ClearScrollRequest.Builder> op) -
hashCode
public int hashCode() -
equals
-