org.elasticsearch.action

Interface AliasesRequest

All Superinterfaces:

IndicesRequest, IndicesRequest.Replaceable

All Known Implementing Classes:

GetAliasesRequest, IndicesAliasesRequest.AliasActions

public interface AliasesRequest
extends IndicesRequest.Replaceable

Needs to be implemented by all ActionRequest subclasses that relate to one or more indices and one or more aliases. Meant to be used for aliases management requests (e.g. add/remove alias, get aliases) that hold aliases and indices in separate fields. Allows to retrieve which indices and aliases the action relates to.

Nested Class Summary

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

IndicesRequest.Replaceable

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	aliases() Returns the array of aliases that the action relates to
AliasesRequest	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

Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable

indices

Methods inherited from interface org.elasticsearch.action.IndicesRequest

indices, indicesOptions

Method Detail

aliases

java.lang.String[] aliases()

Returns the array of aliases that the action relates to

aliases

AliasesRequest aliases(java.lang.String... aliases)

Sets the array of aliases that the action relates to

expandAliasesWildcards

boolean expandAliasesWildcards()

Returns true if wildcards expressions among aliases should be resolved, false otherwise