org.apache.flink.connector.pulsar.source

Interface StartOffsetInitializer

All Superinterfaces:

Serializable

All Known Implementing Classes:

ExternalSubscriptionStartOffsetInitializer, RollbackStartOffsetInitializer, SpecifiedStartOffsetInitializer, TimestampStartOffsetInitializer

@PublicEvolving
public interface StartOffsetInitializer
extends Serializable

A interface for users to specify the starting / stopping offset of a PulsarPartitionSplit.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StartOffsetInitializer.CreationConfiguration config class to create consumer.

Method Summary

Modifier and Type	Method and Description
static StartOffsetInitializer	committedOffsets(String subscriptionName)
static StartOffsetInitializer	committedOffsets(String subscriptionName, org.apache.pulsar.client.api.MessageId defaultOffset)
static StartOffsetInitializer	earliest()
static StartOffsetInitializer	earliest(boolean inclusive)
default void	initializeAfterCreation(AbstractPartition partition, org.apache.pulsar.client.api.Consumer<?> consumer) Initializes the offset for the given consumer and partition.
default void	initializeBeforeCreation(AbstractPartition partition, StartOffsetInitializer.CreationConfiguration configuration) Initializes the offset for the given consumer configuration and partition.
static StartOffsetInitializer	latest()
static StartOffsetInitializer	latest(boolean inclusive)
static StartOffsetInitializer	offset(org.apache.pulsar.client.api.MessageId offset, boolean inclusive)
static StartOffsetInitializer	offsets(Map<AbstractPartition,org.apache.pulsar.client.api.MessageId> offsets)
static StartOffsetInitializer	offsets(Map<AbstractPartition,org.apache.pulsar.client.api.MessageId> offsets, org.apache.pulsar.client.api.MessageId defaultOffset, boolean inclusive)
static StartOffsetInitializer	rollback(long rollbackDuration, TimeUnit timeUnit)
static StartOffsetInitializer	timestamps(long timestamp)
default Optional<String>	verifyOffset(AbstractPartition partition, Supplier<Optional<org.apache.pulsar.client.api.MessageId>> lastMessageIdFetcher, Supplier<Optional<org.apache.pulsar.client.api.Message<byte[]>>> firstMessageFetcher) Verifies if the offset was initialized correctly.

Method Detail

initializeBeforeCreation

default void initializeBeforeCreation(AbstractPartition partition,
                                      StartOffsetInitializer.CreationConfiguration configuration)

Initializes the offset for the given consumer configuration and partition.

Parameters:

partition - the partition for which the consumer is about to be created

configuration - the configuration used to create consumer

initializeAfterCreation

default void initializeAfterCreation(AbstractPartition partition,
                                     org.apache.pulsar.client.api.Consumer<?> consumer)
                              throws org.apache.pulsar.client.api.PulsarClientException

Initializes the offset for the given consumer and partition.

Parameters:

partition - the partition for which the consumer has been created

consumer - the consumer

Throws:

org.apache.pulsar.client.api.PulsarClientException

verifyOffset

default Optional<String> verifyOffset(AbstractPartition partition,
                                      Supplier<Optional<org.apache.pulsar.client.api.MessageId>> lastMessageIdFetcher,
                                      Supplier<Optional<org.apache.pulsar.client.api.Message<byte[]>>> firstMessageFetcher)

Verifies if the offset was initialized correctly.

Returns:

an error message if no appropriate data point could be found or empty if initialization worked correctly.

See Also:

PulsarSourceOptions.VERIFY_INITIAL_OFFSETS

committedOffsets

static StartOffsetInitializer committedOffsets(String subscriptionName)

committedOffsets

static StartOffsetInitializer committedOffsets(String subscriptionName,
                                               org.apache.pulsar.client.api.MessageId defaultOffset)

timestamps

static StartOffsetInitializer timestamps(long timestamp)

rollback

static StartOffsetInitializer rollback(long rollbackDuration,
                                       TimeUnit timeUnit)

earliest

static StartOffsetInitializer earliest()

earliest

static StartOffsetInitializer earliest(boolean inclusive)

latest

static StartOffsetInitializer latest()

latest

static StartOffsetInitializer latest(boolean inclusive)

offset

static StartOffsetInitializer offset(org.apache.pulsar.client.api.MessageId offset,
                                     boolean inclusive)

offsets

static StartOffsetInitializer offsets(Map<AbstractPartition,org.apache.pulsar.client.api.MessageId> offsets)

offsets

static StartOffsetInitializer offsets(Map<AbstractPartition,org.apache.pulsar.client.api.MessageId> offsets,
                                      org.apache.pulsar.client.api.MessageId defaultOffset,
                                      boolean inclusive)