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

Enum TopicRoutingMode

java.lang.Object

java.lang.Enum<TopicRoutingMode>

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

All Implemented Interfaces:

Serializable, Comparable<TopicRoutingMode>, org.apache.flink.configuration.DescribedEnum

@PublicEvolving
public enum TopicRoutingMode
extends Enum<TopicRoutingMode>
implements org.apache.flink.configuration.DescribedEnum

The routing policy for choosing the desired topic by the given message.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM Use custom topic router implementation that will be called to determine the partition for a particular message.
MESSAGE_KEY_HASH If no key is provided, The partitioned producer will randomly pick one single topic partition and publish all the messages into that partition.
ROUND_ROBIN The producer will publish messages across all partitions in a round-robin fashion to achieve maximum throughput.

Method Summary

Modifier and Type	Method and Description
org.apache.flink.configuration.description.InlineElement	getDescription()
String	toString()
static TopicRoutingMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static TopicRoutingMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ROUND_ROBIN

public static final TopicRoutingMode ROUND_ROBIN

The producer will publish messages across all partitions in a round-robin fashion to achieve maximum throughput. Please note that round-robin is not done per individual message but rather it's set to the same boundary of batching delay, to ensure batching is effective.

MESSAGE_KEY_HASH

public static final TopicRoutingMode MESSAGE_KEY_HASH

If no key is provided, The partitioned producer will randomly pick one single topic partition and publish all the messages into that partition. If a key is provided on the message, the partitioned producer will hash the key and assign the message to a particular partition.

CUSTOM

public static final TopicRoutingMode CUSTOM

Use custom topic router implementation that will be called to determine the partition for a particular message.

Method Detail

values

public static TopicRoutingMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TopicRoutingMode c : TopicRoutingMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TopicRoutingMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDescription

@Internal
public org.apache.flink.configuration.description.InlineElement getDescription()

Specified by:

getDescription in interface org.apache.flink.configuration.DescribedEnum

toString

public String toString()

Overrides:

toString in class Enum<TopicRoutingMode>