org.wikimedia.eventutilities.flink.formats.json

Enum KafkaRecordTimestampStrategy

java.lang.Object

java.lang.Enum<KafkaRecordTimestampStrategy>

org.wikimedia.eventutilities.flink.formats.json.KafkaRecordTimestampStrategy

All Implemented Interfaces:

Serializable, Comparable<KafkaRecordTimestampStrategy>

public enum KafkaRecordTimestampStrategy
extends Enum<KafkaRecordTimestampStrategy>
implements Serializable

Strategy regarding how to assign the kafka timestamp of the output messages. Used by the sink function obtained via EventDataStreamFactory.kafkaSinkBuilder(String, String, String, String, KafkaRecordTimestampStrategy)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLINK_RECORD_EVENT_TIME Use the timestamp of the flink stream record to populate the event dt field and the kafka timestamp.
ROW_EVENT_TIME Use the timestamp found in the input Row record.
ROW_INGESTION_TIME Use the ingestion time (obtained from the clock while serializing the event) set to meta.dt.

Method Summary

Modifier and Type	Method and Description
static KafkaRecordTimestampStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static KafkaRecordTimestampStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FLINK_RECORD_EVENT_TIME

public static final KafkaRecordTimestampStrategy FLINK_RECORD_EVENT_TIME

Use the timestamp of the flink stream record to populate the event dt field and the kafka timestamp. Useful for pipeline running in event time semantics, the input Row dt field, if set, is overridden. Will fail if the pipeline does not assign any timestamp.

ROW_EVENT_TIME

public static final KafkaRecordTimestampStrategy ROW_EVENT_TIME

Use the timestamp found in the input Row record. Useful when the pipeline runs in processing time without any watermarks. Will fail if the input Row does not have a dt field set.

ROW_INGESTION_TIME

public static final KafkaRecordTimestampStrategy ROW_INGESTION_TIME

Use the ingestion time (obtained from the clock while serializing the event) set to meta.dt. meta.dt and the kafka record timestamp will be identical.

Method Detail

values

public static KafkaRecordTimestampStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KafkaRecordTimestampStrategy c : KafkaRecordTimestampStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KafkaRecordTimestampStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null