org.apache.flink.connector.pulsar.source.enumerator.cursor

Interface StartCursor

All Superinterfaces:

Serializable

All Known Implementing Classes:

MessageIdStartCursor, TimestampStartCursor

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@PublicEvolving
 @FunctionalInterface
public interface StartCursor
extends Serializable

A interface for users to specify the start position of a pulsar subscription. Since it would be serialized into split. The implementation for this interface should be well considered. I don't recommend adding extra internal state for this implementation.

This class would be used only for SubscriptionType.Exclusive and SubscriptionType.Failover.

Method Summary

Modifier and Type	Method and Description
static StartCursor	defaultStartCursor()
static StartCursor	earliest()
static StartCursor	fromMessageId(org.apache.pulsar.client.api.MessageId messageId)
static StartCursor	fromMessageId(org.apache.pulsar.client.api.MessageId messageId, boolean inclusive)
static StartCursor	fromMessageTime(long timestamp)
static StartCursor	latest()
CursorPosition	position(String topic, int partitionId)
default void	seekPosition(String topic, int partitionId, org.apache.pulsar.client.api.Consumer<?> consumer) Helper method for seek the right position for given pulsar consumer.

Method Detail

position

CursorPosition position(String topic,
                        int partitionId)

seekPosition

default void seekPosition(String topic,
                          int partitionId,
                          org.apache.pulsar.client.api.Consumer<?> consumer)
                   throws org.apache.pulsar.client.api.PulsarClientException

Helper method for seek the right position for given pulsar consumer.

Throws:

org.apache.pulsar.client.api.PulsarClientException

defaultStartCursor

static StartCursor defaultStartCursor()

earliest

static StartCursor earliest()

latest

static StartCursor latest()

fromMessageId

static StartCursor fromMessageId(org.apache.pulsar.client.api.MessageId messageId)

fromMessageId

static StartCursor fromMessageId(org.apache.pulsar.client.api.MessageId messageId,
                                 boolean inclusive)

Parameters:

messageId - Find the available message id and start consuming from it.

inclusive - true would include the given message id.

fromMessageTime

static StartCursor fromMessageTime(long timestamp)