org.apache.flink.connector.pulsar.sink

Class PulsarSinkBuilder<IN>

java.lang.Object

org.apache.flink.connector.pulsar.sink.PulsarSinkBuilder<IN>

Type Parameters:

IN - The input type of the sink.

@PublicEvolving
public class PulsarSinkBuilder<IN>
extends Object

The builder class for PulsarSink to make it easier for the users to construct a PulsarSink.

The following example shows the minimum setup to create a PulsarSink that reads the String values from a Pulsar topic.

 PulsarSink<String> sink = PulsarSink.builder()
     .setServiceUrl(operator().serviceUrl())
     .setAdminUrl(operator().adminUrl())
     .setTopics(topic)
     .setSerializationSchema(PulsarSerializationSchema.pulsarSchema(Schema.STRING))
     .build();
 

The service url, admin url, and the record serializer are required fields that must be set. If you don't set the topics, make sure you have provided a custom TopicRouter. Otherwise, you must provide the topics to produce.

To specify the delivery guarantees of PulsarSink, one can call setDeliveryGuarantee(DeliveryGuarantee). The default value of the delivery guarantee is DeliveryGuarantee.NONE, and it wouldn't promise the consistence when write the message into Pulsar.

 PulsarSink<String> sink = PulsarSink.builder()
     .setServiceUrl(operator().serviceUrl())
     .setAdminUrl(operator().adminUrl())
     .setTopics(topic)
     .setSerializationSchema(PulsarSerializationSchema.pulsarSchema(Schema.STRING))
     .setDeliveryGuarantee(deliveryGuarantee)
     .build();
 

See Also:

for a more detailed explanation of the different guarantees.

Method Summary

Modifier and Type	Method and Description
PulsarSink<IN>	build() Build the PulsarSink.
PulsarSinkBuilder<IN>	delaySendingMessage(MessageDelayer<IN> messageDelayer) Set a message delayer for enable Pulsar message delay delivery.
PulsarSinkBuilder<IN>	enableSchemaEvolution() If you enable this option, we would consume and deserialize the message by using Pulsar Schema.
PulsarSinkBuilder<IN>	setAdminUrl(String adminUrl) Sets the admin endpoint for the PulsarAdmin of the PulsarSink.
<T> PulsarSinkBuilder<IN>	setConfig(org.apache.flink.configuration.ConfigOption<T> key, T value) Set an arbitrary property for the PulsarSink and Pulsar Producer.
PulsarSinkBuilder<IN>	setConfig(org.apache.flink.configuration.Configuration config) Set arbitrary properties for the PulsarSink and Pulsar Producer.
PulsarSinkBuilder<IN>	setDeliveryGuarantee(org.apache.flink.connector.base.DeliveryGuarantee deliveryGuarantee) Sets the wanted the DeliveryGuarantee.
PulsarSinkBuilder<IN>	setProducerName(String producerName) The producer name is informative, and it can be used to identify a particular producer instance from the topic stats.
PulsarSinkBuilder<IN>	setProperties(Properties properties) Set arbitrary properties for the PulsarSink and Pulsar Producer.
<T extends IN> PulsarSinkBuilder<T>	setSerializationSchema(PulsarSerializationSchema<T> serializationSchema) Sets the PulsarSerializationSchema that transforms incoming records to bytes.
PulsarSinkBuilder<IN>	setServiceUrl(String serviceUrl) Sets the server's link for the PulsarProducer of the PulsarSink.
PulsarSinkBuilder<IN>	setTopicRouter(TopicRouter<IN> topicRouter) Use a custom topic router instead predefine topic routing.
PulsarSinkBuilder<IN>	setTopicRoutingMode(TopicRoutingMode topicRoutingMode) Set a routing mode for choosing right topic partition to send messages.
PulsarSinkBuilder<IN>	setTopics(List<String> topics) Set a pulsar topic list for flink sink.
PulsarSinkBuilder<IN>	setTopics(String... topics) Set a pulsar topic list for flink sink.

Methods inherited from class java.lang.Object

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

Method Detail

setAdminUrl

public PulsarSinkBuilder<IN> setAdminUrl(String adminUrl)

Sets the admin endpoint for the PulsarAdmin of the PulsarSink.

Parameters:

adminUrl - The url for the PulsarAdmin.

Returns:

this PulsarSinkBuilder.

setServiceUrl

public PulsarSinkBuilder<IN> setServiceUrl(String serviceUrl)

Sets the server's link for the PulsarProducer of the PulsarSink.

Parameters:

serviceUrl - The server url of the Pulsar cluster.

Returns:

this PulsarSinkBuilder.

setProducerName

public PulsarSinkBuilder<IN> setProducerName(String producerName)

The producer name is informative, and it can be used to identify a particular producer instance from the topic stats.

Parameters:

producerName - The name of the producer used in Pulsar sink.

Returns:

this PulsarSinkBuilder.

setTopics

public PulsarSinkBuilder<IN> setTopics(String... topics)

Set a pulsar topic list for flink sink. Some topic may not exist currently, write to this non-existed topic wouldn't throw any exception.

Parameters:

topics - The topic list you would like to consume message.

Returns:

this PulsarSinkBuilder.

setTopics

public PulsarSinkBuilder<IN> setTopics(List<String> topics)

Set a pulsar topic list for flink sink. Some topic may not exist currently, consuming this non-existed topic wouldn't throw any exception.

Parameters:

topics - The topic list you would like to consume message.

Returns:

this PulsarSinkBuilder.

setDeliveryGuarantee

public PulsarSinkBuilder<IN> setDeliveryGuarantee(org.apache.flink.connector.base.DeliveryGuarantee deliveryGuarantee)

Sets the wanted the DeliveryGuarantee. The default delivery guarantee is DeliveryGuarantee.NONE.

Parameters:

deliveryGuarantee - Deliver guarantees.

Returns:

this PulsarSinkBuilder.

setTopicRoutingMode

public PulsarSinkBuilder<IN> setTopicRoutingMode(TopicRoutingMode topicRoutingMode)

Set a routing mode for choosing right topic partition to send messages.

Parameters:

topicRoutingMode - Routing policy for choosing the desired topic.

Returns:

this PulsarSinkBuilder.

setTopicRouter

public PulsarSinkBuilder<IN> setTopicRouter(TopicRouter<IN> topicRouter)

Use a custom topic router instead predefine topic routing.

Parameters:

topicRouter - The router for choosing topic to send message.

Returns:

this PulsarSinkBuilder.

setSerializationSchema

public <T extends IN> PulsarSinkBuilder<T> setSerializationSchema(PulsarSerializationSchema<T> serializationSchema)

Sets the PulsarSerializationSchema that transforms incoming records to bytes.

Parameters:

serializationSchema - Pulsar specified serialize logic.

Returns:

this PulsarSinkBuilder.

enableSchemaEvolution

public PulsarSinkBuilder<IN> enableSchemaEvolution()

If you enable this option, we would consume and deserialize the message by using Pulsar Schema.

Returns:

this PulsarSinkBuilder.

delaySendingMessage

public PulsarSinkBuilder<IN> delaySendingMessage(MessageDelayer<IN> messageDelayer)

Set a message delayer for enable Pulsar message delay delivery.

Parameters:

messageDelayer - The delayer which would defined when to send the message to consumer.

Returns:

this PulsarSinkBuilder.

setConfig

public <T> PulsarSinkBuilder<IN> setConfig(org.apache.flink.configuration.ConfigOption<T> key,
                                           T value)

Set an arbitrary property for the PulsarSink and Pulsar Producer. The valid keys can be found in PulsarSinkOptions and PulsarOptions.

Make sure the option could be set only once or with same value.

Parameters:

key - The key of the property.

value - The value of the property.

Returns:

this PulsarSinkBuilder.

setConfig

public PulsarSinkBuilder<IN> setConfig(org.apache.flink.configuration.Configuration config)

Set arbitrary properties for the PulsarSink and Pulsar Producer. The valid keys can be found in PulsarSinkOptions and PulsarOptions.

Parameters:

config - The config to set for the PulsarSink.

Returns:

this PulsarSinkBuilder.

setProperties

public PulsarSinkBuilder<IN> setProperties(Properties properties)

Set arbitrary properties for the PulsarSink and Pulsar Producer. The valid keys can be found in PulsarSinkOptions and PulsarOptions.

This method is mainly used for future flink SQL binding.

Parameters:

properties - The config properties to set for the PulsarSink.

Returns:

this PulsarSinkBuilder.

build

public PulsarSink<IN> build()

Build the PulsarSink.

Returns:

a PulsarSink with the settings made for this builder.