org.elasticsearch.action.admin.indices.alias

Class IndicesAliasesRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<Request>

org.elasticsearch.action.support.ChildTaskActionRequest<T>

org.elasticsearch.action.support.master.MasterNodeRequest<T>

org.elasticsearch.action.support.master.AcknowledgedRequest<IndicesAliasesRequest>

org.elasticsearch.action.admin.indices.alias.IndicesAliasesRequest

All Implemented Interfaces:

CompositeIndicesRequest, AckedRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class IndicesAliasesRequest
extends AcknowledgedRequest<IndicesAliasesRequest>
implements CompositeIndicesRequest

A request to add/remove aliases for one or more indices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndicesAliasesRequest.AliasActions

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

TransportRequest.Empty

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, timeout

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
IndicesAliasesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
IndicesAliasesRequest	addAlias(String alias, Map<String,Object> filter, String... indices) Adds an alias to the index.
IndicesAliasesRequest	addAlias(String alias, QueryBuilder filterBuilder, String... indices) Adds an alias to the index.
IndicesAliasesRequest	addAlias(String alias, String... indices) Adds an alias to the index.
IndicesAliasesRequest	addAliasAction(AliasAction action)
void	addAliasAction(IndicesAliasesRequest.AliasActions aliasAction)
List<IndicesAliasesRequest.AliasActions>	getAliasActions()
IndicesOptions	indicesOptions()
void	readFrom(StreamInput in)
IndicesAliasesRequest	removeAlias(String[] indices, String... aliases) Removes an alias to the index.
IndicesAliasesRequest	removeAlias(String index, String... aliases) Removes an alias to the index.
List<? extends IndicesRequest>	subRequests() Returns the subrequests that a composite request is composed of
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

ackTimeout, readTimeout, timeout, timeout, timeout, writeTimeout

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.support.ChildTaskActionRequest

createTask, createTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportRequest

getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.ack.AckedRequest

masterNodeTimeout

Constructor Detail

IndicesAliasesRequest

public IndicesAliasesRequest()

Method Detail

addAlias

public IndicesAliasesRequest addAlias(String alias,
                             String... indices)

Adds an alias to the index.

Parameters:

alias - The alias

indices - The indices

addAliasAction

public void addAliasAction(IndicesAliasesRequest.AliasActions aliasAction)

addAliasAction

public IndicesAliasesRequest addAliasAction(AliasAction action)

addAlias

public IndicesAliasesRequest addAlias(String alias,
                             Map<String,Object> filter,
                             String... indices)

Adds an alias to the index.

Parameters:

alias - The alias

filter - The filter

indices - The indices

addAlias

public IndicesAliasesRequest addAlias(String alias,
                             QueryBuilder filterBuilder,
                             String... indices)

Adds an alias to the index.

Parameters:

alias - The alias

filterBuilder - The filter

indices - The indices

removeAlias

public IndicesAliasesRequest removeAlias(String[] indices,
                                String... aliases)

Removes an alias to the index.

Parameters:

indices - The indices

aliases - The aliases

removeAlias

public IndicesAliasesRequest removeAlias(String index,
                                String... aliases)

Removes an alias to the index.

Parameters:

index - The index

aliases - The aliases

getAliasActions

public List<IndicesAliasesRequest.AliasActions> getAliasActions()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<IndicesAliasesRequest>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class MasterNodeRequest<IndicesAliasesRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class MasterNodeRequest<IndicesAliasesRequest>

Throws:

IOException

indicesOptions

public IndicesOptions indicesOptions()

subRequests

public List<? extends IndicesRequest> subRequests()

Description copied from interface: CompositeIndicesRequest

Returns the subrequests that a composite request is composed of

Specified by:

subRequests in interface CompositeIndicesRequest