org.apache.flink.connector.pulsar.source

Class PulsarSourceOptions

java.lang.Object

org.apache.flink.connector.pulsar.source.PulsarSourceOptions

@PublicEvolving
public final class PulsarSourceOptions
extends Object

Configurations for PulsarSource. All the options list here could be configured in PulsarSourceBuilder.setConfig(ConfigOption, Object). The PulsarOptions is also required for pulsar source.

See Also:

for shared configure options.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSUMER_CONFIG_PREFIX
static ConfigOption<Boolean>	PULSAR_ACK_RECEIPT_ENABLED
static ConfigOption<Long>	PULSAR_ACK_TIMEOUT_MILLIS
static ConfigOption<Long>	PULSAR_ACKNOWLEDGEMENTS_GROUP_TIME_MICROS
static ConfigOption<Boolean>	PULSAR_AUTO_ACK_OLDEST_CHUNKED_MESSAGE_ON_QUEUE_FULL
static ConfigOption<Long>	PULSAR_AUTO_COMMIT_CURSOR_INTERVAL
static ConfigOption<Integer>	PULSAR_AUTO_UPDATE_PARTITIONS_INTERVAL_SECONDS
static ConfigOption<String>	PULSAR_CONSUMER_NAME
static ConfigOption<Map<String,String>>	PULSAR_CONSUMER_PROPERTIES
static ConfigOption<org.apache.pulsar.client.api.ConsumerCryptoFailureAction>	PULSAR_CRYPTO_FAILURE_ACTION
static ConfigOption<String>	PULSAR_DEAD_LETTER_TOPIC
static ConfigOption<Boolean>	PULSAR_ENABLE_AUTO_ACKNOWLEDGE_MESSAGE
static ConfigOption<Long>	PULSAR_EXPIRE_TIME_OF_INCOMPLETE_CHUNKED_MESSAGE_MILLIS
static ConfigOption<Integer>	PULSAR_MAX_FETCH_RECORDS
static ConfigOption<Long>	PULSAR_MAX_FETCH_TIME
static ConfigOption<Integer>	PULSAR_MAX_PENDING_CHUNKED_MESSAGE
static ConfigOption<Integer>	PULSAR_MAX_REDELIVER_COUNT Dead letter policy for consumers.
static ConfigOption<Integer>	PULSAR_MAX_TOTAL_RECEIVER_QUEUE_SIZE_ACROSS_PARTITIONS
static ConfigOption<Long>	PULSAR_NEGATIVE_ACK_REDELIVERY_DELAY_MICROS
static ConfigOption<Long>	PULSAR_PARTITION_DISCOVERY_INTERVAL_MS
static ConfigOption<Boolean>	PULSAR_POOL_MESSAGES
static ConfigOption<Integer>	PULSAR_PRIORITY_LEVEL
static ConfigOption<Boolean>	PULSAR_READ_COMPACTED
static ConfigOption<Long>	PULSAR_READ_TRANSACTION_TIMEOUT
static ConfigOption<Integer>	PULSAR_RECEIVER_QUEUE_SIZE
static ConfigOption<Boolean>	PULSAR_REPLICATE_SUBSCRIPTION_STATE
static ConfigOption<Boolean>	PULSAR_RETRY_ENABLE
static ConfigOption<String>	PULSAR_RETRY_LETTER_TOPIC
static ConfigOption<org.apache.pulsar.client.api.SubscriptionInitialPosition>	PULSAR_SUBSCRIPTION_INITIAL_POSITION Deprecated. This option would be reset by StartCursor, no need to use it anymore. Pulsar didn't support this config option before 1.10.1, so we have to remove this config option.
static ConfigOption<org.apache.pulsar.client.api.SubscriptionMode>	PULSAR_SUBSCRIPTION_MODE
static ConfigOption<String>	PULSAR_SUBSCRIPTION_NAME
static ConfigOption<org.apache.pulsar.client.api.SubscriptionType>	PULSAR_SUBSCRIPTION_TYPE
static ConfigOption<Long>	PULSAR_TICK_DURATION_MILLIS
static ConfigOption<Long>	PULSAR_TRANSACTION_TIMEOUT_MILLIS Deprecated. Use PULSAR_READ_TRANSACTION_TIMEOUT instead. This would be removed in the next release.
static ConfigOption<CursorVerification>	PULSAR_VERIFY_INITIAL_OFFSETS
static String	SOURCE_CONFIG_PREFIX

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_CONFIG_PREFIX

public static final String SOURCE_CONFIG_PREFIX

See Also:

Constant Field Values

CONSUMER_CONFIG_PREFIX

public static final String CONSUMER_CONFIG_PREFIX

See Also:

Constant Field Values

PULSAR_PARTITION_DISCOVERY_INTERVAL_MS

public static final ConfigOption<Long> PULSAR_PARTITION_DISCOVERY_INTERVAL_MS

PULSAR_ENABLE_AUTO_ACKNOWLEDGE_MESSAGE

public static final ConfigOption<Boolean> PULSAR_ENABLE_AUTO_ACKNOWLEDGE_MESSAGE

PULSAR_AUTO_COMMIT_CURSOR_INTERVAL

public static final ConfigOption<Long> PULSAR_AUTO_COMMIT_CURSOR_INTERVAL

PULSAR_READ_TRANSACTION_TIMEOUT

public static final ConfigOption<Long> PULSAR_READ_TRANSACTION_TIMEOUT

PULSAR_TRANSACTION_TIMEOUT_MILLIS

@Deprecated
public static final ConfigOption<Long> PULSAR_TRANSACTION_TIMEOUT_MILLIS

Deprecated. Use PULSAR_READ_TRANSACTION_TIMEOUT instead. This would be removed in the next release.

PULSAR_MAX_FETCH_TIME

public static final ConfigOption<Long> PULSAR_MAX_FETCH_TIME

PULSAR_MAX_FETCH_RECORDS

public static final ConfigOption<Integer> PULSAR_MAX_FETCH_RECORDS

PULSAR_VERIFY_INITIAL_OFFSETS

public static final ConfigOption<CursorVerification> PULSAR_VERIFY_INITIAL_OFFSETS

PULSAR_SUBSCRIPTION_NAME

public static final ConfigOption<String> PULSAR_SUBSCRIPTION_NAME

PULSAR_SUBSCRIPTION_TYPE

public static final ConfigOption<org.apache.pulsar.client.api.SubscriptionType> PULSAR_SUBSCRIPTION_TYPE

PULSAR_SUBSCRIPTION_MODE

public static final ConfigOption<org.apache.pulsar.client.api.SubscriptionMode> PULSAR_SUBSCRIPTION_MODE

PULSAR_RECEIVER_QUEUE_SIZE

public static final ConfigOption<Integer> PULSAR_RECEIVER_QUEUE_SIZE

PULSAR_ACKNOWLEDGEMENTS_GROUP_TIME_MICROS

public static final ConfigOption<Long> PULSAR_ACKNOWLEDGEMENTS_GROUP_TIME_MICROS

PULSAR_NEGATIVE_ACK_REDELIVERY_DELAY_MICROS

public static final ConfigOption<Long> PULSAR_NEGATIVE_ACK_REDELIVERY_DELAY_MICROS

PULSAR_MAX_TOTAL_RECEIVER_QUEUE_SIZE_ACROSS_PARTITIONS

public static final ConfigOption<Integer> PULSAR_MAX_TOTAL_RECEIVER_QUEUE_SIZE_ACROSS_PARTITIONS

PULSAR_CONSUMER_NAME

public static final ConfigOption<String> PULSAR_CONSUMER_NAME

PULSAR_ACK_TIMEOUT_MILLIS

public static final ConfigOption<Long> PULSAR_ACK_TIMEOUT_MILLIS

PULSAR_TICK_DURATION_MILLIS

public static final ConfigOption<Long> PULSAR_TICK_DURATION_MILLIS

PULSAR_PRIORITY_LEVEL

public static final ConfigOption<Integer> PULSAR_PRIORITY_LEVEL

PULSAR_MAX_PENDING_CHUNKED_MESSAGE

public static final ConfigOption<Integer> PULSAR_MAX_PENDING_CHUNKED_MESSAGE

PULSAR_AUTO_ACK_OLDEST_CHUNKED_MESSAGE_ON_QUEUE_FULL

public static final ConfigOption<Boolean> PULSAR_AUTO_ACK_OLDEST_CHUNKED_MESSAGE_ON_QUEUE_FULL

PULSAR_EXPIRE_TIME_OF_INCOMPLETE_CHUNKED_MESSAGE_MILLIS

public static final ConfigOption<Long> PULSAR_EXPIRE_TIME_OF_INCOMPLETE_CHUNKED_MESSAGE_MILLIS

PULSAR_CRYPTO_FAILURE_ACTION

public static final ConfigOption<org.apache.pulsar.client.api.ConsumerCryptoFailureAction> PULSAR_CRYPTO_FAILURE_ACTION

PULSAR_CONSUMER_PROPERTIES

public static final ConfigOption<Map<String,String>> PULSAR_CONSUMER_PROPERTIES

PULSAR_READ_COMPACTED

public static final ConfigOption<Boolean> PULSAR_READ_COMPACTED

PULSAR_SUBSCRIPTION_INITIAL_POSITION

@Deprecated
public static final ConfigOption<org.apache.pulsar.client.api.SubscriptionInitialPosition> PULSAR_SUBSCRIPTION_INITIAL_POSITION

Deprecated. This option would be reset by StartCursor, no need to use it anymore. Pulsar didn't support this config option before 1.10.1, so we have to remove this config option.

PULSAR_MAX_REDELIVER_COUNT

public static final ConfigOption<Integer> PULSAR_MAX_REDELIVER_COUNT

Dead letter policy for consumers.

By default, some messages are probably redelivered many times, even to the extent that it never stops.

By using the dead letter mechanism, messages have the max redelivery count. When exceeding the maximum number of redeliveries, messages are sent to the Dead Letter Topic and acknowledged automatically.

You can enable the dead letter mechanism by setting deadLetterPolicy.

Example pulsar.consumer.deadLetterPolicy.maxRedeliverCount = 10 Default dead letter topic name is {TopicName}-{Subscription}-DLQ.

To set a custom dead letter topic name:

 pulsar.consumer.deadLetterPolicy.maxRedeliverCount = 10
 pulsar.consumer.deadLetterPolicy.deadLetterTopic = your-topic-name
 

When specifying the dead letter policy while not specifying ackTimeoutMillis, you can set the ack timeout to 30000 millisecond.

PULSAR_RETRY_LETTER_TOPIC

public static final ConfigOption<String> PULSAR_RETRY_LETTER_TOPIC

PULSAR_DEAD_LETTER_TOPIC

public static final ConfigOption<String> PULSAR_DEAD_LETTER_TOPIC

PULSAR_RETRY_ENABLE

public static final ConfigOption<Boolean> PULSAR_RETRY_ENABLE

PULSAR_AUTO_UPDATE_PARTITIONS_INTERVAL_SECONDS

public static final ConfigOption<Integer> PULSAR_AUTO_UPDATE_PARTITIONS_INTERVAL_SECONDS

PULSAR_REPLICATE_SUBSCRIPTION_STATE

public static final ConfigOption<Boolean> PULSAR_REPLICATE_SUBSCRIPTION_STATE

PULSAR_ACK_RECEIPT_ENABLED

public static final ConfigOption<Boolean> PULSAR_ACK_RECEIPT_ENABLED

PULSAR_POOL_MESSAGES

public static final ConfigOption<Boolean> PULSAR_POOL_MESSAGES