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

Class Alias

org.elasticsearch.action.admin.indices.alias.Alias
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
public class Alias extends implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment
Represents an alias, to be associated with an index

  • Nested Class Summary

    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 inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
     name)
     
    Alias​(StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     o)
     
    filter()
    Returns the filter associated with the alias
    Alias
     filter)
    Associates a filter to the alias
    Alias
    <,​> filter)
    Associates a filter to the alias
    Alias
    filter​(QueryBuilder filterBuilder)
    Associates a filter to the alias
    static Alias
    fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
    Parses an alias and returns its parsed representation
    int
    hashCode()
     
    indexRouting()
    Returns the index routing value associated with the alias
    Alias
     indexRouting)
    Associates an index routing value to the alias
    isHidden()
     
    Alias
     isHidden)
    Sets whether this alias is hidden
    name()
    Returns the alias name
    Alias
     name)
    Modify the alias name only
    Alias
     routing)
    Associates a routing value to the alias
    searchRouting()
    Returns the search routing value associated with the alias
    Alias
     searchRouting)
    Associates a search routing value to the alias
    toString()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    writeIndex()
     
    Alias
     writeIndex)
    Sets whether an alias is pointing to a write-index
    void
    writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.

    , , , , , , ,

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

    isFragment

  • Constructor Details

    • Alias

      public Alias​(StreamInput in) throws
      Throws:

    • Alias

      public Alias​( name)

  • Method Details

    • name

      public  name()
      Returns the alias name

    • name

      public  name)
      Modify the alias name only

    • filter

      public  filter()
      Returns the filter associated with the alias

    • filter

      public  filter)
      Associates a filter to the alias

    • filter

      public <,​> filter)
      Associates a filter to the alias

    • filter

      public Alias filter​(QueryBuilder filterBuilder)
      Associates a filter to the alias

    • routing

      public  routing)
      Associates a routing value to the alias

    • indexRouting

      public  indexRouting()
      Returns the index routing value associated with the alias

    • indexRouting

      public  indexRouting)
      Associates an index routing value to the alias

    • searchRouting

      public  searchRouting()
      Returns the search routing value associated with the alias

    • searchRouting

      public  searchRouting)
      Associates a search routing value to the alias

    • writeIndex

      public  writeIndex()
      Returns:
      the write index flag for the alias

    • writeIndex

      public Alias writeIndex​(@Nullable  writeIndex)
      Sets whether an alias is pointing to a write-index

    • isHidden

      public  isHidden()
      Returns:
      whether this alias is hidden or not

    • isHidden

      public Alias isHidden​(@Nullable  isHidden)
      Sets whether this alias is hidden

    • writeTo

      public void writeTo​(StreamOutput out) throws
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:

    • fromXContent

      public static Alias fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws
      Parses an alias and returns its parsed representation
      Throws:

    • 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:

    • toString

      public  toString()
      Overrides:
       in class 

    • equals

      public boolean equals​( o)
      Overrides:
       in class 

    • hashCode

      public int hashCode()
      Overrides:
       in class