Package org.elasticsearch.cluster.metadata

Class AliasMetadata

java.lang.Object
org.elasticsearch.cluster.AbstractDiffable<AliasMetadata>
org.elasticsearch.cluster.metadata.AliasMetadata
All Implemented Interfaces:
Diffable<AliasMetadata>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
public class AliasMetadata
extends AbstractDiffable<AliasMetadata>
implements org.elasticsearch.common.xcontent.ToXContentFragment

  • Constructor Details

    • AliasMetadata

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

  • Method Details

    • alias

      public java.lang.String alias()

    • getAlias

      public java.lang.String getAlias()

    • filter

      public CompressedXContent filter()

    • getFilter

      public CompressedXContent getFilter()

    • filteringRequired

      public boolean filteringRequired()

    • getSearchRouting

      public java.lang.String getSearchRouting()

    • searchRouting

      public java.lang.String searchRouting()

    • getIndexRouting

      public java.lang.String getIndexRouting()

    • indexRouting

      public java.lang.String indexRouting()

    • searchRoutingValues

      public java.util.Set<java.lang.String> searchRoutingValues()

    • writeIndex

      public java.lang.Boolean writeIndex()

    • isHidden

      @Nullable public java.lang.Boolean isHidden()

    • builder

      public static AliasMetadata.Builder builder​(java.lang.String alias)

    • newAliasMetadataBuilder

      public static AliasMetadata.Builder newAliasMetadataBuilder​(java.lang.String alias)

    • newAliasMetadata

      public static AliasMetadata newAliasMetadata​(AliasMetadata aliasMetadata, java.lang.String newAlias)
      Creates a new AliasMetadata instance with same content as the given one, but with a different alias name

    • 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

    • 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

    • readDiffFrom

      public static Diff<AliasMetadata> readDiffFrom​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • toString

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

    • 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

    • getFirstAliasMetadata

      public static AliasMetadata getFirstAliasMetadata​(IndexAbstraction ia)