org.apache.flink.connector.pulsar.sink.config

Class SinkConfiguration

java.lang.Object

org.apache.flink.api.common.ExecutionConfig.GlobalJobParameters

org.apache.flink.configuration.Configuration

org.apache.flink.configuration.UnmodifiableConfiguration

org.apache.flink.connector.pulsar.common.config.PulsarConfiguration

org.apache.flink.connector.pulsar.sink.config.SinkConfiguration

All Implemented Interfaces:

Serializable, Cloneable, org.apache.flink.configuration.ReadableConfig, org.apache.flink.configuration.WritableConfig, org.apache.flink.core.io.IOReadableWritable

@PublicEvolving
public class SinkConfiguration
extends PulsarConfiguration

The configured class for pulsar sink.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.configuration.Configuration

confData

Constructor Summary

Constructors

Constructor and Description
SinkConfiguration(org.apache.flink.configuration.Configuration configuration)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
org.apache.flink.connector.base.DeliveryGuarantee	getDeliveryGuarantee() The delivery guarantee changes the behavior of PulsarWriter.
int	getMaxPendingMessages() Pulsar message is sent asynchronously.
int	getMaxRecommitTimes() The maximum allowed recommitting time for a Pulsar transaction.
MessageKeyHash	getMessageKeyHash() The message key's hash logic for routing the message into one Pulsar partition.
int	getPartitionSwitchSize() Switch the partition to write when we have written the given size of messages.
long	getTopicMetadataRefreshInterval() Auto-update the topic metadata in a fixed interval (in ms).
long	getTransactionTimeoutMillis() Pulsar's transactions have a timeout mechanism for the uncommitted transaction.
int	hashCode()
boolean	isEnableSchemaEvolution() If we should serialize and send the message with a specified Pulsar Schema instead the default Schema.BYTES.

Methods inherited from class org.apache.flink.connector.pulsar.common.config.PulsarConfiguration

get, getProperties, useOption, useOption

Methods inherited from class org.apache.flink.configuration.UnmodifiableConfiguration

addAll, addAll, addAllToProperties, removeConfig

Methods inherited from class org.apache.flink.configuration.Configuration

clone, contains, containsKey, fromMap, get, getBoolean, getBoolean, getBoolean, getBytes, getClass, getDouble, getDouble, getDouble, getEnum, getFloat, getFloat, getFloat, getInteger, getInteger, getInteger, getLong, getLong, getLong, getOptional, getString, getString, getString, getValue, keySet, read, set, setBoolean, setBoolean, setBytes, setClass, setDouble, setDouble, setFloat, setFloat, setInteger, setInteger, setLong, setLong, setString, setString, toMap, toString, write

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SinkConfiguration

public SinkConfiguration(org.apache.flink.configuration.Configuration configuration)

Method Detail

getDeliveryGuarantee

public org.apache.flink.connector.base.DeliveryGuarantee getDeliveryGuarantee()

The delivery guarantee changes the behavior of PulsarWriter.

getTransactionTimeoutMillis

public long getTransactionTimeoutMillis()

Pulsar's transactions have a timeout mechanism for the uncommitted transaction. We use transactions for making sure the message could be written only once. Since the checkpoint interval couldn't be acquired from Sink.InitContext, we have to expose this option. Make sure this value is greater than the checkpoint interval. Create a pulsar producer builder by using the given Configuration.

getTopicMetadataRefreshInterval

public long getTopicMetadataRefreshInterval()

Auto-update the topic metadata in a fixed interval (in ms). The default value is 30 minutes.

getPartitionSwitchSize

public int getPartitionSwitchSize()

Switch the partition to write when we have written the given size of messages. It's used for a round-robin topic router.

getMessageKeyHash

public MessageKeyHash getMessageKeyHash()

The message key's hash logic for routing the message into one Pulsar partition.

isEnableSchemaEvolution

public boolean isEnableSchemaEvolution()

If we should serialize and send the message with a specified Pulsar Schema instead the default Schema.BYTES. This switch is only used for PulsarSchemaWrapper.

getMaxPendingMessages

public int getMaxPendingMessages()

Pulsar message is sent asynchronously. Set this option for limiting the pending messages in a Pulsar writer instance.

getMaxRecommitTimes

public int getMaxRecommitTimes()

The maximum allowed recommitting time for a Pulsar transaction.

equals

public boolean equals(Object o)

Overrides:

equals in class org.apache.flink.configuration.Configuration

hashCode

public int hashCode()

Overrides:

hashCode in class org.apache.flink.configuration.Configuration