Package org.opensearch.client.opensearch.indices

Class GetAliasRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.GetAliasRequest

public class GetAliasRequest
extends RequestBase

Returns an alias.

Nested Class Summary

Nested Classes

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

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<GetAliasRequest,GetAliasResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.get_alias".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
java.util.List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
java.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
java.util.List<java.lang.String>	index()	A comma-separated list of index names to filter aliases
java.lang.Boolean	local()	Return local information, do not retrieve the state from cluster-manager node (default: false)
java.util.List<java.lang.String>	name()	A comma-separated list of alias names to return
static GetAliasRequest	of(java.util.function.Function<GetAliasRequest.Builder,ObjectBuilder<GetAliasRequest>> fn)

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<GetAliasRequest,GetAliasResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.get_alias".

Method Detail

of

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

allowNoIndices

@Nullable
public final java.lang.Boolean allowNoIndices()

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

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

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

index

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

A comma-separated list of index names to filter aliases

API name: index

local

@Nullable
public final java.lang.Boolean local()

Return local information, do not retrieve the state from cluster-manager node (default: false)

API name: local

name

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

A comma-separated list of alias names to return

API name: name