org.apache.kafka.streams.processor

Class ConsumerRecordTimestampExtractor

java.lang.Object

org.apache.kafka.streams.processor.ConsumerRecordTimestampExtractor

All Implemented Interfaces:

TimestampExtractor

public class ConsumerRecordTimestampExtractor
extends Object
implements TimestampExtractor

Retrieves built-in timestamps from Kafka messages (introduced in KIP-32: Add timestamps to Kafka message). Here, "built-in" refers to the fact that compatible Kafka producer clients automatically and transparently embed such timestamps into messages they sent to Kafka, which can then be retrieved via this timestamp extractor. If CreateTime is used to define the built-in timestamps, using this extractor effectively provide event-time semantics. If LogAppendTime is used to define the built-in timestamps, using this extractor effectively provides ingestion-time semantics. If you need processing-time semantics, use WallclockTimestampExtractor.

Constructor Summary

Constructors

Constructor and Description
ConsumerRecordTimestampExtractor()

Method Summary

Methods

Modifier and Type	Method and Description
long	extract(ConsumerRecord<Object,Object> record) Extracts a timestamp from a record.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsumerRecordTimestampExtractor

public ConsumerRecordTimestampExtractor()

Method Detail

extract

public long extract(ConsumerRecord<Object,Object> record)

Description copied from interface: TimestampExtractor

Extracts a timestamp from a record.

The extracted timestamp MUST represent the milliseconds since midnight, January 1, 1970 UTC. It is important to note that this timestamp may become the message timestamp for any messages sent to changelogs updated by KTables and joins. The message timestamp is used for log retention and log rolling, so using nonsensical values may result in excessive log rolling and therefore broker performance degradation.

Specified by:

extract in interface TimestampExtractor

Parameters:

record - a data record

Returns:

the timestamp of the record