Package co.elastic.clients.elasticsearch.indices

Class DeleteAliasRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.DeleteAliasRequest

public class DeleteAliasRequest
extends RequestBase

Delete an alias. Removes a data stream or index from an alias.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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
final List<String>	index()	Required - Comma-separated list of data streams or indices used to limit the request.
final Time	masterTimeout()	Period to wait for a connection to the master node.
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.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

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)

index

public final List<String> index()

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

API name: index

masterTimeout

@Nullable
public final Time masterTimeout()

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

API name: master_timeout

name

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