Module org.elasticsearch.server
Class GetAliasesRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.support.local.LocalClusterStateRequest
org.elasticsearch.action.admin.indices.alias.get.GetAliasesRequest
- All Implemented Interfaces:
AliasesRequest,IndicesRequest,IndicesRequest.Replaceable,Writeable,RefCounted,TaskAwareRequest
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionString[]aliases()Returns the array of aliases that the action relates toReturns the task object that should be used to keep track of the processing of the request.booleanReturns true if wildcards expressions among aliases should be resolved, false otherwiseString[]Returns the aliases as was originally specified by the userbooleanDetermines whether the request should be applied to data streams.String[]indices()Returns the array of indices that the action relates toSets the indices that the action relates to.Returns the indices options used to resolve indices.indicesOptions(IndicesOptions indicesOptions) voidreplaceAliases(String... aliases) Replaces current aliases with the provided aliases.validate()Methods inherited from class org.elasticsearch.action.support.local.LocalClusterStateRequest
masterTimeout, writeToMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable
allowsRemoteIndicesMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
getDescription, setParentTask
-
Field Details
-
DEFAULT_INDICES_OPTIONS
-
-
Constructor Details
-
GetAliasesRequest
-
-
Method Details
-
indices
Description copied from interface:IndicesRequest.ReplaceableSets the indices that the action relates to.- Specified by:
indicesin interfaceIndicesRequest.Replaceable
-
aliases
-
indicesOptions
-
indices
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
aliases
Description copied from interface:AliasesRequestReturns the array of aliases that the action relates to- Specified by:
aliasesin interfaceAliasesRequest
-
replaceAliases
Description copied from interface:AliasesRequestReplaces current aliases with the provided aliases. Sometimes aliases expressions need to be resolved to concrete aliases prior to executing the transport action.- Specified by:
replaceAliasesin interfaceAliasesRequest
-
getOriginalAliases
Returns the aliases as was originally specified by the user- Specified by:
getOriginalAliasesin interfaceAliasesRequest
-
expandAliasesWildcards
public boolean expandAliasesWildcards()Description copied from interface:AliasesRequestReturns true if wildcards expressions among aliases should be resolved, false otherwise- Specified by:
expandAliasesWildcardsin interfaceAliasesRequest
-
indicesOptions
Description copied from interface:IndicesRequestReturns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.- Specified by:
indicesOptionsin interfaceIndicesRequest
-
validate
- Specified by:
validatein classActionRequest
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequestDetermines whether the request should be applied to data streams. Whenfalse, none of the names or wildcard expressions inIndicesRequest.indices()should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.- Specified by:
includeDataStreamsin interfaceIndicesRequest
-
createTask
public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) Description copied from interface:TaskAwareRequestReturns the task object that should be used to keep track of the processing of the request.- Specified by:
createTaskin interfaceTaskAwareRequest
-