Package org.apache.spark.sql.streaming

Interface TimerValues

All Superinterfaces:
Serializable
public interface TimerValues extends Serializable
Class used to provide access to timer values for processing and event time populated before method invocations using the arbitrary state API v2.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getCurrentProcessingTimeInMs()
    Function to get the current processing time as milliseconds in epoch time.
    long
    getCurrentWatermarkInMs()
    Function to get the current event time watermark as milliseconds in epoch time.

  • Method Details

    • getCurrentProcessingTimeInMs

      long getCurrentProcessingTimeInMs()
      Function to get the current processing time as milliseconds in epoch time.

      Returns:
      - the current processing time in milliseconds
      Note:
      This will return a constant value throughout the duration of a streaming query trigger, even if the trigger is re-executed.

    • getCurrentWatermarkInMs

      long getCurrentWatermarkInMs()
      Function to get the current event time watermark as milliseconds in epoch time.

      Returns:
      - the current event time watermark in milliseconds
      Note:
      This can be called only when watermark is set before calling transformWithState., The watermark gets propagated at the end of each query. As a result, this method will return 0 (1970-01-01T00:00:00) for the first micro-batch.