Class Alias

All Implemented Interfaces:
Writeable, ToXContent, ToXContentFragment

public class Alias
extends java.lang.Object
implements Writeable, ToXContentFragment
Represents an alias, to be associated with an index
  • Constructor Details

    • Alias

      public Alias​(StreamInput in) throws
    • 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()
      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
    • writeTo

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

      public static Alias fromXContent​(XContentParser parser) throws
      Parses an alias and returns its parsed representation
    • toXContent

      public XContentBuilder toXContent​(XContentBuilder builder, ToXContent.Params params) throws
      Specified by:
      toXContent in interface ToXContent
    • toString

      public java.lang.String toString()
      toString in class java.lang.Object
    • equals

      public boolean equals​(java.lang.Object o)
      equals in class java.lang.Object
    • hashCode

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