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

All Implemented Interfaces:

ToCopyableBuilder<AliasesRequest.Builder,AliasesRequest>

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

Shows information about aliases currently configured to indexes, including filter and routing information.

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.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
protected void	applyQueryParameters(Map<String,String> params)
static AliasesRequest.Builder	builder()
boolean	equals(Object o)
final List<ExpandWildcard>	expandWildcards()	Specifies the type of index that wildcard expressions can match.
int	hashCode()
final List<String>	name()	A comma-separated list of aliases to retrieve.
static AliasesRequest	of(Function<AliasesRequest.Builder,ObjectBuilder<AliasesRequest>> fn)
AliasesRequest.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.cat.CatRequestBase

headers, sort

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

Endpoint "cat.aliases".

Method Details

of

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

expandWildcards

@Nonnull
public final List<ExpandWildcard> expandWildcards()

Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

API name: expand_wildcards

name

@Nonnull
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

toBuilder

@Nonnull
public AliasesRequest.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<AliasesRequest.Builder,AliasesRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static AliasesRequest.Builder builder()

applyQueryParameters

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

Overrides:

applyQueryParameters in class CatRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object