public interface CompletedCheckpointStore
CompletedCheckpoint
instances.Modifier and Type | Field and Description |
---|---|
static org.slf4j.Logger |
LOG |
Modifier and Type | Method and Description |
---|---|
void |
addCheckpoint(CompletedCheckpoint checkpoint,
CheckpointsCleaner checkpointsCleaner,
Runnable postCleanup)
Adds a
CompletedCheckpoint instance to the list of completed checkpoints. |
List<CompletedCheckpoint> |
getAllCheckpoints()
Returns all
CompletedCheckpoint instances. |
default CompletedCheckpoint |
getLatestCheckpoint()
Returns the latest
CompletedCheckpoint instance or null if none was
added. |
default long |
getLatestCheckpointId()
Returns the id of the latest completed checkpoints.
|
int |
getMaxNumberOfRetainedCheckpoints()
Returns the max number of retained checkpoints.
|
int |
getNumberOfRetainedCheckpoints()
Returns the current number of retained checkpoints.
|
boolean |
requiresExternalizedCheckpoints()
This method returns whether the completed checkpoint store requires checkpoints to be
externalized.
|
void |
shutdown(JobStatus jobStatus,
CheckpointsCleaner checkpointsCleaner)
Shuts down the store.
|
void addCheckpoint(CompletedCheckpoint checkpoint, CheckpointsCleaner checkpointsCleaner, Runnable postCleanup) throws Exception
CompletedCheckpoint
instance to the list of completed checkpoints.
Only a bounded number of checkpoints is kept. When exceeding the maximum number of retained checkpoints, the oldest one will be discarded.
Exception
default CompletedCheckpoint getLatestCheckpoint() throws Exception
CompletedCheckpoint
instance or null
if none was
added.Exception
default long getLatestCheckpointId()
void shutdown(JobStatus jobStatus, CheckpointsCleaner checkpointsCleaner) throws Exception
The job status is forwarded and used to decide whether state should actually be discarded or kept.
jobStatus
- Job state on shut downcheckpointsCleaner
- that will cleanup completed checkpoints if neededException
List<CompletedCheckpoint> getAllCheckpoints() throws Exception
CompletedCheckpoint
instances.
Returns an empty list if no checkpoint has been added yet.
Exception
int getNumberOfRetainedCheckpoints()
int getMaxNumberOfRetainedCheckpoints()
boolean requiresExternalizedCheckpoints()
Copyright © 2014–2023 The Apache Software Foundation. All rights reserved.