org.apache.flink.api.common.state

Interface InternalCheckpointListener

All Superinterfaces:

CheckpointListener

All Known Implementing Classes:

AbstractKeyedStateBackend, ChangelogKeyedStateBackend, HeapKeyedStateBackend, RocksDBKeyedStateBackend

@Internal
public interface InternalCheckpointListener
extends CheckpointListener

The internal checkpoint listener add another notifyCheckpointSubsumed(long) interface for internal usage.

Method Summary

Modifier and Type	Method and Description
void	notifyCheckpointSubsumed(long checkpointId) This method is called as a notification once a distributed checkpoint has been subsumed.

Methods inherited from interface org.apache.flink.api.common.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

Method Detail

notifyCheckpointSubsumed

void notifyCheckpointSubsumed(long checkpointId)
                       throws Exception

This method is called as a notification once a distributed checkpoint has been subsumed.

These notifications are "best effort", meaning they can sometimes be skipped.

This method is very rarely necessary to implement. The "best effort" guarantee, together with the fact that this method should not result in discarding any data (per the "Checkpoint Subsuming Contract") means it is mainly useful for earlier cleanups of auxiliary resources.

Parameters:

checkpointId - The ID of the checkpoint that has been subsumed.

Throws:

Exception - This method can propagate exceptions, which leads to a failure/recovery for the task or job.