Class GetAliasRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.GetAliasRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
public final class GetAliasRequest extends RequestBase
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetAliasRequest.Builder
Builder forGetAliasRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<GetAliasRequest,GetAliasResponse,ElasticsearchError>
ENDPOINT
Endpoint "indices.get_alias
". -
Constructor Summary
Constructors Constructor Description GetAliasRequest(GetAliasRequest.Builder builder)
GetAliasRequest(java.util.function.Function<GetAliasRequest.Builder,GetAliasRequest.Builder> fn)
-
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<ExpandWildcardOptions>
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 aliasesjava.lang.Boolean
local()
Return local information, do not retrieve the state from master node (default: false)java.util.List<java.lang.String>
name()
A comma-separated list of alias names to returnMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
ENDPOINT
Endpoint "indices.get_alias
".
-
-
Constructor Details
-
GetAliasRequest
-
GetAliasRequest
public GetAliasRequest(java.util.function.Function<GetAliasRequest.Builder,GetAliasRequest.Builder> fn)
-
-
Method Details
-
name
@Nullable public java.util.List<java.lang.String> name()A comma-separated list of alias names to returnAPI name:
name
-
index
@Nullable public java.util.List<java.lang.String> index()A comma-separated list of index names to filter aliasesAPI name:
index
-
allowNoIndices
@Nullable public 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
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
local
@Nullable public java.lang.Boolean local()Return local information, do not retrieve the state from master node (default: false)API name:
local
-