Package org.elasticsearch.snapshots

Class SnapshotId

java.lang.Object

org.elasticsearch.snapshots.SnapshotId

All Implemented Interfaces:

java.lang.Comparable<SnapshotId>, Writeable, ToXContent, ToXContentObject

public final class SnapshotId
extends java.lang.Object
implements java.lang.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(java.lang.String name, java.lang.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(java.lang.Object o)
static SnapshotId	fromXContent(XContentParser parser)
java.lang.String	getName()	Returns snapshot name
java.lang.String	getUUID()	Returns the snapshot UUID
int	hashCode()
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, 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 Detail

SnapshotId

public SnapshotId(java.lang.String name,
                  java.lang.String uuid)

Constructs a new snapshot

Parameters:

name - snapshot name

uuid - snapshot uuid

SnapshotId

public SnapshotId(StreamInput in)
           throws java.io.IOException

Constructs a new snapshot from a input stream

Parameters:

in - input stream

Throws:

java.io.IOException

Method Detail

getName

public java.lang.String getName()

Returns snapshot name

Returns:

snapshot name

getUUID

public java.lang.String getUUID()

Returns the snapshot UUID

Returns:

snapshot uuid

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

compareTo

public int compareTo(SnapshotId other)

Specified by:

compareTo in interface java.lang.Comparable<SnapshotId>

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

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

fromXContent

public static SnapshotId fromXContent(XContentParser parser)
                               throws java.io.IOException

Throws:

java.io.IOException