org.elasticsearch.snapshots

Class Snapshot

java.lang.Object

org.elasticsearch.snapshots.Snapshot

All Implemented Interfaces:

Comparable<Snapshot>, FromXContentBuilder<Snapshot>, ToXContent

public class Snapshot
extends Object
implements Comparable<Snapshot>, ToXContent, FromXContentBuilder<Snapshot>

Represent 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

Modifier and Type	Field and Description
static Snapshot	PROTO

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Snapshot(String name, List<String> indices, long startTime)
Snapshot(String name, List<String> indices, long startTime, String reason, long endTime, int totalShard, List<SnapshotShardFailure> shardFailures)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Snapshot o) Compares two snapshots by their start time
long	endTime() Returns time when snapshot ended
boolean	equals(Object o)
static Snapshot	fromXContent(XContentParser parser)
Snapshot	fromXContent(XContentParser parser, ParseFieldMatcher parseFieldMatcher) Parses an object with the type T from parser
int	hashCode()
List<String>	indices() Returns indices that were included into this snapshot
String	name() Returns snapshot name
String	reason() Returns reason for complete snapshot failure
List<SnapshotShardFailure>	shardFailures() Returns shard failures
long	startTime() Returns time when snapshot started
SnapshotState	state() Returns current snapshot state
int	successfulShards() Returns total number of shards that were successfully snapshotted
int	totalShard() Returns total number of shards that were snapshotted
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Version	version() Returns version of Elasticsearch that was used to create this snapshot

Methods inherited from class java.lang.Object

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

Field Detail

PROTO

public static final Snapshot PROTO

Constructor Detail

Snapshot

public Snapshot(String name,
        List<String> indices,
        long startTime)

Snapshot

public Snapshot(String name,
        List<String> indices,
        long startTime,
        String reason,
        long endTime,
        int totalShard,
        List<SnapshotShardFailure> shardFailures)

Method Detail

name

public String name()

Returns snapshot name

Returns:

snapshot name

state

public SnapshotState state()

Returns current snapshot state

Returns:

snapshot state

reason

public String reason()

Returns reason for complete snapshot failure

Returns:

snapshot failure reason

version

public Version version()

Returns version of Elasticsearch that was used to create this snapshot

Returns:

Elasticsearch version

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

totalShard

public int totalShard()

Returns total number of shards that were snapshotted

Returns:

number of 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

compareTo

public int compareTo(Snapshot o)

Compares two snapshots by their start time

Specified by:

compareTo in interface Comparable<Snapshot>

Parameters:

o - other snapshot

Returns:

the value 0 if snapshots were created at the same time; a value less than 0 if this snapshot was created before snapshot o; and a value greater than 0 if this snapshot was created after snapshot o;

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

fromXContent

public Snapshot fromXContent(XContentParser parser,
                    ParseFieldMatcher parseFieldMatcher)
                      throws IOException

Description copied from interface: FromXContentBuilder

Parses an object with the type T from parser

Specified by:

fromXContent in interface FromXContentBuilder<Snapshot>

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static Snapshot fromXContent(XContentParser parser)
                             throws IOException

Throws:

IOException