Package org.opensearch.client.opensearch.cat

Class AliasesRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cat.CatRequestBase

org.opensearch.client.opensearch.cat.AliasesRequest

public class AliasesRequest
extends CatRequestBase

Shows information about currently configured aliases to indices including filter and routing infos.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

CatRequestBase.CatRequestBaseBuilder<BuilderT extends CatRequestBase.CatRequestBaseBuilder>

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 Endpoint<AliasesRequest,AliasesResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.aliases".

Method Summary

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

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase

headers, queryParameters, sort

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<AliasesRequest,AliasesResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.aliases".

Method Detail

of

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

expandWildcards

public final java.util.List<ExpandWildcard> expandWildcards()

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

API name: expand_wildcards

name

public final java.util.List<java.lang.String> name()

A comma-separated list of alias names to return

API name: name