org.elasticsearch.repositories.blobstore

Class BlobStoreSnapshot

java.lang.Object

org.elasticsearch.repositories.blobstore.BlobStoreSnapshot

All Implemented Interfaces:

Comparable<Snapshot>, Snapshot

public class BlobStoreSnapshot
extends Object
implements Snapshot

Immutable snapshot description for BlobStoreRepository

Stored in the the root of the repository, see BlobStoreRepository for more information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlobStoreSnapshot.Builder BlobStoreSnapshot builder

Method Summary

Modifier and Type	Method and Description
static BlobStoreSnapshot.Builder	builder() Creates new BlobStoreSnapshot builder
int	compareTo(Snapshot o) Compares two snapshots by their start time
long	endTime() Returns time when snapshot ended Can be 0L if snapshot is still running
com.google.common.collect.ImmutableList<String>	indices() Returns indices that were included into this snapshot
String	name() Returns snapshot name
String	reason() Returns reason for complete snapshot failure
com.google.common.collect.ImmutableList<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
Version	version() Returns version of Elasticsearch that was used to create this snapshot

Methods inherited from class java.lang.Object

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

Method Detail

name

public String name()

Returns snapshot name

Specified by:

name in interface Snapshot

Returns:

snapshot name

state

public SnapshotState state()

Returns current snapshot state

Specified by:

state in interface Snapshot

Returns:

snapshot state

reason

public String reason()

Returns reason for complete snapshot failure

Specified by:

reason in interface Snapshot

Returns:

snapshot failure reason

version

public Version version()

Returns version of Elasticsearch that was used to create this snapshot

Specified by:

version in interface Snapshot

Returns:

Elasticsearch version

indices

public com.google.common.collect.ImmutableList<String> indices()

Returns indices that were included into this snapshot

Specified by:

indices in interface Snapshot

Returns:

list of indices

startTime

public long startTime()

Returns time when snapshot started

Specified by:

startTime in interface Snapshot

Returns:

snapshot start time

endTime

public long endTime()

Returns time when snapshot ended

Can be 0L if snapshot is still running

Specified by:

endTime in interface Snapshot

Returns:

snapshot end time

totalShard

public int totalShard()

Returns total number of shards that were snapshotted

Specified by:

totalShard in interface Snapshot

Returns:

number of shards

successfulShards

public int successfulShards()

Returns total number of shards that were successfully snapshotted

Specified by:

successfulShards in interface Snapshot

Returns:

number of successful shards

shardFailures

public com.google.common.collect.ImmutableList<SnapshotShardFailure> shardFailures()

Returns shard failures

Specified by:

shardFailures in interface Snapshot

Returns:

shard failures

builder

public static BlobStoreSnapshot.Builder builder()

Creates new BlobStoreSnapshot builder

Returns:

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;