Package org.elasticsearch.snapshots

Class SnapshotInfo

java.lang.Object

org.elasticsearch.snapshots.SnapshotInfo

All Implemented Interfaces:

Comparable<SnapshotInfo>, Writeable, ToXContent

public final class SnapshotInfo
extends Object
implements Comparable<SnapshotInfo>, ToXContent, Writeable

Information about a snapshot

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotInfo.SnapshotInfoBuilder

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

Modifier and Type	Field	Description
static String	CONTEXT_MODE_PARAM
static String	CONTEXT_MODE_SNAPSHOT
static Version	METADATA_FIELD_INTRODUCED
static ObjectParser<SnapshotInfo.SnapshotInfoBuilder,Void>	SNAPSHOT_INFO_PARSER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SnapshotInfo(StreamInput in)	Constructs snapshot information from stream input
SnapshotInfo(SnapshotId snapshotId, List<String> indices, long startTime, Boolean includeGlobalState, Map<String,Object> userMetadata)
SnapshotInfo(SnapshotId snapshotId, List<String> indices, long startTime, String reason, long endTime, int totalShards, List<SnapshotShardFailure> shardFailures, Boolean includeGlobalState, Map<String,Object> userMetadata)
SnapshotInfo(SnapshotId snapshotId, List<String> indices, SnapshotState state)
SnapshotInfo(SnapshotId snapshotId, List<String> indices, SnapshotState state, Version version)

Method Summary

Modifier and Type	Method	Description
SnapshotInfo	basic()	Gets a new SnapshotInfo instance from the given SnapshotInfo with all information stripped out except the snapshot id, state, and indices.
int	compareTo(SnapshotInfo o)	Compares two snapshots by their start time; if the start times are the same, then compares the two snapshots by their snapshot ids.
long	endTime()	Returns time when snapshot ended; a value of 0L will be returned if the snapshot is still running or if state() returns null.
boolean	equals(Object o)
int	failedShards()	Number of failed shards; a value of 0 will be returned if there were no failed shards, or if state() returns null.
static SnapshotInfo	fromXContentInternal(XContentParser parser)	This method creates a SnapshotInfo from internal x-content.
int	hashCode()
Boolean	includeGlobalState()
List<String>	indices()	Returns indices that were included in this snapshot.
String	reason()	Returns snapshot failure reason; null if the snapshot succeeded.
List<SnapshotShardFailure>	shardFailures()	Returns shard failures; an empty list will be returned if there were no shard failures, or if state() returns null.
SnapshotId	snapshotId()	Returns snapshot id
long	startTime()	Returns time when snapshot started; a value of 0L will be returned if state() returns null.
SnapshotState	state()	Returns snapshot state; null if the state is unknown.
RestStatus	status()	Returns snapshot REST status
int	successfulShards()	Returns total number of shards that were successfully snapshotted; a value of 0 will be returned if state() returns null.
String	toString()
int	totalShards()	Returns total number of shards that were snapshotted; a value of 0 will be returned if state() returns null.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Map<String,Object>	userMetadata()	Returns the custom metadata that was attached to this snapshot at creation time.
Version	version()	Returns the version of elasticsearch that the snapshot was created with.
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.ToXContent

isFragment

Field Detail

CONTEXT_MODE_PARAM

public static final String CONTEXT_MODE_PARAM

See Also:

Constant Field Values

CONTEXT_MODE_SNAPSHOT

public static final String CONTEXT_MODE_SNAPSHOT

See Also:

Constant Field Values

METADATA_FIELD_INTRODUCED

public static final Version METADATA_FIELD_INTRODUCED

SNAPSHOT_INFO_PARSER

public static final ObjectParser<SnapshotInfo.SnapshotInfoBuilder,Void> SNAPSHOT_INFO_PARSER

Constructor Detail

SnapshotInfo

public SnapshotInfo(SnapshotId snapshotId,
                    List<String> indices,
                    SnapshotState state)

SnapshotInfo

public SnapshotInfo(SnapshotId snapshotId,
                    List<String> indices,
                    SnapshotState state,
                    Version version)

SnapshotInfo

public SnapshotInfo(SnapshotId snapshotId,
                    List<String> indices,
                    long startTime,
                    Boolean includeGlobalState,
                    Map<String,Object> userMetadata)

SnapshotInfo

public SnapshotInfo(SnapshotId snapshotId,
                    List<String> indices,
                    long startTime,
                    String reason,
                    long endTime,
                    int totalShards,
                    List<SnapshotShardFailure> shardFailures,
                    Boolean includeGlobalState,
                    Map<String,Object> userMetadata)

SnapshotInfo

public SnapshotInfo(StreamInput in)
             throws IOException

Constructs snapshot information from stream input

Throws:

IOException

Method Detail

basic

public SnapshotInfo basic()

Gets a new SnapshotInfo instance from the given SnapshotInfo with all information stripped out except the snapshot id, state, and indices.

snapshotId

public SnapshotId snapshotId()

Returns snapshot id

Returns:

snapshot id

state

@Nullable
public SnapshotState state()

Returns snapshot state; null if the state is unknown.

Returns:

snapshot state

reason

@Nullable
public String reason()

Returns snapshot failure reason; null if the snapshot succeeded.

Returns:

snapshot failure reason

indices

public List<String> indices()

Returns indices that were included in this snapshot.

Returns:

list of indices

startTime

public long startTime()

Returns time when snapshot started; a value of 0L will be returned if state() returns null.

Returns:

snapshot start time

endTime

public long endTime()

Returns time when snapshot ended; a value of 0L will be returned if the snapshot is still running or if state() returns null.

Returns:

snapshot end time

totalShards

public int totalShards()

Returns total number of shards that were snapshotted; a value of 0 will be returned if state() returns null.

Returns:

number of shards

failedShards

public int failedShards()

Number of failed shards; a value of 0 will be returned if there were no failed shards, or if state() returns null.

Returns:

number of failed shards

successfulShards

public int successfulShards()

Returns total number of shards that were successfully snapshotted; a value of 0 will be returned if state() returns null.

Returns:

number of successful shards

includeGlobalState

public Boolean includeGlobalState()

shardFailures

public List<SnapshotShardFailure> shardFailures()

Returns shard failures; an empty list will be returned if there were no shard failures, or if state() returns null.

Returns:

shard failures

version

@Nullable
public Version version()

Returns the version of elasticsearch that the snapshot was created with. Will only return null if state() returns null or SnapshotState.INCOMPATIBLE.

Returns:

version of elasticsearch that the snapshot was created with

userMetadata

@Nullable
public Map<String,Object> userMetadata()

Returns the custom metadata that was attached to this snapshot at creation time.

Returns:

custom metadata

compareTo

public int compareTo(SnapshotInfo o)

Compares two snapshots by their start time; if the start times are the same, then compares the two snapshots by their snapshot ids.

Specified by:

compareTo in interface Comparable<SnapshotInfo>

toString

public String toString()

Overrides:

toString in class Object

status

public RestStatus status()

Returns snapshot REST status

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContentInternal

public static SnapshotInfo fromXContentInternal(XContentParser parser)
                                         throws IOException

This method creates a SnapshotInfo from internal x-content. It does not handle x-content written with the external version as external x-content is only for display purposes and does not need to be parsed.

Throws:

IOException

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object