Package org.opensearch.client.opensearch.snapshot

Class SnapshotShardsStatus.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.SnapshotShardsStatus.Builder

All Implemented Interfaces:

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

Enclosing class:

SnapshotShardsStatus

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

Builder for SnapshotShardsStatus.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotShardsStatus	build()	Builds a SnapshotShardsStatus.
SnapshotShardsStatus.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SnapshotShardsStatus.Builder	node(String value)	The ID of the node containing the shard.
final SnapshotShardsStatus.Builder	reason(String value)	The reason for the current shard status.
final SnapshotShardsStatus.Builder	stage(SnapshotShardsStatsStage value)	Required - The current stage of the shard snapshot.
final SnapshotShardsStatus.Builder	stats(Function<SnapshotShardsStatsSummary.Builder,ObjectBuilder<SnapshotShardsStatsSummary>> fn)	Required - The statistical summary of the shard snapshot.
final SnapshotShardsStatus.Builder	stats(SnapshotShardsStatsSummary value)	Required - The statistical summary of the shard snapshot.

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

Returns:

a new builder instance.

node

@Nonnull
public final SnapshotShardsStatus.Builder node(@Nullable
 String value)

The ID of the node containing the shard.

API name: node

reason

@Nonnull
public final SnapshotShardsStatus.Builder reason(@Nullable
 String value)

The reason for the current shard status.

API name: reason

stage

@Nonnull
public final SnapshotShardsStatus.Builder stage(SnapshotShardsStatsStage value)

Required - The current stage of the shard snapshot.

API name: stage

stats

@Nonnull
public final SnapshotShardsStatus.Builder stats(SnapshotShardsStatsSummary value)

Required - The statistical summary of the shard snapshot.

API name: stats

stats

@Nonnull
public final SnapshotShardsStatus.Builder stats(Function<SnapshotShardsStatsSummary.Builder,ObjectBuilder<SnapshotShardsStatsSummary>> fn)

Required - The statistical summary of the shard snapshot.

API name: stats

build

@Nonnull
public SnapshotShardsStatus build()

Builds a SnapshotShardsStatus.

Specified by:

build in interface ObjectBuilder<SnapshotShardsStatus>

Throws:

NullPointerException - if some of the required fields are null.