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

An 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) Find the available message id and start consuming from it.
static StartCursor	fromMessageId(org.apache.pulsar.client.api.MessageId messageId, boolean inclusive)
static StartCursor	fromMessageTime(long timestamp) Deprecated. Use fromPublishTime(long) instead.
static StartCursor	fromPublishTime(long timestamp) Seek the start position by using message publish time.
static StartCursor	latest()
CursorPosition	position(String topic, int partitionId)

Method Detail

position

CursorPosition position(String topic,
                        int partitionId)

defaultStartCursor

static StartCursor defaultStartCursor()

earliest

static StartCursor earliest()

latest

static StartCursor latest()

fromMessageId

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

Find the available message id and start consuming from it. The given message is included in the consuming result by default if you provide a specified message id instead of MessageId.earliest or MessageId.latest.

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 if it's not the MessageId.earliest or MessageId.latest.

fromMessageTime

@Deprecated
static StartCursor fromMessageTime(long timestamp)

Deprecated. Use fromPublishTime(long) instead.

This method is designed for seeking message from event time. But Pulsar didn't support seeking from message time, instead, it would seek the position from publish time. We only keep this method for backward compatible.

fromPublishTime

static StartCursor fromPublishTime(long timestamp)

Seek the start position by using message publish time.