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 and Description
static class	IndexShardSnapshotStatus.Stage Snapshot stage

Constructor Summary

Constructors

Constructor and Description
IndexShardSnapshotStatus()

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Marks snapshot as aborted
boolean	aborted() Returns true if snapshot process was aborted
void	addProcessedFile(long size) Increments number of processed files
String	failure() Returns the reason for the failure if the snapshot is in the IndexShardSnapshotStatus.Stage.FAILURE state
void	failure(String failure) Sets the reason for the failure if the snapshot is in the IndexShardSnapshotStatus.Stage.FAILURE state
void	files(int numberOfFiles, long totalSize) Sets files stats
long	indexVersion() Returns index version
void	indexVersion(long indexVersion) Sets index version
int	numberOfFiles() Number of files
int	processedFiles() Number of processed files
void	processedFiles(int numberOfFiles, long totalSize) Sets processed files stats
long	processedSize() Size of processed files
IndexShardSnapshotStatus.Stage	stage() Returns current snapshot stage
long	startTime() Returns snapshot start time
void	startTime(long startTime) Sets snapshot start time
long	time() Returns snapshot processing time
void	time(long time) Sets snapshot processing time
long	totalSize() Total snapshot size
void	updateStage(IndexShardSnapshotStatus.Stage stage) Sets new snapshot stage

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexShardSnapshotStatus

public IndexShardSnapshotStatus()

Method Detail

stage

public IndexShardSnapshotStatus.Stage stage()

Returns current snapshot stage

Returns:

current snapshot stage

updateStage

public void updateStage(IndexShardSnapshotStatus.Stage stage)

Sets new snapshot stage

Parameters:

stage - new snapshot stage

startTime

public long startTime()

Returns snapshot start time

Returns:

snapshot start time

startTime

public void startTime(long startTime)

Sets snapshot start time

Parameters:

startTime - snapshot start time

time

public long time()

Returns snapshot processing time

Returns:

processing time

time

public void time(long time)

Sets snapshot processing time

Parameters:

time - snapshot processing time

aborted

public boolean aborted()

Returns true if snapshot process was aborted

Returns:

true if snapshot process was aborted

abort

public void abort()

Marks snapshot as aborted

files

public void files(int numberOfFiles,
         long totalSize)

Sets files stats

Parameters:

numberOfFiles - number of files in this snapshot

totalSize - total size of files in this snapshot

processedFiles

public void processedFiles(int numberOfFiles,
                  long totalSize)

Sets processed files stats

Parameters:

numberOfFiles - number of files in this snapshot

totalSize - total size of files in this snapshot

addProcessedFile

public void addProcessedFile(long size)

Increments number of processed files

numberOfFiles

public int numberOfFiles()

Number of files

Returns:

number of files

totalSize

public long totalSize()

Total snapshot size

Returns:

snapshot size

processedFiles

public int processedFiles()

Number of processed files

Returns:

number of processed files

processedSize

public long processedSize()

Size of processed files

Returns:

size of processed files

indexVersion

public void indexVersion(long indexVersion)

Sets index version

Parameters:

indexVersion - index version

indexVersion

public long indexVersion()

Returns index version

Returns:

index version

failure

public void failure(String failure)

Sets the reason for the failure if the snapshot is in the IndexShardSnapshotStatus.Stage.FAILURE state

failure

public String failure()

Returns the reason for the failure if the snapshot is in the IndexShardSnapshotStatus.Stage.FAILURE state