org.apache.flink.connector.pulsar.sink.writer.router

Interface TopicRouter<IN>

Type Parameters:

IN - The record type needs to be written to Pulsar.

All Superinterfaces:

Serializable

All Known Implementing Classes:

KeyHashTopicRouter, RoundRobinTopicRouter

@PublicEvolving
public interface TopicRouter<IN>
extends Serializable

The router for choosing the desired topic to write the Flink records. The user can implement this router for complex requirements. We have provided some easy-to-use implementations.

This topic router is stateless and doesn't have any initialize logic. Make sure you don't require some dynamic state.

Method Summary

Modifier and Type	Method and Description
default void	open(SinkConfiguration sinkConfiguration) Implement this method if you have some non-serializable field.
String	route(IN in, String key, List<String> partitions, PulsarSinkContext context) Choose the topic by given record & available partition list.

Method Detail

route

String route(IN in,
             String key,
             List<String> partitions,
             PulsarSinkContext context)

Choose the topic by given record & available partition list. You can return a new topic name if you need it.

Parameters:

in - The record instance which need to be written to Pulsar.

key - The key of the message from PulsarMessageBuilder.key(String). It could be null, if message doesn't have a key.

partitions - The available partition list. This could be empty if you don't provide any topics in PulsarSinkBuilder.setTopics(String...). You can return a custom topic, but make sure it should contain a partition index in naming. Using TopicNameUtils.topicNameWithPartition(String, int) can easily create a topic name with partition index.

context - The context contains useful information for determining the topic.

Returns:

The topic name to use.

open

default void open(SinkConfiguration sinkConfiguration)

Implement this method if you have some non-serializable field.