org.apache.flink.statefun.sdk.kafka

Class KafkaIngressStartupPosition

java.lang.Object

org.apache.flink.statefun.sdk.kafka.KafkaIngressStartupPosition

Direct Known Subclasses:

KafkaIngressStartupPosition.DatePosition, KafkaIngressStartupPosition.EarliestPosition, KafkaIngressStartupPosition.GroupOffsetsPosition, KafkaIngressStartupPosition.LatestPosition, KafkaIngressStartupPosition.SpecificOffsetsPosition

public class KafkaIngressStartupPosition
extends java.lang.Object

Position for the ingress to start consuming Kafka partitions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KafkaIngressStartupPosition.DatePosition
static class	KafkaIngressStartupPosition.EarliestPosition
static class	KafkaIngressStartupPosition.GroupOffsetsPosition
static class	KafkaIngressStartupPosition.LatestPosition
static class	KafkaIngressStartupPosition.SpecificOffsetsPosition

Method Summary

Modifier and Type	Method and Description
KafkaIngressStartupPosition.DatePosition	asDate() Returns this position as a KafkaIngressStartupPosition.DatePosition.
KafkaIngressStartupPosition.SpecificOffsetsPosition	asSpecificOffsets() Returns this position as a KafkaIngressStartupPosition.SpecificOffsetsPosition.
static KafkaIngressStartupPosition	fromDate(java.time.ZonedDateTime date) Start consuming from offsets with ingestion timestamps after or equal to a specified ZonedDateTime.
static KafkaIngressStartupPosition	fromEarliest() Start consuming from the earliest offset possible.
static KafkaIngressStartupPosition	fromGroupOffsets() Start consuming from committed consumer group offsets in Kafka.
static KafkaIngressStartupPosition	fromLatest() Start consuming from the latest offset, i.e.
static KafkaIngressStartupPosition	fromSpecificOffsets(java.util.Map<KafkaTopicPartition,java.lang.Long> specificOffsets) Start consuming from a specified set of offsets.
boolean	isDate() Checks whether this position is configured using a date.
boolean	isEarliest() Checks whether this position is configured using the earliest offset.
boolean	isGroupOffsets() Checks whether this position is configured using committed consumer group offsets in Kafka.
boolean	isLatest() Checks whether this position is configured using the latest offset.
boolean	isSpecificOffsets() Checks whether this position is configured using specific offsets.

Methods inherited from class java.lang.Object

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

Method Detail

fromGroupOffsets

public static KafkaIngressStartupPosition fromGroupOffsets()

Start consuming from committed consumer group offsets in Kafka.

Note that a consumer group id must be provided for this startup mode. Please see KafkaIngressBuilder.withConsumerGroupId(String).

fromEarliest

public static KafkaIngressStartupPosition fromEarliest()

Start consuming from the earliest offset possible.

fromLatest

public static KafkaIngressStartupPosition fromLatest()

Start consuming from the latest offset, i.e. head of the topic partitions.

fromSpecificOffsets

public static KafkaIngressStartupPosition fromSpecificOffsets(java.util.Map<KafkaTopicPartition,java.lang.Long> specificOffsets)

Start consuming from a specified set of offsets.

If a specified offset does not exist for a partition, the position for that partition will fallback to the reset position configured via KafkaIngressBuilder.withAutoResetPosition(KafkaIngressAutoResetPosition).

Parameters:

specificOffsets - map of specific set of offsets.

fromDate

public static KafkaIngressStartupPosition fromDate(java.time.ZonedDateTime date)

Start consuming from offsets with ingestion timestamps after or equal to a specified ZonedDateTime.

If a Kafka partition does not have any records with ingestion timestamps after or equal to the specified date, the position for that partition will fallback to the reset position configured via KafkaIngressBuilder.withAutoResetPosition(KafkaIngressAutoResetPosition).

isGroupOffsets

public boolean isGroupOffsets()

Checks whether this position is configured using committed consumer group offsets in Kafka.

isEarliest

public boolean isEarliest()

Checks whether this position is configured using the earliest offset.

isLatest

public boolean isLatest()

Checks whether this position is configured using the latest offset.

isSpecificOffsets

public boolean isSpecificOffsets()

Checks whether this position is configured using specific offsets.

isDate

public boolean isDate()

Checks whether this position is configured using a date.

asSpecificOffsets

public KafkaIngressStartupPosition.SpecificOffsetsPosition asSpecificOffsets()

Returns this position as a KafkaIngressStartupPosition.SpecificOffsetsPosition.

asDate

public KafkaIngressStartupPosition.DatePosition asDate()

Returns this position as a KafkaIngressStartupPosition.DatePosition.