Package org.elasticsearch.cluster

Class SnapshotsInProgress.ShardSnapshotStatus

java.lang.Object

org.elasticsearch.cluster.SnapshotsInProgress.ShardSnapshotStatus

All Implemented Interfaces:

Writeable

Enclosing class:

SnapshotsInProgress

public static class SnapshotsInProgress.ShardSnapshotStatus
extends Object
implements Writeable

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static SnapshotsInProgress.ShardSnapshotStatus	MISSING	Shard snapshot status for shards that could not be snapshotted because their index was deleted from before the shard snapshot started.
static SnapshotsInProgress.ShardSnapshotStatus	UNASSIGNED_QUEUED	Shard snapshot status for shards that are waiting for another operation to finish before they can be assigned to a node.

Constructor Summary

Constructors

Constructor	Description
ShardSnapshotStatus(String nodeId, String generation)
ShardSnapshotStatus(String nodeId, SnapshotsInProgress.ShardState state, String generation)
ShardSnapshotStatus(String nodeId, SnapshotsInProgress.ShardState state, String reason, String generation)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	generation()
int	hashCode()
boolean	isActive()	Checks if this shard snapshot is actively executing.
String	nodeId()
static SnapshotsInProgress.ShardSnapshotStatus	readFrom(StreamInput in)
String	reason()
ShardSnapshotResult	shardSnapshotResult()
SnapshotsInProgress.ShardState	state()
static SnapshotsInProgress.ShardSnapshotStatus	success(String nodeId, ShardSnapshotResult shardSnapshotResult)
String	toString()
SnapshotsInProgress.ShardSnapshotStatus	withUpdatedGeneration(String newGeneration)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Field Details

UNASSIGNED_QUEUED

public static final SnapshotsInProgress.ShardSnapshotStatus UNASSIGNED_QUEUED

Shard snapshot status for shards that are waiting for another operation to finish before they can be assigned to a node.

MISSING

public static final SnapshotsInProgress.ShardSnapshotStatus MISSING

Shard snapshot status for shards that could not be snapshotted because their index was deleted from before the shard snapshot started.

Constructor Details

ShardSnapshotStatus

public ShardSnapshotStatus(String nodeId,
 String generation)

ShardSnapshotStatus

public ShardSnapshotStatus(@Nullable
 String nodeId,
 SnapshotsInProgress.ShardState state,
 @Nullable
 String generation)

ShardSnapshotStatus

public ShardSnapshotStatus(@Nullable
 String nodeId,
 SnapshotsInProgress.ShardState state,
 String reason,
 @Nullable
 String generation)

Method Details

success

public static SnapshotsInProgress.ShardSnapshotStatus success(String nodeId,
 ShardSnapshotResult shardSnapshotResult)

readFrom

public static SnapshotsInProgress.ShardSnapshotStatus readFrom(StreamInput in)
                                                        throws IOException

Throws:

IOException

state

public SnapshotsInProgress.ShardState state()

nodeId

@Nullable
public String nodeId()

generation

@Nullable
public String generation()

reason

public String reason()

withUpdatedGeneration

public SnapshotsInProgress.ShardSnapshotStatus withUpdatedGeneration(String newGeneration)

shardSnapshotResult

@Nullable
public ShardSnapshotResult shardSnapshotResult()

isActive

public boolean isActive()

Checks if this shard snapshot is actively executing. A shard is defined as actively executing if it either is in a state that may write to the repository (SnapshotsInProgress.ShardState.INIT or SnapshotsInProgress.ShardState.ABORTED) or about to write to it in state SnapshotsInProgress.ShardState.WAITING.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object