Package org.elasticsearch.action.admin.indices.alias.get

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.Replaceable

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final IndicesOptions	DEFAULT_INDICES_OPTIONS

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

Constructor Summary

Constructors

Constructor	Description
GetAliasesRequest()
GetAliasesRequest(String... aliases)
GetAliasesRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String[]	aliases()	Returns the array of aliases that the action relates to
GetAliasesRequest	aliases(String... aliases)
boolean	expandAliasesWildcards()	Returns true if wildcards expressions among aliases should be resolved, false otherwise
String[]	getOriginalAliases()	Returns the aliases as was originally specified by the user
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
String[]	indices()	Returns the array of indices that the action relates to
GetAliasesRequest	indices(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(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.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, 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.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Details

DEFAULT_INDICES_OPTIONS

public static final IndicesOptions DEFAULT_INDICES_OPTIONS

Constructor Details

GetAliasesRequest

public GetAliasesRequest(String... aliases)

GetAliasesRequest

public GetAliasesRequest()

GetAliasesRequest

public GetAliasesRequest(StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeReadRequest<GetAliasesRequest>

Throws:

IOException

indices

public GetAliasesRequest indices(String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

aliases

public GetAliasesRequest aliases(String... aliases)

indicesOptions

public GetAliasesRequest indicesOptions(IndicesOptions indicesOptions)

indices

public String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

aliases

public String[] aliases()

Description copied from interface: AliasesRequest

Returns the array of aliases that the action relates to

Specified by:

aliases in interface AliasesRequest

replaceAliases

public void replaceAliases(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 interface AliasesRequest

getOriginalAliases

public String[] getOriginalAliases()

Returns the aliases as was originally specified by the user

Specified by:

getOriginalAliases in interface AliasesRequest

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 interface AliasesRequest

indicesOptions

public IndicesOptions 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 interface IndicesRequest

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.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 interface IndicesRequest