Package org.opensearch.client.opensearch.indices

Class PutAliasRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.PutAliasRequest.Builder

All Implemented Interfaces:

ObjectBuilder<PutAliasRequest>

Enclosing class:

PutAliasRequest

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

Builder for PutAliasRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutAliasRequest	build()	Builds a PutAliasRequest.
PutAliasRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to cluster-manager
PutAliasRequest.Builder	clusterManagerTimeout(Time value)	Specify timeout for connection to cluster-manager
PutAliasRequest.Builder	filter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: filter
PutAliasRequest.Builder	filter(Query value)	API name: filter
PutAliasRequest.Builder	index(java.lang.String value, java.lang.String... values)	Required - A comma-separated list of index names the alias should point to (supports wildcards); use _all to perform the operation on all indices.
PutAliasRequest.Builder	index(java.util.List<java.lang.String> list)	Required - A comma-separated list of index names the alias should point to (supports wildcards); use _all to perform the operation on all indices.
PutAliasRequest.Builder	indexRouting(java.lang.String value)	API name: index_routing
PutAliasRequest.Builder	isWriteIndex(java.lang.Boolean value)	API name: is_write_index
PutAliasRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
PutAliasRequest.Builder	masterTimeout(Time value)	Deprecated.
PutAliasRequest.Builder	name(java.lang.String value)	Required - The name of the alias to be created or updated
PutAliasRequest.Builder	routing(java.lang.String value)	API name: routing
PutAliasRequest.Builder	searchRouting(java.lang.String value)	API name: search_routing
PutAliasRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit timestamp for the document
PutAliasRequest.Builder	timeout(Time value)	Explicit timestamp for the document

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 PutAliasRequest.Builder filter(@Nullable
                                            Query value)

API name: filter

filter

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

API name: filter

index

public final PutAliasRequest.Builder index(java.util.List<java.lang.String> list)

Required - A comma-separated list of index names the alias should point to (supports wildcards); use _all to perform the operation on all indices.

API name: index

Adds all elements of list to index.

index

public final PutAliasRequest.Builder index(java.lang.String value,
                                           java.lang.String... values)

Required - A comma-separated list of index names the alias should point to (supports wildcards); use _all to perform the operation on all indices.

API name: index

Adds one or more values to index.

indexRouting

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

API name: index_routing

isWriteIndex

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

API name: is_write_index

masterTimeout

@Deprecated
public final PutAliasRequest.Builder masterTimeout(@Nullable
                                                   Time value)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

masterTimeout

@Deprecated
public final PutAliasRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

public final PutAliasRequest.Builder clusterManagerTimeout(@Nullable
                                                           Time value)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

clusterManagerTimeout

public final PutAliasRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

name

public final PutAliasRequest.Builder name(java.lang.String value)

Required - The name of the alias to be created or updated

API name: name

routing

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

API name: routing

searchRouting

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

API name: search_routing

timeout

public final PutAliasRequest.Builder timeout(@Nullable
                                             Time value)

Explicit timestamp for the document

API name: timeout

timeout

public final PutAliasRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit timestamp for the document

API name: timeout

build

public PutAliasRequest build()

Builds a PutAliasRequest.

Specified by:

build in interface ObjectBuilder<PutAliasRequest>

Throws:

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