Package org.opensearch.client.opensearch.indices

Class AliasDefinition.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.AliasDefinition.Builder

All Implemented Interfaces:

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

Enclosing class:

AliasDefinition

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

Builder for AliasDefinition.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AliasDefinition	build()	Builds a AliasDefinition.
AliasDefinition.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
AliasDefinition.Builder	filter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: filter
AliasDefinition.Builder	filter(Query value)	API name: filter
AliasDefinition.Builder	indexRouting(java.lang.String value)	Value used to route indexing operations to a specific shard.
AliasDefinition.Builder	isHidden(java.lang.Boolean value)	If true, the alias is hidden.
AliasDefinition.Builder	isWriteIndex(java.lang.Boolean value)	If true, the index is the write index for the alias.
AliasDefinition.Builder	routing(java.lang.String value)	Value used to route indexing and search operations to a specific shard.
AliasDefinition.Builder	searchRouting(java.lang.String value)	Value used to route search operations to a specific shard.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _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 Detail

Builder

public Builder()

Method Detail

copy

@Nonnull
public AliasDefinition.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<AliasDefinition.Builder,AliasDefinition>

Returns:

a new builder instance.

filter

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

API name: filter

filter

@Nonnull
public final AliasDefinition.Builder filter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: filter

indexRouting

@Nonnull
public final AliasDefinition.Builder indexRouting(@Nullable
                                                  java.lang.String value)

Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations.

API name: index_routing

isHidden

@Nonnull
public final AliasDefinition.Builder isHidden(@Nullable
                                              java.lang.Boolean value)

If true, the alias is hidden. All indexes for the alias must have the same is_hidden value.

API name: is_hidden

isWriteIndex

@Nonnull
public final AliasDefinition.Builder isWriteIndex(@Nullable
                                                  java.lang.Boolean value)

If true, the index is the write index for the alias.

API name: is_write_index

routing

@Nonnull
public final AliasDefinition.Builder routing(@Nullable
                                             java.lang.String value)

Value used to route indexing and search operations to a specific shard.

API name: routing

searchRouting

@Nonnull
public final AliasDefinition.Builder searchRouting(@Nullable
                                                   java.lang.String value)

Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.

API name: search_routing

build

@Nonnull
public AliasDefinition build()

Builds a AliasDefinition.

Specified by:

build in interface ObjectBuilder<AliasDefinition>

Throws:

java.lang.NullPointerException - if some of the required fields are null.