Class IndexId

All Implemented Interfaces:
Writeable, ToXContent, ToXContentObject

public final class IndexId
extends java.lang.Object
implements Writeable, ToXContentObject
Represents a single snapshotted index in the repository.
  • Field Details

  • Constructor Details

    • IndexId

      public IndexId​(java.lang.String name, java.lang.String id)
    • IndexId

      public IndexId​(StreamInput in) throws
  • Method Details

    • getName

      public java.lang.String getName()
      The name of the index.
    • getId

      public java.lang.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 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
    • writeTo

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

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