org.apache.flink.runtime.state

Interface CheckpointListener

All Known Subinterfaces:

MultipleInputStreamOperator<OUT>, OneInputStreamOperator<IN,OUT>, OperatorCoordinator, OperatorCoordinatorCheckpointContext, StreamOperator<OUT>, TaskStateManager, TwoInputStreamOperator<IN1,IN2,OUT>

All Known Implementing Classes:

AbstractKeyedStateBackend, AbstractMapBundleOperator, AbstractProcessStreamOperator, AbstractPythonFunctionOperator, AbstractPythonScalarFunctionOperator, AbstractPythonTableFunctionOperator, AbstractRowDataPythonScalarFunctionOperator, AbstractRowPythonScalarFunctionOperator, AbstractStatelessFunctionOperator, AbstractStreamingJoinOperator, AbstractStreamOperator, AbstractStreamOperatorV2, AbstractUdfStreamOperator, AcknowledgeOnCheckpoint, AggregateWindowOperator, ArrowPythonScalarFunctionOperator, AsyncWaitOperator, BaseTwoInputStreamOperatorWithStateRetention, BroadcastStateBootstrapOperator, BucketingSink, BufferDataOverWindowOperator, CassandraRowWriteAheadSink, CassandraTupleWriteAheadSink, CepOperator, CoBroadcastWithKeyedOperator, CoBroadcastWithNonKeyedOperator, CollectSinkFunction, CollectSinkOperator, CollectSinkOperatorCoordinator, ContinuousFileReaderOperator, CoProcessOperator, CoStreamFlatMap, CoStreamMap, EvictingWindowOperator, FailureMapper, FiniteTestSource, FlinkKafkaConsumer, FlinkKafkaConsumer010, FlinkKafkaConsumer011, FlinkKafkaConsumerBase, FlinkKafkaProducer, FlinkKafkaProducer011, FlinkKafkaShuffleConsumer, FlinkKafkaShuffleProducer, GenericWriteAheadSink, HashJoinOperator, HeapKeyedStateBackend, IntervalJoinOperator, KeyedCoProcessOperator, KeyedCoProcessOperatorWithWatermarkDelay, KeyedMapBundleOperator, KeyedProcessOperator, KeyedStateBootstrapOperator, LegacyKeyedCoProcessOperator, LegacyKeyedProcessOperator, LimitOperator, MapBundleOperator, MessageAcknowledgingSourceBase, MultipleIdsMessageAcknowledgingSourceBase, NonBufferOverWindowOperator, OperatorCoordinatorHolder, ProcessOperator, ProcTimeMiniBatchAssignerOperator, ProcTimeSortOperator, PubSubSource, PythonScalarFunctionOperator, PythonTableFunctionOperator, QueryableAppendingStateOperator, QueryableValueStateOperator, RankOperator, RecreateOnResetOperatorCoordinator, RMQSource, RocksDBKeyedStateBackend, RocksDBSnapshotStrategyBase, RocksFullSnapshotStrategy, RocksIncrementalSnapshotStrategy, RowDataArrowPythonScalarFunctionOperator, RowDataPythonScalarFunctionOperator, RowDataPythonTableFunctionOperator, RowTimeMiniBatchAssginerOperator, RowTimeSortOperator, SinkOperator, SortLimitOperator, SortMergeJoinOperator, SortOperator, SourceCoordinator, SourceOperator, StateBootstrapOperator, StreamFilter, StreamFlatMap, StreamGroupedFold, StreamGroupedReduce, StreamingFileCommitter, StreamingFileSink, StreamingFileWriter, StreamingJoinOperator, StreamingSemiAntiJoinOperator, StreamMap, StreamProject, StreamSink, StreamSortOperator, StreamSource, TableAggregateWindowOperator, TableStreamOperator, Task, TaskStateManagerImpl, TemporalProcessTimeJoinOperator, TemporalRowTimeJoinOperator, TimestampsAndWatermarksOperator, TwoPhaseCommitSinkFunction, WatermarkAssignerOperator, WindowOperator, WindowOperator

@Public
public interface CheckpointListener

This interface must be implemented by functions/operations that want to receive a commit notification once a checkpoint has been completely acknowledged by all participants.

Method Summary

Modifier and Type	Method and Description
default void	notifyCheckpointAborted(long checkpointId) This method is called as a notification once a distributed checkpoint has been aborted.
void	notifyCheckpointComplete(long checkpointId) This method is called as a notification once a distributed checkpoint has been completed.

Method Detail

notifyCheckpointComplete

void notifyCheckpointComplete(long checkpointId)
                       throws Exception

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

Note that any exception during this method will not cause the checkpoint to fail any more.

Parameters:

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

Throws:

Exception - This method can propagate exceptions, which leads to a failure/recovery for the task. Not that this will NOT lead to the checkpoint being revoked.

notifyCheckpointAborted

default void notifyCheckpointAborted(long checkpointId)
                              throws Exception

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

Parameters:

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

Throws:

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