org.apache.flink.runtime.checkpoint

Class EmbeddedCompletedCheckpointStore

java.lang.Object

org.apache.flink.runtime.checkpoint.EmbeddedCompletedCheckpointStore

All Implemented Interfaces:

CompletedCheckpointStore

public class EmbeddedCompletedCheckpointStore
extends Object
implements CompletedCheckpointStore

An embedded in-memory checkpoint store, which supports shutdown and suspend.

Field Summary

Fields inherited from interface org.apache.flink.runtime.checkpoint.CompletedCheckpointStore

LOG

Constructor Summary

Constructors

Constructor and Description
EmbeddedCompletedCheckpointStore()
EmbeddedCompletedCheckpointStore(int maxRetainedCheckpoints)
EmbeddedCompletedCheckpointStore(int maxRetainedCheckpoints, Collection<CompletedCheckpoint> initialCheckpoints)

Method Summary

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.
int	getMaxNumberOfRetainedCheckpoints() Returns the max number of retained checkpoints.
int	getNumberOfRetainedCheckpoints() Returns the current number of retained checkpoints.
Optional<JobStatus>	getShutdownStatus()
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.checkpoint.CompletedCheckpointStore

getLatestCheckpoint, getLatestCheckpointId

Constructor Detail

EmbeddedCompletedCheckpointStore

public EmbeddedCompletedCheckpointStore()

EmbeddedCompletedCheckpointStore

public EmbeddedCompletedCheckpointStore(int maxRetainedCheckpoints)

EmbeddedCompletedCheckpointStore

public EmbeddedCompletedCheckpointStore(int maxRetainedCheckpoints,
                                        Collection<CompletedCheckpoint> initialCheckpoints)

Method Detail

addCheckpoint

public void addCheckpoint(CompletedCheckpoint checkpoint,
                          CheckpointsCleaner checkpointsCleaner,
                          Runnable postCleanup)
                   throws Exception

Description copied from interface: CompletedCheckpointStore

Adds a 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.

Specified by:

addCheckpoint in interface CompletedCheckpointStore

Throws:

Exception

shutdown

public void shutdown(JobStatus jobStatus,
                     CheckpointsCleaner checkpointsCleaner)
              throws Exception

Description copied from interface: CompletedCheckpointStore

Shuts down the store.

The job status is forwarded and used to decide whether state should actually be discarded or kept.

Specified by:

shutdown in interface CompletedCheckpointStore

Parameters:

jobStatus - Job state on shut down

checkpointsCleaner - that will cleanup completed checkpoints if needed

Throws:

Exception

getAllCheckpoints

public List<CompletedCheckpoint> getAllCheckpoints()

Description copied from interface: CompletedCheckpointStore

Returns all CompletedCheckpoint instances.

Returns an empty list if no checkpoint has been added yet.

Specified by:

getAllCheckpoints in interface CompletedCheckpointStore

getNumberOfRetainedCheckpoints

public int getNumberOfRetainedCheckpoints()

Description copied from interface: CompletedCheckpointStore

Returns the current number of retained checkpoints.

Specified by:

getNumberOfRetainedCheckpoints in interface CompletedCheckpointStore

getMaxNumberOfRetainedCheckpoints

public int getMaxNumberOfRetainedCheckpoints()

Description copied from interface: CompletedCheckpointStore

Returns the max number of retained checkpoints.

Specified by:

getMaxNumberOfRetainedCheckpoints in interface CompletedCheckpointStore

requiresExternalizedCheckpoints

public boolean requiresExternalizedCheckpoints()

Description copied from interface: CompletedCheckpointStore

This method returns whether the completed checkpoint store requires checkpoints to be externalized. Externalized checkpoints have their meta data persisted, which the checkpoint store can exploit (for example by simply pointing the persisted metadata).

Specified by:

requiresExternalizedCheckpoints in interface CompletedCheckpointStore

Returns:

True, if the store requires that checkpoints are externalized before being added, false if the store stores the metadata itself.

getShutdownStatus

@VisibleForTesting
public Optional<JobStatus> getShutdownStatus()