Package org.apache.pulsar.client.api

Enum Class MessageRoutingMode

java.lang.Object

java.lang.Enum<MessageRoutingMode>

org.apache.pulsar.client.api.MessageRoutingMode

All Implemented Interfaces:

Serializable, Comparable<MessageRoutingMode>, Constable

@Public
@Stable
public enum MessageRoutingMode
extends Enum<MessageRoutingMode>

Default routing mode for messages to partition.

This logic is applied when the application is not setting a key TypedMessageBuilder.key(String) on a particular message.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method	Description
static MessageRoutingMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageRoutingMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SinglePartition

public static final MessageRoutingMode SinglePartition

If no key is provided, The partitioned producer will randomly pick one single 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 message to a particular partition.

RoundRobinPartition

public static final MessageRoutingMode RoundRobinPartition

If no key is provided, the producer will publish messages across all partitions in 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.

While if a key is specified on the message, the partitioned producer will hash the key and assign message to a particular partition.

CustomPartition

public static final MessageRoutingMode CustomPartition

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

Method Details

values

public static MessageRoutingMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MessageRoutingMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null