Module org.elasticsearch.server

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 enum	IndexShardSnapshotStatus.Stage	Snapshot stage

Method Summary

Modifier and Type	Method	Description
void	abortIfNotCompleted(String failure)
void	addProcessedFile(long size)	Increments number of processed files
void	addProcessedFiles(int count, long totalSize)
IndexShardSnapshotStatus.Copy	asCopy()	Returns a copy of the current IndexShardSnapshotStatus.
void	ensureNotAborted()
ShardGeneration	generation()
ShardSnapshotResult	getShardSnapshotResult()
boolean	isAborted()
void	moveToDone(long endTime, ShardSnapshotResult shardSnapshotResult)
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, ShardGeneration generation)
static IndexShardSnapshotStatus	newFailed(String failure)
static IndexShardSnapshotStatus	newInitializing(ShardGeneration generation)

Methods inherited from class java.lang.Object

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

Method Details

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,
 ShardSnapshotResult shardSnapshotResult)

abortIfNotCompleted

public void abortIfNotCompleted(String failure)

moveToFailed

public void moveToFailed(long endTime,
 String failure)

generation

public ShardGeneration generation()

getShardSnapshotResult

public ShardSnapshotResult getShardSnapshotResult()

isAborted

public boolean isAborted()

ensureNotAborted

public void ensureNotAborted()

addProcessedFile

public void addProcessedFile(long size)

Increments number of processed files

addProcessedFiles

public void addProcessedFiles(int count,
 long totalSize)

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(ShardGeneration generation)

newFailed

public static IndexShardSnapshotStatus newFailed(String failure)

newDone

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