Package co.elastic.clients.elasticsearch.core

Class ClearScrollResponse

java.lang.Object

co.elastic.clients.elasticsearch.core.ClearScrollResponse

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ClearScrollResponse
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ClearScrollResponse>	_DESERIALIZER	Json deserializer for ClearScrollResponse

Method Summary

Modifier and Type	Method	Description
final int	numFreed()	Required - The number of scrolling search requests cleared.
static ClearScrollResponse	of(Function<ClearScrollResponse.Builder,ObjectBuilder<ClearScrollResponse>> 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	setupClearScrollResponseDeserializer(ObjectDeserializer<ClearScrollResponse.Builder> op)
final boolean	succeeded()	Required - If true, the request succeeded.
String	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<ClearScrollResponse> _DESERIALIZER

Json deserializer for ClearScrollResponse

Method Details

of

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

succeeded

public final boolean succeeded()

Required - If true, the request succeeded. This does not indicate whether any scrolling search requests were cleared.

API name: succeeded

numFreed

public final int numFreed()

Required - The number of scrolling search requests cleared.

API name: num_freed

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)

toString

public String toString()

Overrides:

toString in class Object

setupClearScrollResponseDeserializer

protected static void setupClearScrollResponseDeserializer(ObjectDeserializer<ClearScrollResponse.Builder> op)