Package org.elasticsearch.snapshots
Class SnapshotId
- java.lang.Object
-
- org.elasticsearch.snapshots.SnapshotId
-
- All Implemented Interfaces:
Comparable<SnapshotId>,Writeable,ToXContent,ToXContentObject
public final class SnapshotId extends Object implements Comparable<SnapshotId>, Writeable, ToXContentObject
SnapshotId - snapshot name + snapshot UUID
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 snapshotSnapshotId(StreamInput in)Constructs a new snapshot from a input stream
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intcompareTo(SnapshotId other)booleanequals(Object o)StringgetName()Returns snapshot nameStringgetUUID()Returns the snapshot UUIDinthashCode()StringtoString()XContentBuildertoXContent(XContentBuilder builder, ToXContent.Params params)voidwriteTo(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 Detail
-
SnapshotId
public SnapshotId(String name, String uuid)
Constructs a new snapshot- Parameters:
name- snapshot nameuuid- snapshot uuid
-
SnapshotId
public SnapshotId(StreamInput in) throws IOException
Constructs a new snapshot from a input stream- Parameters:
in- input stream- Throws:
IOException
-
-
Method Detail
-
getName
public String getName()
Returns snapshot name- Returns:
- snapshot name
-
getUUID
public String getUUID()
Returns the snapshot UUID- Returns:
- snapshot uuid
-
compareTo
public int compareTo(SnapshotId other)
- Specified by:
compareToin interfaceComparable<SnapshotId>
-
writeTo
public void writeTo(StreamOutput out) throws IOException
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
- Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
-