Package org.opensearch.client.opensearch.indices.get_alias

Class IndexAliases.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.get_alias.IndexAliases.Builder

All Implemented Interfaces:

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

Enclosing class:

IndexAliases

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

Builder for IndexAliases.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexAliases.Builder	aliases(String key, Function<AliasDefinition.Builder,ObjectBuilder<AliasDefinition>> fn)	Required - The map of alias names to their definitions.
final IndexAliases.Builder	aliases(String key, AliasDefinition value)	Required - The map of alias names to their definitions.
final IndexAliases.Builder	aliases(Map<String,AliasDefinition> map)	Required - The map of alias names to their definitions.
IndexAliases	build()	Builds a IndexAliases.
IndexAliases.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.

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

Returns:

a new builder instance.

aliases

@Nonnull
public final IndexAliases.Builder aliases(Map<String,AliasDefinition> map)

Required - The map of alias names to their definitions.

API name: aliases

Adds all elements of map to aliases.

aliases

@Nonnull
public final IndexAliases.Builder aliases(String key,
 AliasDefinition value)

Required - The map of alias names to their definitions.

API name: aliases

Adds an entry to aliases.

aliases

@Nonnull
public final IndexAliases.Builder aliases(String key,
 Function<AliasDefinition.Builder,ObjectBuilder<AliasDefinition>> fn)

Required - The map of alias names to their definitions.

API name: aliases

Adds a value to aliases using a builder lambda.

build

@Nonnull
public IndexAliases build()

Builds a IndexAliases.

Specified by:

build in interface ObjectBuilder<IndexAliases>

Throws:

NullPointerException - if some of the required fields are null.