Package org.elasticsearch.repositories

Class IndexId

java.lang.Object
org.elasticsearch.repositories.IndexId
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public final class IndexId extends Object implements Writeable, org.elasticsearch.common.xcontent.ToXContentObject
Represents a single snapshotted index in the repository.

  • 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
    Modifier and Type
    Field
    Description
    protected static String
    ID
     
    protected static String
    NAME
     

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    IndexId(String name, String id)
     
    IndexId(StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    String
    getId()
    The unique ID for the index within the repository.
    String
    getName()
    The name of the index.
    int
    hashCode()
     
    String
    toString()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    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.ToXContentObject

    isFragment

  • Field Details

  • Constructor Details

  • Method Details

    • getName

      public String getName()
      The name of the index.

    • getId

      public String getId()
      The unique ID for the index within the repository. This is *not* the same as the index's UUID, but merely a unique file/URL friendly identifier that a repository can use to name blobs for the index. We could not use the index's actual UUID (See Index.getUUID()) because in the case of snapshot/restore, the index UUID in the snapshotted index will be different from the index UUID assigned to it when it is restored. Hence, the actual index UUID is not useful in the context of snapshot/restore for tying a snapshotted index to the index it was snapshot from, and so we are using a separate UUID here.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • writeTo

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

    • toXContent

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