Package co.elastic.clients.elasticsearch.cat

Class AliasesRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.AliasesRequest

public class AliasesRequest
extends CatRequestBase

Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. IMPORTANT: cat APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<AliasesRequest,AliasesResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.aliases".

Method Summary

Modifier and Type	Method	Description
final List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final List<String>	name()	A comma-separated list of aliases to retrieve.
static AliasesRequest	of(Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)

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<AliasesRequest,AliasesResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.aliases".

Method Details

of

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

expandWildcards

public final List<ExpandWildcard> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

name

public final List<String> name()

A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

API name: name