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

Class AddAction.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.update_aliases.AddAction.Builder

All Implemented Interfaces:

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

Enclosing class:

AddAction

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

Builder for AddAction.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AddAction.Builder	alias(String value)	API name: alias
final AddAction.Builder	aliases(String value, String... values)	The list of aliases to add.
final AddAction.Builder	aliases(List<String> list)	The list of aliases to add.
AddAction	build()	Builds a AddAction.
AddAction.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AddAction.Builder	filter(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: filter
final AddAction.Builder	filter(Query value)	API name: filter
final AddAction.Builder	index(String value)	API name: index
final AddAction.Builder	indexRouting(String value)	API name: index_routing
final AddAction.Builder	indices(String value, String... values)	API name: indices
final AddAction.Builder	indices(List<String> list)	API name: indices
final AddAction.Builder	isHidden(Boolean value)	Whether the alias is hidden.
final AddAction.Builder	isWriteIndex(Boolean value)	Whether this is the write index or data stream for the alias.
final AddAction.Builder	mustExist(Boolean value)	Whether the alias must exist to perform the action.
final AddAction.Builder	routing(String value)	API name: routing
final AddAction.Builder	searchRouting(String value)	API name: search_routing

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

Returns:

a new builder instance.

alias

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

API name: alias

aliases

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

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

API name: aliases

Adds all elements of list to aliases.

aliases

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

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

API name: aliases

Adds one or more values to aliases.

filter

@Nonnull
public final AddAction.Builder filter(@Nullable
 Query value)

API name: filter

filter

@Nonnull
public final AddAction.Builder filter(Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: filter

index

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

API name: index

indexRouting

@Nonnull
public final AddAction.Builder indexRouting(@Nullable
 String value)

API name: index_routing

indices

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

API name: indices

Adds all elements of list to indices.

indices

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

API name: indices

Adds one or more values to indices.

isHidden

@Nonnull
public final AddAction.Builder isHidden(@Nullable
 Boolean value)

Whether the alias is hidden.

API name: is_hidden

isWriteIndex

@Nonnull
public final AddAction.Builder isWriteIndex(@Nullable
 Boolean value)

Whether this is the write index or data stream for the alias.

API name: is_write_index

mustExist

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

Whether the alias must exist to perform the action.

API name: must_exist

routing

@Nonnull
public final AddAction.Builder routing(@Nullable
 String value)

API name: routing

searchRouting

@Nonnull
public final AddAction.Builder searchRouting(@Nullable
 String value)

API name: search_routing

build

@Nonnull
public AddAction build()

Builds a AddAction.

Specified by:

build in interface ObjectBuilder<AddAction>

Throws:

NullPointerException - if some of the required fields are null.