org.apache.beam.sdk.io.kafka

Enum KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration

java.lang.Object

java.lang.Enum<KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration>

org.apache.beam.sdk.io.kafka.KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration>

Enclosing class:

KafkaSchemaTransformReadConfiguration

@Experimental
public static enum KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration
extends java.lang.Enum<KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration>

A timestamp policy to assign event time for messages in a Kafka partition and watermark for it.

Internal only: This class is actively being worked on, and it will likely change. We provide no backwards compatibility guarantees, and it should not be implemented outside the Beam repository.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOG_APPEND_TIME Assigns Kafka's log append time (server side ingestion time) to each record.
PROCESSING_TIME A simple policy that uses current time for event time and watermark.

Method Summary

Modifier and Type	Method and Description
static KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration[]	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

LOG_APPEND_TIME

public static final KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration LOG_APPEND_TIME

Assigns Kafka's log append time (server side ingestion time) to each record. The watermark for each Kafka partition is the timestamp of the last record read. If a partition is idle, the watermark advances roughly to 'current time - 2 seconds'. See KafkaIO.Read.withLogAppendTime() for longer description.

PROCESSING_TIME

public static final KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration PROCESSING_TIME

A simple policy that uses current time for event time and watermark. This should be used when better timestamps like LogAppendTime are not available for a topic.

Method Detail

values

public static KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration[] 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 (KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration c : KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration.values())
    System.out.println(c);

Returns:

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

valueOf

public static KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null