Class IndicesAliasesRequest.AliasActions
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
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/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
Modifier and TypeFieldDescriptionstatic org.elasticsearch.common.xcontent.ConstructingObjectParser<>
Parser for any oneAliasAction
.Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionType of the action to perform.add()
Build a newAliasAction
to add aliases.alias)
Set the alias this action is operating on.[]
aliases()
Returns the array of aliases that the action relates to... aliases)
Aliases to use with this action.boolean
obj)
boolean
Returns true if wildcards expressions among aliases should be resolved, false otherwisefilter()
filter)
<,> filter)
filter(QueryBuilder filter)
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
[]
Returns the aliases as they were originally requested, before any potential name resolutionint
hashCode()
boolean
Determines whether the request should be applied to data streams.index)
Set the index this action is operating on.indexRouting)
[]
indices()
Returns the array of indices that the action relates to... indices)
Sets the indices that the action relates to.Returns the indices options used to resolve indices.isHidden()
isHidden)
mustExist)
remove()
Build a newAliasAction
to remove aliases.Build a newAliasAction
to remove an index.void
... aliases)
Replaces current aliases with the provided aliases.routing()
routing)
Set the default routing.searchRouting)
toString()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
writeIndex)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class java.lang.
, , , , , , ,
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<> PARSERParser for any oneAliasAction
.
-
-
Constructor Details
-
AliasActions
-
AliasActions
Read from a stream.- Throws:
-
-
Method Details
-
add
Build a newAliasAction
to add aliases. -
remove
Build a newAliasAction
to remove aliases. -
removeIndex
Build a newAliasAction
to remove an index. -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
actionType
Type of the action to perform. -
indices
public ... indices)Description copied from interface:IndicesRequest.Replaceable
Sets the indices that the action relates to.- Specified by:
indices
in interfaceIndicesRequest.Replaceable
-
index
public index)Set the index this action is operating on. -
aliases
public ... aliases)Aliases to use with this action. -
alias
public alias)Set the alias this action is operating on. -
routing
public routing)Set the default routing. -
searchRouting
public searchRouting() -
searchRouting
public searchRouting) -
routing
public routing() -
indexRouting
public indexRouting() -
indexRouting
public indexRouting) -
filter
public filter() -
filter
public filter) -
filter
public <,> filter) -
filter
-
writeIndex
public writeIndex) -
writeIndex
public writeIndex() -
isHidden
public isHidden) -
isHidden
public isHidden() -
mustExist
public mustExist) -
mustExist
public mustExist() -
aliases
public [] 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(... 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 [] getOriginalAliases()Description copied from interface:AliasesRequest
Returns the aliases as they were originally requested, before any potential name resolution- 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
-
indices
public [] indices()Description copied from interface:IndicesRequest
Returns the array of indices that the action relates to- Specified by:
indices
in interfaceIndicesRequest
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequest
Determines whether the request should be applied to data streams. Whenfalse
, none of the names or wildcard expressions inIndicesRequest.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 interfaceIndicesRequest
-
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
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
-
fromXContent
public static IndicesAliasesRequest.AliasActions fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws- Throws:
-
toString
public toString()- Overrides:
in class
-
equals
public boolean equals( obj)- Overrides:
in class
-
hashCode
public int hashCode()- Overrides:
in class
-