Package org.opensearch.client.opensearch.ism

Class FailedIndex.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ism.FailedIndex.Builder

All Implemented Interfaces:

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

Enclosing class:

FailedIndex

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

Builder for FailedIndex.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FailedIndex	build()	Builds a FailedIndex.
FailedIndex.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FailedIndex.Builder	indexName(String value)	The name of the failed index.
final FailedIndex.Builder	indexUuid(String value)	The UUID of the failed index.
final FailedIndex.Builder	reason(String value)	The reason for the failure.

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

Returns:

a new builder instance.

indexName

@Nonnull
public final FailedIndex.Builder indexName(@Nullable
 String value)

The name of the failed index.

API name: index_name

indexUuid

@Nonnull
public final FailedIndex.Builder indexUuid(@Nullable
 String value)

The UUID of the failed index.

API name: index_uuid

reason

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

The reason for the failure.

API name: reason

build

@Nonnull
public FailedIndex build()

Builds a FailedIndex.

Specified by:

build in interface ObjectBuilder<FailedIndex>

Throws:

NullPointerException - if some of the required fields are null.