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
,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.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.MasterNodeRequest
DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
-
Constructor Summary
Constructors Constructor Description GetAliasesRequest()
GetAliasesRequest(java.lang.String... aliases)
GetAliasesRequest(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.lang.String[]
aliases()
Returns the array of aliases that the action relates toGetAliasesRequest
aliases(java.lang.String... aliases)
boolean
expandAliasesWildcards()
Returns true if wildcards expressions among aliases should be resolved, false otherwisejava.lang.String[]
getOriginalAliases()
Returns the aliases as was originally specified by the userjava.lang.String[]
indices()
Returns the array of indices that the action relates toGetAliasesRequest
indices(java.lang.String... indices)
Sets the indices that the action relates to.IndicesOptions
indicesOptions()
Returns the indices options used to resolve indices.GetAliasesRequest
indicesOptions(IndicesOptions indicesOptions)
void
replaceAliases(java.lang.String... aliases)
Replaces current aliases with the provided aliases.ActionRequestValidationException
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.transport.TransportRequest
getParentTask, setParentTask
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
GetAliasesRequest
public GetAliasesRequest(java.lang.String... aliases) -
GetAliasesRequest
public GetAliasesRequest() -
GetAliasesRequest
- Throws:
java.io.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:
java.io.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
public java.lang.String[] indices()Description copied from interface:IndicesRequest
Returns the array of indices that the action relates to- Specified by:
indices
in interfaceIndicesRequest
-
aliases
public java.lang.String[] aliases()Description copied from interface:AliasesRequest
Returns the array of aliases that the action relates to- Specified by:
aliases
in interfaceAliasesRequest
-
replaceAliases
public void replaceAliases(java.lang.String... aliases)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
public java.lang.String[] 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
-