Package org.opensearch.client.opensearch.indices

Class Alias.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.Alias.Builder

All Implemented Interfaces:

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

Enclosing class:

Alias

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

Builder for Alias.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Alias	build()	Builds a Alias.
Alias.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Alias.Builder	filter(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: filter
final Alias.Builder	filter(Query value)	API name: filter
final Alias.Builder	indexRouting(String value)	API name: index_routing
final Alias.Builder	isHidden(Boolean value)	When true, the alias is hidden.
final Alias.Builder	isWriteIndex(Boolean value)	When true, the index is the write index for the alias.
final Alias.Builder	routing(String value)	API name: routing
final Alias.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 Alias.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<Alias.Builder,Alias>

Returns:

a new builder instance.

filter

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

API name: filter

filter

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

API name: filter

indexRouting

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

API name: index_routing

isHidden

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

When 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 Alias.Builder isWriteIndex(@Nullable
 Boolean value)

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

API name: is_write_index

routing

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

API name: routing

searchRouting

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

API name: search_routing

build

@Nonnull
public Alias build()

Builds a Alias.

Specified by:

build in interface ObjectBuilder<Alias>

Throws:

NullPointerException - if some of the required fields are null.