Package org.opensearch.client.opensearch.ingestion

Class ShardIngestionState.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingestion.ShardIngestionState.Builder

All Implemented Interfaces:

CopyableBuilder<ShardIngestionState.Builder,ShardIngestionState>, MutableBuilder<ShardIngestionState.Builder,ShardIngestionState>, ObjectBuilder<ShardIngestionState>

Enclosing class:

ShardIngestionState

public static class ShardIngestionState.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ShardIngestionState.Builder,ShardIngestionState>

Builder for ShardIngestionState.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ShardIngestionState.Builder	batchStartPointer(String value)	Indicates the shard pointer from where the poller will resume during shard recovery.
ShardIngestionState	build()	Builds a ShardIngestionState.
ShardIngestionState.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardIngestionState.Builder	errorPolicy(ErrorPolicy value)	Indicates the policy used to handle failed messages.
final ShardIngestionState.Builder	pollerPaused(Boolean value)	Indicates if the poller has been paused.
final ShardIngestionState.Builder	pollerState(PollerState value)	Indicates the current state of the poller.
final ShardIngestionState.Builder	shard(Integer value)	The shard number.
final ShardIngestionState.Builder	writeBlockEnabled(Boolean value)	Indicates if a write block has been created.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ShardIngestionState.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ShardIngestionState.Builder,ShardIngestionState>

Returns:

a new builder instance.

batchStartPointer

@Nonnull
public final ShardIngestionState.Builder batchStartPointer(@Nullable
 String value)

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

API name: batch_start_pointer

errorPolicy

@Nonnull
public final ShardIngestionState.Builder errorPolicy(@Nullable
 ErrorPolicy value)

Indicates the policy used to handle failed messages.

API name: error_policy

pollerPaused

@Nonnull
public final ShardIngestionState.Builder pollerPaused(@Nullable
 Boolean value)

Indicates if the poller has been paused.

API name: poller_paused

pollerState

@Nonnull
public final ShardIngestionState.Builder pollerState(@Nullable
 PollerState value)

Indicates the current state of the poller.

API name: poller_state

shard

@Nonnull
public final ShardIngestionState.Builder shard(@Nullable
 Integer value)

The shard number.

API name: shard

writeBlockEnabled

@Nonnull
public final ShardIngestionState.Builder writeBlockEnabled(@Nullable
 Boolean value)

Indicates if a write block has been created.

API name: write_block_enabled

build

@Nonnull
public ShardIngestionState build()

Builds a ShardIngestionState.

Specified by:

build in interface ObjectBuilder<ShardIngestionState>

Throws:

NullPointerException - if some of the required fields are null.