Package org.opensearch.client.opensearch.indices

Class PutAliasRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<PutAliasRequest.Builder>

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

All Implemented Interfaces:

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

Enclosing class:

PutAliasRequest

public static class PutAliasRequest.Builder
extends RequestBase.AbstractBuilder<PutAliasRequest.Builder>
implements CopyableBuilder<PutAliasRequest.Builder,PutAliasRequest>

Builder for PutAliasRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PutAliasRequest.Builder	alias(String value)	API name: alias
PutAliasRequest	build()	Builds a PutAliasRequest.
final PutAliasRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final PutAliasRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
PutAliasRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PutAliasRequest.Builder	filter(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: filter
final PutAliasRequest.Builder	filter(Query value)	API name: filter
final PutAliasRequest.Builder	index(String value, String... values)	A comma-separated list of data streams or indexes to add.
final PutAliasRequest.Builder	index(List<String> list)	A comma-separated list of data streams or indexes to add.
final PutAliasRequest.Builder	indexRouting(String value)	API name: index_routing
final PutAliasRequest.Builder	isHidden(Boolean value)	If true, the alias will be hidden`.
final PutAliasRequest.Builder	isWriteIndex(Boolean value)	If true, sets the write index or data stream for the alias.
final PutAliasRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final PutAliasRequest.Builder	masterTimeout(Time value)	Deprecated.
final PutAliasRequest.Builder	name(String value)	Alias to update.
final PutAliasRequest.Builder	routing(String value)	API name: routing
final PutAliasRequest.Builder	searchRouting(String value)	API name: search_routing
protected PutAliasRequest.Builder	self()
final PutAliasRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final PutAliasRequest.Builder	timeout(Time value)	Period to wait for a response.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

Returns:

a new builder instance.

self

@Nonnull
protected PutAliasRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutAliasRequest.Builder>

alias

@Nonnull
public final PutAliasRequest.Builder alias(@Nullable
 String value)

API name: alias

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final PutAliasRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

filter

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

API name: filter

filter

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

API name: filter

index

@Nonnull
public final PutAliasRequest.Builder index(List<String> list)

A comma-separated list of data streams or indexes to add. Supports wildcards (*). Wildcard patterns that match both data streams and indexes return an error.

API name: index

Adds all elements of list to index.

index

@Nonnull
public final PutAliasRequest.Builder index(String value,
 String... values)

A comma-separated list of data streams or indexes to add. Supports wildcards (*). Wildcard patterns that match both data streams and indexes return an error.

API name: index

Adds one or more values to index.

indexRouting

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

API name: index_routing

isHidden

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

If true, the alias will be hidden`.

API name: is_hidden

isWriteIndex

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

If true, sets the write index or data stream for the alias. If an alias points to multiple indexes or data streams and is_write_index isn't set, the alias rejects write requests. If an index alias points to one index and is_write_index isn't set, the index automatically acts as the write index. Data stream aliases don't automatically set a write data stream, even if the alias points to one data stream.

API name: is_write_index

masterTimeout

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

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

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

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

name

@Nonnull
public final PutAliasRequest.Builder name(@Nullable
 String value)

Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math.

API name: name

routing

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

API name: routing

searchRouting

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

API name: search_routing

timeout

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

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

timeout

@Nonnull
public final PutAliasRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

build

@Nonnull
public PutAliasRequest build()

Builds a PutAliasRequest.

Specified by:

build in interface ObjectBuilder<PutAliasRequest>

Throws:

NullPointerException - if some of the required fields are null.