Class FailOnInvalidTimestamp

  • All Implemented Interfaces:
    TimestampExtractor

    @Evolving
    public class FailOnInvalidTimestamp
    extends java.lang.Object
    Retrieves embedded metadata timestamps from Kafka messages. If a record has a negative (invalid) timestamp value, this extractor raises an exception.

    Embedded metadata timestamp was introduced in "KIP-32: Add timestamps to Kafka message" for the new 0.10+ Kafka message format.

    Here, "embedded metadata" refers to the fact that compatible Kafka producer clients automatically and transparently embed such timestamps into message metadata they send to Kafka, which can then be retrieved via this timestamp extractor.

    If the embedded metadata timestamp represents CreateTime (cf. Kafka broker setting message.timestamp.type and Kafka topic setting log.message.timestamp.type), this extractor effectively provides event-time semantics. If LogAppendTime is used as broker/topic setting to define the embedded metadata timestamps, using this extractor effectively provides ingestion-time semantics.

    If you need processing-time semantics, use WallclockTimestampExtractor.

    See Also:
    LogAndSkipOnInvalidTimestamp, UsePreviousTimeOnInvalidTimestamp, WallclockTimestampExtractor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long extract​(org.apache.kafka.clients.consumer.ConsumerRecord<java.lang.Object,​java.lang.Object> record, long previousTimestamp)
      Extracts the embedded metadata timestamp from the given ConsumerRecord.
      long onInvalidTimestamp​(org.apache.kafka.clients.consumer.ConsumerRecord<java.lang.Object,​java.lang.Object> record, long recordTimestamp, long previousTimestamp)
      Raises an exception on every call.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • FailOnInvalidTimestamp

        public FailOnInvalidTimestamp()
    • Method Detail

      • onInvalidTimestamp

        public long onInvalidTimestamp​(org.apache.kafka.clients.consumer.ConsumerRecord<java.lang.Object,​java.lang.Object> record,
                                       long recordTimestamp,
                                       long previousTimestamp)
                                throws StreamsException
        Raises an exception on every call.
        Parameters:
        record - a data record
        recordTimestamp - the timestamp extractor from the record
        previousTimestamp - the latest extracted valid timestamp of the current record's partition˙ (could be -1 if unknown)
        Returns:
        nothing; always raises an exception
        Throws:
        StreamsException - on every invocation
      • extract

        public long extract​(org.apache.kafka.clients.consumer.ConsumerRecord<java.lang.Object,​java.lang.Object> record,
                            long previousTimestamp)
        Extracts the embedded metadata timestamp from the given ConsumerRecord.
        Specified by:
        extract in interface TimestampExtractor
        Parameters:
        record - a data record
        previousTimestamp - the latest extracted valid timestamp of the current record's partition˙ (could be -1 if unknown)
        Returns:
        the embedded metadata timestamp of the given ConsumerRecord