org.apache.flink.runtime.checkpoint

Class PendingCheckpoint

java.lang.Object

org.apache.flink.runtime.checkpoint.PendingCheckpoint

public class PendingCheckpoint
extends Object

A pending checkpoint is a checkpoint that has been started, but has not been acknowledged by all tasks that need to acknowledge it. Once all tasks have acknowledged it, it becomes a CompletedCheckpoint.

Note that the pending checkpoint, as well as the successful checkpoint keep the state handles always as serialized values, never as actual values.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PendingCheckpoint.TaskAcknowledgeResult Result of the acknowledgedTasks method.

Constructor Summary

Constructors

Constructor and Description
PendingCheckpoint(JobID jobId, long checkpointId, long checkpointTimestamp, Map<ExecutionAttemptID,ExecutionVertex> verticesToConfirm, CheckpointProperties props, CheckpointStorageLocation targetLocation, Executor executor)

Method Summary

Modifier and Type	Method and Description
void	abortDeclined()
void	abortError(Throwable cause) Aborts the pending checkpoint due to an error.
void	abortExpired() Aborts a checkpoint because it expired (took too long).
void	abortSubsumed() Aborts the pending checkpoint because a newer completed checkpoint subsumed it.
PendingCheckpoint.TaskAcknowledgeResult	acknowledgeTask(ExecutionAttemptID executionAttemptId, TaskStateSnapshot operatorSubtaskStates, CheckpointMetrics metrics) Acknowledges the task with the given execution attempt id and the given subtask state.
void	addMasterState(MasterState state) Adds a master state (state generated on the checkpoint coordinator) to the pending checkpoint.
boolean	canBeSubsumed() Checks whether this checkpoint can be subsumed or whether it should always continue, regardless of newer checkpoints in progress.
CompletedCheckpoint	finalizeCheckpoint()
long	getCheckpointId()
long	getCheckpointTimestamp()
CompletableFuture<CompletedCheckpoint>	getCompletionFuture() Returns the completion future.
JobID	getJobId()
int	getNumberOfAcknowledgedTasks()
int	getNumberOfNonAcknowledgedTasks()
Map<OperatorID,OperatorState>	getOperatorStates()
boolean	isAcknowledgedBy(ExecutionAttemptID executionAttemptId)
boolean	isDiscarded()
boolean	isFullyAcknowledged()
boolean	setCancellerHandle(ScheduledFuture<?> cancellerHandle) Sets the handle for the canceller to this pending checkpoint.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PendingCheckpoint

public PendingCheckpoint(JobID jobId,
                         long checkpointId,
                         long checkpointTimestamp,
                         Map<ExecutionAttemptID,ExecutionVertex> verticesToConfirm,
                         CheckpointProperties props,
                         CheckpointStorageLocation targetLocation,
                         Executor executor)

Method Detail

getJobId

public JobID getJobId()

getCheckpointId

public long getCheckpointId()

getCheckpointTimestamp

public long getCheckpointTimestamp()

getNumberOfNonAcknowledgedTasks

public int getNumberOfNonAcknowledgedTasks()

getNumberOfAcknowledgedTasks

public int getNumberOfAcknowledgedTasks()

getOperatorStates

public Map<OperatorID,OperatorState> getOperatorStates()

isFullyAcknowledged

public boolean isFullyAcknowledged()

isAcknowledgedBy

public boolean isAcknowledgedBy(ExecutionAttemptID executionAttemptId)

isDiscarded

public boolean isDiscarded()

canBeSubsumed

public boolean canBeSubsumed()

Checks whether this checkpoint can be subsumed or whether it should always continue, regardless of newer checkpoints in progress.

Returns:

True if the checkpoint can be subsumed, false otherwise.

setCancellerHandle

public boolean setCancellerHandle(ScheduledFuture<?> cancellerHandle)

Sets the handle for the canceller to this pending checkpoint. This method fails with an exception if a handle has already been set.

Returns:

true, if the handle was set, false, if the checkpoint is already disposed;

getCompletionFuture

public CompletableFuture<CompletedCheckpoint> getCompletionFuture()

Returns the completion future.

Returns:

A future to the completed checkpoint

finalizeCheckpoint

public CompletedCheckpoint finalizeCheckpoint()
                                       throws IOException

Throws:

IOException

acknowledgeTask

public PendingCheckpoint.TaskAcknowledgeResult acknowledgeTask(ExecutionAttemptID executionAttemptId,
                                                               TaskStateSnapshot operatorSubtaskStates,
                                                               CheckpointMetrics metrics)

Acknowledges the task with the given execution attempt id and the given subtask state.

Parameters:

executionAttemptId - of the acknowledged task

operatorSubtaskStates - of the acknowledged task

metrics - Checkpoint metrics for the stats

Returns:

TaskAcknowledgeResult of the operation

addMasterState

public void addMasterState(MasterState state)

Adds a master state (state generated on the checkpoint coordinator) to the pending checkpoint.

Parameters:

state - The state to add

abortExpired

public void abortExpired()

Aborts a checkpoint because it expired (took too long).

abortSubsumed

public void abortSubsumed()

Aborts the pending checkpoint because a newer completed checkpoint subsumed it.

abortDeclined

public void abortDeclined()

abortError

public void abortError(@Nonnull
                       Throwable cause)

Aborts the pending checkpoint due to an error.

Parameters:

cause - The error's exception.

toString

public String toString()

Overrides:

toString in class Object