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

Class Alias

java.lang.Object
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 java.lang.Object
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
    Alias​(java.lang.String name)  
    Alias​(StreamInput in)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    java.lang.String filter()
    Returns the filter associated with the alias
    Alias filter​(java.lang.String filter)
    Associates a filter to the alias
    Alias filter​(java.util.Map<java.lang.String,​java.lang.Object> 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()  
    java.lang.String indexRouting()
    Returns the index routing value associated with the alias
    Alias indexRouting​(java.lang.String indexRouting)
    Associates an index routing value to the alias
    java.lang.Boolean isHidden()  
    Alias isHidden​(java.lang.Boolean isHidden)
    Sets whether this alias is hidden
    java.lang.String name()
    Returns the alias name
    Alias routing​(java.lang.String routing)
    Associates a routing value to the alias
    java.lang.String searchRouting()
    Returns the search routing value associated with the alias
    Alias searchRouting​(java.lang.String searchRouting)
    Associates a search routing value to the alias
    java.lang.String toString()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    java.lang.Boolean writeIndex()  
    Alias writeIndex​(java.lang.Boolean 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.Object

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

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

    isFragment

  • Constructor Details

    • Alias

      public Alias​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • Alias

      public Alias​(java.lang.String name)

  • Method Details

    • name

      public java.lang.String name()
      Returns the alias name

    • filter

      public java.lang.String filter()
      Returns the filter associated with the alias

    • filter

      public Alias filter​(java.lang.String filter)
      Associates a filter to the alias

    • filter

      public Alias filter​(java.util.Map<java.lang.String,​java.lang.Object> filter)
      Associates a filter to the alias

    • filter

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

    • routing

      public Alias routing​(java.lang.String routing)
      Associates a routing value to the alias

    • indexRouting

      public java.lang.String indexRouting()
      Returns the index routing value associated with the alias

    • indexRouting

      public Alias indexRouting​(java.lang.String indexRouting)
      Associates an index routing value to the alias

    • searchRouting

      public java.lang.String searchRouting()
      Returns the search routing value associated with the alias

    • searchRouting

      public Alias searchRouting​(java.lang.String searchRouting)
      Associates a search routing value to the alias

    • writeIndex

      public java.lang.Boolean writeIndex()
      Returns:
      the write index flag for the alias

    • writeIndex

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

    • isHidden

      public java.lang.Boolean isHidden()
      Returns:
      whether this alias is hidden or not

    • isHidden

      public Alias isHidden​(@Nullable java.lang.Boolean isHidden)
      Sets whether this alias is hidden

    • writeTo

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

    • fromXContent

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

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object