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

Enum MessageKeyHash

java.lang.Object

java.lang.Enum<MessageKeyHash>

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

All Implemented Interfaces:

Serializable, Comparable<MessageKeyHash>, DescribedEnum

@PublicEvolving
public enum MessageKeyHash
extends Enum<MessageKeyHash>
implements DescribedEnum

Predefined the available hash function for routing the message.

Enum Constant Summary

Enum Constants

Enum Constant and Description
JAVA_HASH Use regular String.hashCode().
MURMUR3_32_HASH Use Murmur3 hashing function.

Method Summary

Modifier and Type	Method and Description
InlineElement	getDescription() Returns the description for the enum constant.
abstract org.apache.pulsar.client.impl.Hash	getHash()
String	toString()
static MessageKeyHash	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageKeyHash[]	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

JAVA_HASH

public static final MessageKeyHash JAVA_HASH

Use regular String.hashCode().

MURMUR3_32_HASH

public static final MessageKeyHash MURMUR3_32_HASH

Use Murmur3 hashing function. https://en.wikipedia.org/wiki/MurmurHash

Method Detail

values

public static MessageKeyHash[] 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 (MessageKeyHash c : MessageKeyHash.values())
    System.out.println(c);

Returns:

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

valueOf

public static MessageKeyHash 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

getHash

@Internal
public abstract org.apache.pulsar.client.impl.Hash getHash()

toString

public String toString()

Overrides:

toString in class Enum<MessageKeyHash>

getDescription

@Internal
public InlineElement getDescription()

Description copied from interface: DescribedEnum

Returns the description for the enum constant.

If you want to include links or code blocks, use TextElement.wrap(InlineElement...) to wrap multiple inline elements into a single one.

Specified by:

getDescription in interface DescribedEnum