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

Class IndicesAliasesRequest.AliasActions

java.lang.Object

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

All Implemented Interfaces:

AliasesRequest, IndicesRequest, IndicesRequest.Replaceable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject

Enclosing class:

IndicesAliasesRequest

public static class IndicesAliasesRequest.AliasActions
extends Object
implements AliasesRequest, Writeable, org.elasticsearch.common.xcontent.ToXContentObject

Request to take one or more actions on one or more indexes and alias combinations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndicesAliasesRequest.AliasActions.Type

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

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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 org.elasticsearch.common.xcontent.ConstructingObjectParser<IndicesAliasesRequest.AliasActions,Void>	PARSER	Parser for any one AliasAction.

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AliasActions(IndicesAliasesRequest.AliasActions.Type type)
AliasActions(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
IndicesAliasesRequest.AliasActions.Type	actionType()	Type of the action to perform.
static IndicesAliasesRequest.AliasActions	add()	Build a new AliasAction to add aliases.
IndicesAliasesRequest.AliasActions	alias(String alias)	Set the alias this action is operating on.
String[]	aliases()	Returns the array of aliases that the action relates to
IndicesAliasesRequest.AliasActions	aliases(String... aliases)	Aliases to use with this action.
boolean	equals(Object obj)
boolean	expandAliasesWildcards()	Returns true if wildcards expressions among aliases should be resolved, false otherwise
String	filter()
IndicesAliasesRequest.AliasActions	filter(String filter)
IndicesAliasesRequest.AliasActions	filter(Map<String,Object> filter)
IndicesAliasesRequest.AliasActions	filter(QueryBuilder filter)
static IndicesAliasesRequest.AliasActions	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
String[]	getOriginalAliases()	Returns the aliases as they were originally requested, before any potential name resolution
int	hashCode()
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
IndicesAliasesRequest.AliasActions	index(String index)	Set the index this action is operating on.
String	indexRouting()
IndicesAliasesRequest.AliasActions	indexRouting(String indexRouting)
String[]	indices()	Returns the array of indices that the action relates to
IndicesAliasesRequest.AliasActions	indices(String... indices)	Sets the indices that the action relates to.
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
Boolean	isHidden()
IndicesAliasesRequest.AliasActions	isHidden(Boolean isHidden)
Boolean	mustExist()
IndicesAliasesRequest.AliasActions	mustExist(Boolean mustExist)
static IndicesAliasesRequest.AliasActions	remove()	Build a new AliasAction to remove aliases.
static IndicesAliasesRequest.AliasActions	removeIndex()	Build a new AliasAction to remove an index.
void	replaceAliases(String... aliases)	Replaces current aliases with the provided aliases.
String	routing()
IndicesAliasesRequest.AliasActions	routing(String routing)	Set the default routing.
String	searchRouting()
IndicesAliasesRequest.AliasActions	searchRouting(String searchRouting)
String	toString()
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
Boolean	writeIndex()
IndicesAliasesRequest.AliasActions	writeIndex(Boolean writeIndex)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.action.IndicesRequest

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Details

PARSER

public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<IndicesAliasesRequest.AliasActions,Void> PARSER

Parser for any one AliasAction.

Constructor Details

AliasActions

public AliasActions(IndicesAliasesRequest.AliasActions.Type type)

AliasActions

public AliasActions(StreamInput in)
             throws IOException

Read from a stream.

Throws:

IOException

Method Details

add

public static IndicesAliasesRequest.AliasActions add()

Build a new AliasAction to add aliases.

remove

public static IndicesAliasesRequest.AliasActions remove()

Build a new AliasAction to remove aliases.

removeIndex

public static IndicesAliasesRequest.AliasActions removeIndex()

Build a new AliasAction to remove an index.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

actionType

public IndicesAliasesRequest.AliasActions.Type actionType()

Type of the action to perform.

indices

public IndicesAliasesRequest.AliasActions indices(String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

index

public IndicesAliasesRequest.AliasActions index(String index)

Set the index this action is operating on.

aliases

public IndicesAliasesRequest.AliasActions aliases(String... aliases)

Aliases to use with this action.

alias

public IndicesAliasesRequest.AliasActions alias(String alias)

Set the alias this action is operating on.

routing

public IndicesAliasesRequest.AliasActions routing(String routing)

Set the default routing.

searchRouting

public String searchRouting()

searchRouting

public IndicesAliasesRequest.AliasActions searchRouting(String searchRouting)

routing

public String routing()

indexRouting

public String indexRouting()

indexRouting

public IndicesAliasesRequest.AliasActions indexRouting(String indexRouting)

filter

public String filter()

filter

public IndicesAliasesRequest.AliasActions filter(String filter)

filter

public IndicesAliasesRequest.AliasActions filter(Map<String,Object> filter)

filter

public IndicesAliasesRequest.AliasActions filter(QueryBuilder filter)

writeIndex

public IndicesAliasesRequest.AliasActions writeIndex(Boolean writeIndex)

writeIndex

public Boolean writeIndex()

isHidden

public IndicesAliasesRequest.AliasActions isHidden(Boolean isHidden)

isHidden

public Boolean isHidden()

mustExist

public IndicesAliasesRequest.AliasActions mustExist(Boolean mustExist)

mustExist

public Boolean mustExist()

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

Description copied from interface: AliasesRequest

Returns the aliases as they were originally requested, before any potential name resolution

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

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

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

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

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

IOException

fromXContent

public static IndicesAliasesRequest.AliasActions fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
                                                       throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object