Package org.apache.flink.streaming.connectors.kafka.internals

Interface KafkaCommitCallback

  • @Internal
public interface KafkaCommitCallback
    A callback interface that the source operator can implement to trigger custom actions when a commit request completes, which should normally be triggered from checkpoint complete event.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void onException​(Throwable cause)
      A callback method the user can implement to provide asynchronous handling of commit request failure.
      void onSuccess()
      A callback method the user can implement to provide asynchronous handling of commit request completion.

    • Method Detail

      • onSuccess

        void onSuccess()
        A callback method the user can implement to provide asynchronous handling of commit request completion. This method will be called when the commit request sent to the server has been acknowledged without error.

      • onException

        void onException​(Throwable cause)
        A callback method the user can implement to provide asynchronous handling of commit request failure. This method will be called when the commit request failed.
        Parameters:
        cause - Kafka commit failure cause returned by kafka client