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

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.

  • Field Details

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<> PARSER
      Parser for any one AliasAction.

  • Constructor Details

  • 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
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:

    • actionType

      public IndicesAliasesRequest.AliasActions.Type 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 interface IndicesRequest.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

      public IndicesAliasesRequest.AliasActions filter​(QueryBuilder 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 interface AliasesRequest

    • 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 interface AliasesRequest

    • 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 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 [] 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
      Specified by:
      toXContent in interface org.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