Package org.opensearch.client.opensearch.indices

Class DeleteAliasRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.DeleteAliasRequest

All Implemented Interfaces:

ToCopyableBuilder<DeleteAliasRequest.Builder,DeleteAliasRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class DeleteAliasRequest
extends RequestBase
implements ToCopyableBuilder<DeleteAliasRequest.Builder,DeleteAliasRequest>

Deletes an alias.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteAliasRequest.Builder	Builder for DeleteAliasRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<DeleteAliasRequest,DeleteAliasResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.delete_alias".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static DeleteAliasRequest.Builder	builder()
final Time	clusterManagerTimeout()	Operation timeout for connection to cluster-manager node.
boolean	equals(Object o)
int	hashCode()
final List<String>	index()	Required - Comma-separated list of data streams or indexes used to limit the request.
final Time	masterTimeout()	Deprecated.
final List<String>	name()	Required - Comma-separated list of aliases to remove.
static DeleteAliasRequest	of(Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)
final Time	timeout()	Period to wait for a response.
DeleteAliasRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_ENDPOINT

public static final Endpoint<DeleteAliasRequest,DeleteAliasResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.delete_alias".

Method Details

of

public static DeleteAliasRequest of(Function<DeleteAliasRequest.Builder,ObjectBuilder<DeleteAliasRequest>> fn)

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

index

@Nonnull
public final List<String> index()

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

API name: index

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

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 List<String> name()

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

API name: name

timeout

@Nullable
public final Time timeout()

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

toBuilder

@Nonnull
public DeleteAliasRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteAliasRequest.Builder,DeleteAliasRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static DeleteAliasRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object