Package org.opensearch.client.opensearch.snapshot

Class SnapshotShardFailure.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.SnapshotShardFailure.Builder

All Implemented Interfaces:

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

Enclosing class:

SnapshotShardFailure

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

Builder for SnapshotShardFailure.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotShardFailure	build()	Builds a SnapshotShardFailure.
SnapshotShardFailure.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SnapshotShardFailure.Builder	index(String value)	The name of the index containing the failed shard.
final SnapshotShardFailure.Builder	nodeId(String value)	The ID of the node where the shard failure occurred.
final SnapshotShardFailure.Builder	reason(String value)	The reason for the shard failure.
final SnapshotShardFailure.Builder	shardId(String value)	The ID of the failed shard.
final SnapshotShardFailure.Builder	status(String value)	The status of the failed shard.

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

Returns:

a new builder instance.

index

@Nonnull
public final SnapshotShardFailure.Builder index(@Nullable
 String value)

The name of the index containing the failed shard.

API name: index

nodeId

@Nonnull
public final SnapshotShardFailure.Builder nodeId(@Nullable
 String value)

The ID of the node where the shard failure occurred.

API name: node_id

reason

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

The reason for the shard failure.

API name: reason

shardId

@Nonnull
public final SnapshotShardFailure.Builder shardId(@Nullable
 String value)

The ID of the failed shard.

API name: shard_id

status

@Nonnull
public final SnapshotShardFailure.Builder status(@Nullable
 String value)

The status of the failed shard.

API name: status

build

@Nonnull
public SnapshotShardFailure build()

Builds a SnapshotShardFailure.

Specified by:

build in interface ObjectBuilder<SnapshotShardFailure>

Throws:

NullPointerException - if some of the required fields are null.