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, Streamable, Writeable, TaskAwareRequest

public class GetAliasesRequest
extends MasterNodeReadRequest<GetAliasesRequest>
implements AliasesRequest

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

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

Constructor Summary

Constructors

Constructor	Description
GetAliasesRequest()
GetAliasesRequest(java.lang.String alias)
GetAliasesRequest(java.lang.String[] aliases)

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	aliases()	Returns the array of aliases that the action relates to
GetAliasesRequest	aliases(java.lang.String... aliases)	Sets the array of aliases that the action relates to
boolean	expandAliasesWildcards()	Returns true if wildcards expressions among aliases should be resolved, false otherwise
java.lang.String[]	indices()	Returns the array of indices that the action relates to
GetAliasesRequest	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	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Constructor Detail

GetAliasesRequest

public GetAliasesRequest(java.lang.String[] aliases)

GetAliasesRequest

public GetAliasesRequest(java.lang.String alias)

GetAliasesRequest

public GetAliasesRequest()

Method Detail

indices

public GetAliasesRequest indices(java.lang.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(java.lang.String... aliases)

Description copied from interface: AliasesRequest

Sets the array of aliases that the action relates to

Specified by:

aliases in interface AliasesRequest

indicesOptions

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

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

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeReadRequest<GetAliasesRequest>

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class MasterNodeReadRequest<GetAliasesRequest>

Throws:

java.io.IOException