Package org.opensearch.client.opensearch.indices.stats

Class ShardSequenceNumber.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.stats.ShardSequenceNumber.Builder

All Implemented Interfaces:

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

Enclosing class:

ShardSequenceNumber

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

Builder for ShardSequenceNumber.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardSequenceNumber	build()	Builds a ShardSequenceNumber.
ShardSequenceNumber.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardSequenceNumber.Builder	globalCheckpoint(long value)	Required - The global checkpoint for the shard.
final ShardSequenceNumber.Builder	localCheckpoint(long value)	Required - The local checkpoint for the shard.
final ShardSequenceNumber.Builder	maxSeqNo(long value)	Required - API name: max_seq_no

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

Returns:

a new builder instance.

globalCheckpoint

@Nonnull
public final ShardSequenceNumber.Builder globalCheckpoint(long value)

Required - The global checkpoint for the shard.

API name: global_checkpoint

localCheckpoint

@Nonnull
public final ShardSequenceNumber.Builder localCheckpoint(long value)

Required - The local checkpoint for the shard.

API name: local_checkpoint

maxSeqNo

@Nonnull
public final ShardSequenceNumber.Builder maxSeqNo(long value)

Required - API name: max_seq_no

build

@Nonnull
public ShardSequenceNumber build()

Builds a ShardSequenceNumber.

Specified by:

build in interface ObjectBuilder<ShardSequenceNumber>

Throws:

NullPointerException - if some of the required fields are null.