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

Get aliases.

Get the cluster's index aliases, including filter and routing information. This 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()	The type of index that wildcard patterns can match.
final Boolean	local()	If true, the request computes the list of selected nodes from the local cluster state.
final Time	masterTimeout()	The period to wait for a connection to the master node.
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()

The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.

API name: expand_wildcards

local

@Nullable
public final Boolean local()

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

API name: local

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to -1.

API name: master_timeout

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