Package org.opensearch.client.opensearch.ingestion

Class ShardIngestionState

java.lang.Object

org.opensearch.client.opensearch.ingestion.ShardIngestionState

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final String	batchStartPointer()	Indicates the shard pointer from where the poller will resume during shard recovery.
static ShardIngestionState.Builder	builder()
boolean	equals(Object o)
final ErrorPolicy	errorPolicy()	Indicates the policy used to handle failed messages.
int	hashCode()
static ShardIngestionState	of(Function<ShardIngestionState.Builder,ObjectBuilder<ShardIngestionState>> fn)
final Boolean	pollerPaused()	Indicates if the poller has been paused.
final PollerState	pollerState()	Indicates the current state of the poller.
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	setupShardIngestionStateDeserializer(ObjectDeserializer<ShardIngestionState.Builder> op)
final Integer	shard()	The shard number.
ShardIngestionState.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Boolean	writeBlockEnabled()	Indicates if a write block has been created.

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

Json deserializer for ShardIngestionState

Method Details

of

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

batchStartPointer

@Nullable
public final String batchStartPointer()

Indicates the shard pointer from where the poller will resume during shard recovery.

API name: batch_start_pointer

errorPolicy

@Nullable
public final ErrorPolicy errorPolicy()

Indicates the policy used to handle failed messages.

API name: error_policy

pollerPaused

@Nullable
public final Boolean pollerPaused()

Indicates if the poller has been paused.

API name: poller_paused

pollerState

@Nullable
public final PollerState pollerState()

Indicates the current state of the poller.

API name: poller_state

shard

@Nullable
public final Integer shard()

The shard number.

API name: shard

writeBlockEnabled

@Nullable
public final Boolean writeBlockEnabled()

Indicates if a write block has been created.

API name: write_block_enabled

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

Returns:

a new builder instance.

builder

@Nonnull
public static ShardIngestionState.Builder builder()

setupShardIngestionStateDeserializer

protected static void setupShardIngestionStateDeserializer(ObjectDeserializer<ShardIngestionState.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object