Package org.opensearch.client.opensearch.indices

Class DeleteAliasRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.indices.DeleteAliasRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

DeleteAliasRequest

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

Builder for DeleteAliasRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeleteAliasRequest	build()	Builds a DeleteAliasRequest.
final DeleteAliasRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final DeleteAliasRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
DeleteAliasRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DeleteAliasRequest.Builder	index(String value, String... values)	Required - Comma-separated list of data streams or indexes used to limit the request.
final DeleteAliasRequest.Builder	index(List<String> list)	Required - Comma-separated list of data streams or indexes used to limit the request.
final DeleteAliasRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final DeleteAliasRequest.Builder	masterTimeout(Time value)	Deprecated.
final DeleteAliasRequest.Builder	name(String value, String... values)	Required - Comma-separated list of aliases to remove.
final DeleteAliasRequest.Builder	name(List<String> list)	Required - Comma-separated list of aliases to remove.
protected DeleteAliasRequest.Builder	self()
final DeleteAliasRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final DeleteAliasRequest.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 DeleteAliasRequest.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<DeleteAliasRequest.Builder,DeleteAliasRequest>

Returns:

a new builder instance.

self

@Nonnull
protected DeleteAliasRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<DeleteAliasRequest.Builder>

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

index

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

Required - Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*).

API name: index

Adds all elements of list to index.

index

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

Required - Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (*).

API name: index

Adds one or more values to index.

masterTimeout

@Deprecated
@Nonnull
public final DeleteAliasRequest.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 DeleteAliasRequest.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 DeleteAliasRequest.Builder name(List<String> list)

Required - Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use * or _all.

API name: name

Adds all elements of list to name.

name

@Nonnull
public final DeleteAliasRequest.Builder name(String value,
 String... values)

Required - Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use * or _all.

API name: name

Adds one or more values to name.

timeout

@Nonnull
public final DeleteAliasRequest.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 DeleteAliasRequest.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 DeleteAliasRequest build()

Builds a DeleteAliasRequest.

Specified by:

build in interface ObjectBuilder<DeleteAliasRequest>

Throws:

NullPointerException - if some of the required fields are null.