org.elasticsearch.snapshots

Class SnapshotInfo

java.lang.Object

org.elasticsearch.snapshots.SnapshotInfo

All Implemented Interfaces:

Streamable, ToXContent

public class SnapshotInfo
extends Object
implements ToXContent, Streamable

Information about snapshot

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SnapshotInfo(Snapshot snapshot) Creates a new snapshot information from a Snapshot

Method Summary

Methods

Modifier and Type	Method and Description
long	endTime() Returns time when snapshot ended
int	failedShards() Number of failed shards
List<String>	indices() Returns indices that were included into this snapshot
String	name() Returns snapshot name
void	readFrom(StreamInput in)
static SnapshotInfo	readOptionalSnapshotInfo(StreamInput in) Reads optional snapshot information from stream input
static SnapshotInfo	readSnapshotInfo(StreamInput in) Reads snapshot information from stream input
String	reason() Returns snapshot failure reason
List<SnapshotShardFailure>	shardFailures() Returns shard failures
long	startTime() Returns time when snapshot started
SnapshotState	state() Returns snapshot state
RestStatus	status() Returns snapshot REST status
int	successfulShards() Returns total number of shards that were successfully snapshotted
int	totalShards() Returns total number of shards that were snapshotted
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Version	version() Returns the version of elasticsearch that the snapshot was created with
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SnapshotInfo

public SnapshotInfo(Snapshot snapshot)

Creates a new snapshot information from a Snapshot

Parameters:

snapshot - snapshot information returned by repository

Method Detail

name

public String name()

Returns snapshot name

Returns:

snapshot name

state

public SnapshotState state()

Returns snapshot state

Returns:

snapshot state

reason

public String reason()

Returns snapshot failure reason

Returns:

snapshot failure reason

indices

public List<String> indices()

Returns indices that were included into this snapshot

Returns:

list of indices

startTime

public long startTime()

Returns time when snapshot started

Returns:

snapshot start time

endTime

public long endTime()

Returns time when snapshot ended

Can be 0L if snapshot is still running

Returns:

snapshot end time

totalShards

public int totalShards()

Returns total number of shards that were snapshotted

Returns:

number of shards

failedShards

public int failedShards()

Number of failed shards

Returns:

number of failed shards

successfulShards

public int successfulShards()

Returns total number of shards that were successfully snapshotted

Returns:

number of successful shards

shardFailures

public List<SnapshotShardFailure> shardFailures()

Returns shard failures

Returns:

shard failures

version

public Version version()

Returns the version of elasticsearch that the snapshot was created with

Returns:

version of elasticsearch that the snapshot was created with

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

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

readSnapshotInfo

public static SnapshotInfo readSnapshotInfo(StreamInput in)
                                     throws IOException

Reads snapshot information from stream input

Parameters:

in - stream input

Returns:

deserialized snapshot info

Throws:

IOException

readOptionalSnapshotInfo

public static SnapshotInfo readOptionalSnapshotInfo(StreamInput in)
                                             throws IOException

Reads optional snapshot information from stream input

Parameters:

in - stream input

Returns:

deserialized snapshot info or null

Throws:

IOException