Package org.opensearch.client.opensearch.core

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 Classes

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

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

Method Summary

Modifier and Type	Method	Description
static ClearScrollRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static ClearScrollRequest	of(Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)
final List<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)
ClearScrollRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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(Function<ClearScrollRequest.Builder,ObjectBuilder<ClearScrollRequest>> fn)

scrollId

@Nonnull
public final List<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)

toBuilder

@Nonnull
public ClearScrollRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ClearScrollRequest.Builder,ClearScrollRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static ClearScrollRequest.Builder builder()

setupClearScrollRequestDeserializer

protected static void setupClearScrollRequestDeserializer(ObjectDeserializer<ClearScrollRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object