org.apache.flink.streaming.connectors.kafka.internals

Class KafkaTopicPartitionStateSentinel

java.lang.Object

org.apache.flink.streaming.connectors.kafka.internals.KafkaTopicPartitionStateSentinel

@Internal
public class KafkaTopicPartitionStateSentinel
extends Object

Magic values used to represent special offset states before partitions are actually read.

The values are all negative. Negative offsets are not used by Kafka (invalid), so we pick a number that is probably (hopefully) not used by Kafka as a magic number for anything else.

Field Summary

Fields

Modifier and Type	Field and Description
static long	EARLIEST_OFFSET Magic number that defines the partition should start from the earliest offset.
static long	GROUP_OFFSET Magic number that defines the partition should start from its committed group offset in Kafka.
static long	LATEST_OFFSET Magic number that defines the partition should start from the latest offset.
static long	OFFSET_NOT_SET Magic number that defines an unset offset.

Constructor Summary

Constructors

Constructor and Description
KafkaTopicPartitionStateSentinel()

Method Summary

Modifier and Type	Method and Description
static boolean	isSentinel(long offset)

Methods inherited from class java.lang.Object

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

Field Detail

OFFSET_NOT_SET

public static final long OFFSET_NOT_SET

Magic number that defines an unset offset.

See Also:

Constant Field Values

EARLIEST_OFFSET

public static final long EARLIEST_OFFSET

Magic number that defines the partition should start from the earliest offset.

This is used as a placeholder so that the actual earliest offset can be evaluated lazily when the partition will actually start to be read by the consumer.

See Also:

Constant Field Values

LATEST_OFFSET

public static final long LATEST_OFFSET

Magic number that defines the partition should start from the latest offset.

This is used as a placeholder so that the actual latest offset can be evaluated lazily when the partition will actually start to be read by the consumer.

See Also:

Constant Field Values

GROUP_OFFSET

public static final long GROUP_OFFSET

Magic number that defines the partition should start from its committed group offset in Kafka.

This is used as a placeholder so that the actual committed group offset can be evaluated lazily when the partition will actually start to be read by the consumer.

See Also:

Constant Field Values

Constructor Detail

KafkaTopicPartitionStateSentinel

public KafkaTopicPartitionStateSentinel()

Method Detail

isSentinel

public static boolean isSentinel(long offset)