Interface StateRestoreListener

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void onBatchRestored​(org.apache.kafka.common.TopicPartition topicPartition, java.lang.String storeName, long batchEndOffset, long numRestored)
      Method called after restoring a batch of records.
      void onRestoreEnd​(org.apache.kafka.common.TopicPartition topicPartition, java.lang.String storeName, long totalRestored)
      Method called when restoring the StateStore is complete.
      void onRestoreStart​(org.apache.kafka.common.TopicPartition topicPartition, java.lang.String storeName, long startingOffset, long endingOffset)
      Method called at the very beginning of StateStore restoration.
    • Method Detail

      • onRestoreStart

        void onRestoreStart​(org.apache.kafka.common.TopicPartition topicPartition,
                            java.lang.String storeName,
                            long startingOffset,
                            long endingOffset)
        Method called at the very beginning of StateStore restoration.
        Parameters:
        topicPartition - the TopicPartition containing the values to restore
        storeName - the name of the store undergoing restoration
        startingOffset - the starting offset of the entire restoration process for this TopicPartition
        endingOffset - the exclusive ending offset of the entire restoration process for this TopicPartition
      • onBatchRestored

        void onBatchRestored​(org.apache.kafka.common.TopicPartition topicPartition,
                             java.lang.String storeName,
                             long batchEndOffset,
                             long numRestored)
        Method called after restoring a batch of records. In this case the maximum size of the batch is whatever the value of the MAX_POLL_RECORDS is set to. This method is called after restoring each batch and it is advised to keep processing to a minimum. Any heavy processing will hold up recovering the next batch, hence slowing down the restore process as a whole. If you need to do any extended processing or connecting to an external service consider doing so asynchronously.
        Parameters:
        topicPartition - the TopicPartition containing the values to restore
        storeName - the name of the store undergoing restoration
        batchEndOffset - the inclusive ending offset for the current restored batch for this TopicPartition
        numRestored - the total number of records restored in this batch for this TopicPartition
      • onRestoreEnd

        void onRestoreEnd​(org.apache.kafka.common.TopicPartition topicPartition,
                          java.lang.String storeName,
                          long totalRestored)
        Method called when restoring the StateStore is complete.
        Parameters:
        topicPartition - the TopicPartition containing the values to restore
        storeName - the name of the store just restored
        totalRestored - the total number of records restored for this TopicPartition