Package org.opensearch.client.opensearch.indices.update_aliases

Class RemoveIndexAction.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.update_aliases.RemoveIndexAction.Builder

All Implemented Interfaces:

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

Enclosing class:

RemoveIndexAction

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

Builder for RemoveIndexAction.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RemoveIndexAction	build()	Builds a RemoveIndexAction.
RemoveIndexAction.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RemoveIndexAction.Builder	index(String value)	API name: index
final RemoveIndexAction.Builder	indices(String value, String... values)	API name: indices
final RemoveIndexAction.Builder	indices(List<String> list)	API name: indices
final RemoveIndexAction.Builder	mustExist(Boolean value)	Whether the alias must exist to perform the action.

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

Returns:

a new builder instance.

index

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

API name: index

indices

@Nonnull
public final RemoveIndexAction.Builder indices(List<String> list)

API name: indices

Adds all elements of list to indices.

indices

@Nonnull
public final RemoveIndexAction.Builder indices(String value,
 String... values)

API name: indices

Adds one or more values to indices.

mustExist

@Nonnull
public final RemoveIndexAction.Builder mustExist(@Nullable
 Boolean value)

Whether the alias must exist to perform the action.

API name: must_exist

build

@Nonnull
public RemoveIndexAction build()

Builds a RemoveIndexAction.

Specified by:

build in interface ObjectBuilder<RemoveIndexAction>

Throws:

NullPointerException - if some of the required fields are null.