Package org.elasticsearch.snapshots

Class SnapshotId

java.lang.Object
org.elasticsearch.snapshots.SnapshotId
All Implemented Interfaces:
Comparable<SnapshotId>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public final class SnapshotId extends Object implements Comparable<SnapshotId>, Writeable, org.elasticsearch.common.xcontent.ToXContentObject
SnapshotId - snapshot name + snapshot UUID

  • 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
    SnapshotId(String name, String uuid)
    Constructs a new snapshot
    SnapshotId(StreamInput in)
    Constructs a new snapshot from a input stream

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(SnapshotId other)
     
    boolean
    equals(Object o)
     
    String
    getName()
    Returns snapshot name
    String
    getUUID()
    Returns the snapshot UUID
    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

  • Constructor Details

    • SnapshotId

      public SnapshotId(String name, String uuid)
      Constructs a new snapshot
      Parameters:
      name - snapshot name
      uuid - snapshot uuid

    • SnapshotId

      public SnapshotId(StreamInput in) throws IOException
      Constructs a new snapshot from a input stream
      Parameters:
      in - input stream
      Throws:
      IOException

  • Method Details

    • getName

      public String getName()
      Returns snapshot name
      Returns:
      snapshot name

    • getUUID

      public String getUUID()
      Returns the snapshot UUID
      Returns:
      snapshot uuid

    • 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

    • compareTo

      public int compareTo(SnapshotId other)
      Specified by:
      compareTo in interface Comparable<SnapshotId>

    • 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