Package org.elasticsearch.index.snapshots

Class IndexShardSnapshotStatus

java.lang.Object

org.elasticsearch.index.snapshots.IndexShardSnapshotStatus

public class IndexShardSnapshotStatus
extends Object

Represent shard snapshot status

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexShardSnapshotStatus.Copy	Returns an immutable state of IndexShardSnapshotStatus at a given point in time.
static class	IndexShardSnapshotStatus.Stage	Snapshot stage

Method Summary

Modifier and Type	Method	Description
void	abortIfNotCompleted(String failure)
void	addProcessedFile(long size)	Increments number of processed files
IndexShardSnapshotStatus.Copy	asCopy()	Returns a copy of the current IndexShardSnapshotStatus.
boolean	isAborted()
void	moveToDone(long endTime)
void	moveToFailed(long endTime, String failure)
IndexShardSnapshotStatus.Copy	moveToFinalize(long indexVersion)
IndexShardSnapshotStatus.Copy	moveToStarted(long startTime, int incrementalFileCount, int totalFileCount, long incrementalSize, long totalSize)
static IndexShardSnapshotStatus	newDone(long startTime, long totalTime, int incrementalFileCount, int fileCount, long incrementalSize, long size)
static IndexShardSnapshotStatus	newFailed(String failure)
static IndexShardSnapshotStatus	newInitializing()

Methods inherited from class java.lang.Object

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

Method Detail

moveToStarted

public IndexShardSnapshotStatus.Copy moveToStarted(long startTime,
                                                   int incrementalFileCount,
                                                   int totalFileCount,
                                                   long incrementalSize,
                                                   long totalSize)

moveToFinalize

public IndexShardSnapshotStatus.Copy moveToFinalize(long indexVersion)

moveToDone

public void moveToDone(long endTime)

abortIfNotCompleted

public void abortIfNotCompleted(String failure)

moveToFailed

public void moveToFailed(long endTime,
                         String failure)

isAborted

public boolean isAborted()

addProcessedFile

public void addProcessedFile(long size)

Increments number of processed files

asCopy

public IndexShardSnapshotStatus.Copy asCopy()

Returns a copy of the current IndexShardSnapshotStatus. This method is intended to be used when a coherent state of IndexShardSnapshotStatus is needed.

Returns:

a IndexShardSnapshotStatus.Copy

newInitializing

public static IndexShardSnapshotStatus newInitializing()

newFailed

public static IndexShardSnapshotStatus newFailed(String failure)

newDone

public static IndexShardSnapshotStatus newDone(long startTime,
                                               long totalTime,
                                               int incrementalFileCount,
                                               int fileCount,
                                               long incrementalSize,
                                               long size)