Package org.opensearch.client.opensearch._types

Class SlicedScroll

java.lang.Object

org.opensearch.client.opensearch._types.SlicedScroll

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<SlicedScroll.Builder,SlicedScroll>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class SlicedScroll
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<SlicedScroll.Builder,SlicedScroll>

The configuration for a sliced scroll request.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static SlicedScroll.Builder	builder()
boolean	equals(Object o)
final String	field()	The field to slice on.
int	hashCode()
final int	id()	Required - The ID of the slice.
final int	max()	Required - The maximum number of slices.
static SlicedScroll	of(Function<SlicedScroll.Builder,ObjectBuilder<SlicedScroll>> 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	setupSlicedScrollDeserializer(ObjectDeserializer<SlicedScroll.Builder> op)
SlicedScroll.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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<SlicedScroll> _DESERIALIZER

Json deserializer for SlicedScroll

Method Details

of

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

field

@Nullable
public final String field()

The field to slice on.

API name: field

id

public final int id()

Required - The ID of the slice.

API name: id

max

public final int max()

Required - The maximum number of slices.

API name: max

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 SlicedScroll.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<SlicedScroll.Builder,SlicedScroll>

Returns:

a new builder instance.

builder

@Nonnull
public static SlicedScroll.Builder builder()

setupSlicedScrollDeserializer

protected static void setupSlicedScrollDeserializer(ObjectDeserializer<SlicedScroll.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object