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

Class RemoveAction.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.update_aliases.RemoveAction.Builder

All Implemented Interfaces:

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

Enclosing class:

RemoveAction

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

Builder for RemoveAction.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RemoveAction.Builder	alias(String value)	API name: alias
final RemoveAction.Builder	aliases(String value, String... values)	The list of aliases to remove.
final RemoveAction.Builder	aliases(List<String> list)	The list of aliases to remove.
RemoveAction	build()	Builds a RemoveAction.
RemoveAction.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RemoveAction.Builder	index(String value)	API name: index
final RemoveAction.Builder	indices(String value, String... values)	API name: indices
final RemoveAction.Builder	indices(List<String> list)	API name: indices
final RemoveAction.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 RemoveAction.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<RemoveAction.Builder,RemoveAction>

Returns:

a new builder instance.

alias

@Nonnull
public final RemoveAction.Builder alias(@Nullable
 String value)

API name: alias

aliases

@Nonnull
public final RemoveAction.Builder aliases(List<String> list)

The list of aliases to remove. Index alias names support date math.

API name: aliases

Adds all elements of list to aliases.

aliases

@Nonnull
public final RemoveAction.Builder aliases(String value,
 String... values)

The list of aliases to remove. Index alias names support date math.

API name: aliases

Adds one or more values to aliases.

index

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

API name: index

indices

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

API name: indices

Adds all elements of list to indices.

indices

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

API name: indices

Adds one or more values to indices.

mustExist

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

Whether the alias must exist to perform the action.

API name: must_exist

build

@Nonnull
public RemoveAction build()

Builds a RemoveAction.

Specified by:

build in interface ObjectBuilder<RemoveAction>

Throws:

NullPointerException - if some of the required fields are null.