Module org.elasticsearch.server

Package org.elasticsearch.cluster

Record Class SnapshotsInProgress.ShardSnapshotStatus

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.SnapshotsInProgress.ShardSnapshotStatus

Record Components:

nodeId - node snapshotting the shard

state - the current phase of the snapshot

generation - shard generation ID identifying a particular snapshot of a shard

reason - what initiated the shard snapshot

shardSnapshotResult - only set if the snapshot has been successful, contains information for the shard finalization phase

All Implemented Interfaces:

Writeable

Enclosing class:

SnapshotsInProgress

public static record SnapshotsInProgress.ShardSnapshotStatus(String nodeId, SnapshotsInProgress.ShardState state, ShardGeneration generation, String reason, ShardSnapshotResult shardSnapshotResult)
extends Record
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 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.
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.

Constructor Summary

Constructors

Constructor	Description
ShardSnapshotStatus(String nodeId, SnapshotsInProgress.ShardState state, ShardGeneration generation)
ShardSnapshotStatus(String nodeId, SnapshotsInProgress.ShardState state, ShardGeneration generation, String reason)
ShardSnapshotStatus(String nodeId, SnapshotsInProgress.ShardState state, ShardGeneration generation, String reason, ShardSnapshotResult shardSnapshotResult)	Creates an instance of a ShardSnapshotStatus record class.
ShardSnapshotStatus(String nodeId, ShardGeneration generation)	Initializes status with state SnapshotsInProgress.ShardState.INIT.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ShardGeneration	generation()	Returns the value of the generation record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	isActive()	Checks if this shard snapshot is actively executing.
String	nodeId()	Returns the value of the nodeId record component.
static SnapshotsInProgress.ShardSnapshotStatus	readFrom(StreamInput in)
String	reason()	Returns the value of the reason record component.
ShardSnapshotResult	shardSnapshotResult()	Returns the value of the shardSnapshotResult record component.
SnapshotsInProgress.ShardState	state()	Returns the value of the state record component.
static SnapshotsInProgress.ShardSnapshotStatus	success(String nodeId, ShardSnapshotResult shardSnapshotResult)
final String	toString()	Returns a string representation of this record class.
SnapshotsInProgress.ShardSnapshotStatus	withUpdatedGeneration(ShardGeneration 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,
 ShardGeneration generation)

Initializes status with state SnapshotsInProgress.ShardState.INIT.

ShardSnapshotStatus

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

ShardSnapshotStatus

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

ShardSnapshotStatus

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

Creates an instance of a ShardSnapshotStatus record class.

Parameters:

nodeId - the value for the nodeId record component

state - the value for the state record component

generation - the value for the generation record component

reason - the value for the reason record component

shardSnapshotResult - the value for the shardSnapshotResult record component

Method Details

success

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

readFrom

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

Throws:

IOException

withUpdatedGeneration

public SnapshotsInProgress.ShardSnapshotStatus withUpdatedGeneration(ShardGeneration newGeneration)

shardSnapshotResult

@Nullable
public ShardSnapshotResult shardSnapshotResult()

Returns the value of the shardSnapshotResult record component.

Returns:

the value of the shardSnapshotResult record component

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 or SnapshotsInProgress.ShardState.PAUSED_FOR_NODE_REMOVAL.

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

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

nodeId

@Nullable
public String nodeId()

Returns the value of the nodeId record component.

Returns:

the value of the nodeId record component

state

public SnapshotsInProgress.ShardState state()

Returns the value of the state record component.

Returns:

the value of the state record component

generation

@Nullable
public ShardGeneration generation()

Returns the value of the generation record component.

Returns:

the value of the generation record component

reason

@Nullable
public String reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component