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.master.MasterNodeRequest<Request>
org.elasticsearch.action.support.master.MasterNodeReadRequest<GetAliasesRequest>
org.elasticsearch.action.admin.indices.alias.get.GetAliasesRequest
- All Implemented Interfaces:
AliasesRequest
,IndicesRequest
,IndicesRequest.Replaceable
,Writeable
,RefCounted
,TaskAwareRequest
public class GetAliasesRequest
extends MasterNodeReadRequest<GetAliasesRequest>
implements AliasesRequest
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
local
Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
Fields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED
-
Constructor Summary
ConstructorDescriptionGetAliasesRequest
(String... aliases) NB prior to 8.12 get-aliases was a TransportMasterNodeReadAction so for BwC we must remain able to read these requests until we no longer need to support calling this action remotely. -
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.boolean
Returns true if wildcards expressions among aliases should be resolved, false otherwiseString[]
Returns the aliases as was originally specified by the userboolean
Determines 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) void
replaceAliases
(String... aliases) Replaces current aliases with the provided aliases.validate()
void
writeTo
(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.MasterNodeReadRequest
local, local
Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, getRequestId, setParentTask, setRequestId, toString
Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable
allowsRemoteIndices
Methods inherited from interface org.elasticsearch.core.RefCounted
mustIncRef
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
getDescription, setParentTask
-
Field Details
-
DEFAULT_INDICES_OPTIONS
-
-
Constructor Details
-
GetAliasesRequest
-
GetAliasesRequest
public GetAliasesRequest() -
GetAliasesRequest
NB prior to 8.12 get-aliases was a TransportMasterNodeReadAction so for BwC we must remain able to read these requests until we no longer need to support calling this action remotely. Once we remove this we can also make this class a regular ActionRequest instead of a MasterNodeReadRequest.- Throws:
IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classMasterNodeReadRequest<GetAliasesRequest>
- Throws:
IOException
-
indices
Description copied from interface:IndicesRequest.Replaceable
Sets the indices that the action relates to.- Specified by:
indices
in interfaceIndicesRequest.Replaceable
-
aliases
-
indicesOptions
-
indices
Description copied from interface:IndicesRequest
Returns the array of indices that the action relates to- Specified by:
indices
in interfaceIndicesRequest
-
aliases
Description copied from interface:AliasesRequest
Returns the array of aliases that the action relates to- Specified by:
aliases
in interfaceAliasesRequest
-
replaceAliases
Description copied from interface:AliasesRequest
Replaces current aliases with the provided aliases. Sometimes aliases expressions need to be resolved to concrete aliases prior to executing the transport action.- Specified by:
replaceAliases
in interfaceAliasesRequest
-
getOriginalAliases
Returns the aliases as was originally specified by the user- Specified by:
getOriginalAliases
in interfaceAliasesRequest
-
expandAliasesWildcards
public boolean expandAliasesWildcards()Description copied from interface:AliasesRequest
Returns true if wildcards expressions among aliases should be resolved, false otherwise- Specified by:
expandAliasesWildcards
in interfaceAliasesRequest
-
indicesOptions
Description copied from interface:IndicesRequest
Returns 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:
indicesOptions
in interfaceIndicesRequest
-
validate
- Specified by:
validate
in classActionRequest
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequest
Determines 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:
includeDataStreams
in interfaceIndicesRequest
-
createTask
public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) Description copied from interface:TaskAwareRequest
Returns the task object that should be used to keep track of the processing of the request.- Specified by:
createTask
in interfaceTaskAwareRequest
-