Package co.elastic.clients.elasticsearch.sql

Class ClearCursorRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.sql.ClearCursorRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ClearCursorRequest
extends RequestBase
implements JsonpSerializable

Clear an SQL search cursor.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<ClearCursorRequest>	_DESERIALIZER	Json deserializer for ClearCursorRequest
static final Endpoint<ClearCursorRequest,ClearCursorResponse,ErrorResponse>	_ENDPOINT	Endpoint "sql.clear_cursor".

Method Summary

Modifier and Type	Method	Description
final String	cursor()	Required - Cursor to clear.
static ClearCursorRequest	of(Function<ClearCursorRequest.Builder,ObjectBuilder<ClearCursorRequest>> fn)
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	setupClearCursorRequestDeserializer(ObjectDeserializer<ClearCursorRequest.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<ClearCursorRequest> _DESERIALIZER

Json deserializer for ClearCursorRequest

_ENDPOINT

public static final Endpoint<ClearCursorRequest,ClearCursorResponse,ErrorResponse> _ENDPOINT

Endpoint "sql.clear_cursor".

Method Details

of

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

cursor

public final String cursor()

Required - Cursor to clear.

API name: cursor

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)

setupClearCursorRequestDeserializer

protected static void setupClearCursorRequestDeserializer(ObjectDeserializer<ClearCursorRequest.Builder> op)