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:

ObjectBuilder<Alias>

Enclosing class:

Alias

public static class Alias.Builder
extends ObjectBuilderBase
implements ObjectBuilder<Alias>

Builder for Alias.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Alias	build()	Builds a Alias.
Alias.Builder	filter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: filter
Alias.Builder	filter(Query value)	API name: filter
Alias.Builder	indexRouting(java.lang.String value)	API name: index_routing
Alias.Builder	isHidden(java.lang.Boolean value)	API name: is_hidden
Alias.Builder	isWriteIndex(java.lang.Boolean value)	API name: is_write_index
Alias.Builder	routing(java.lang.String value)	API name: routing
Alias.Builder	searchRouting(java.lang.String value)	API name: search_routing

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

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

filter

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

API name: filter

filter

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

API name: filter

indexRouting

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

API name: index_routing

isHidden

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

API name: is_hidden

isWriteIndex

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

API name: is_write_index

routing

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

API name: routing

searchRouting

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

API name: search_routing

build

public Alias build()

Builds a Alias.

Specified by:

build in interface ObjectBuilder<Alias>

Throws:

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