Package org.opensearch.client.opensearch.snapshot

Class SnapshotShardsStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.SnapshotShardsStats.Builder

All Implemented Interfaces:

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

Enclosing class:

SnapshotShardsStats

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

Builder for SnapshotShardsStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotShardsStats	build()	Builds a SnapshotShardsStats.
SnapshotShardsStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SnapshotShardsStats.Builder	done(Long value)	The number of completed shard snapshots.
final SnapshotShardsStats.Builder	failed(Long value)	The number of failed shard snapshots.
final SnapshotShardsStats.Builder	finalizing(Long value)	The number of finalizing shard snapshots.
final SnapshotShardsStats.Builder	initializing(Long value)	The number of initializing shard snapshots.
final SnapshotShardsStats.Builder	started(Long value)	The number of started shard snapshots.
final SnapshotShardsStats.Builder	total(Long value)	The total number of shard snapshots.

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

Returns:

a new builder instance.

done

@Nonnull
public final SnapshotShardsStats.Builder done(@Nullable
 Long value)

The number of completed shard snapshots.

API name: done

failed

@Nonnull
public final SnapshotShardsStats.Builder failed(@Nullable
 Long value)

The number of failed shard snapshots.

API name: failed

finalizing

@Nonnull
public final SnapshotShardsStats.Builder finalizing(@Nullable
 Long value)

The number of finalizing shard snapshots.

API name: finalizing

initializing

@Nonnull
public final SnapshotShardsStats.Builder initializing(@Nullable
 Long value)

The number of initializing shard snapshots.

API name: initializing

started

@Nonnull
public final SnapshotShardsStats.Builder started(@Nullable
 Long value)

The number of started shard snapshots.

API name: started

total

@Nonnull
public final SnapshotShardsStats.Builder total(@Nullable
 Long value)

The total number of shard snapshots.

API name: total

build

@Nonnull
public SnapshotShardsStats build()

Builds a SnapshotShardsStats.

Specified by:

build in interface ObjectBuilder<SnapshotShardsStats>

Throws:

NullPointerException - if some of the required fields are null.