org.apache.pulsar.common.schema

Enum KeyValueEncodingType

java.lang.Object

java.lang.Enum<KeyValueEncodingType>

org.apache.pulsar.common.schema.KeyValueEncodingType

All Implemented Interfaces:

Serializable, Comparable<KeyValueEncodingType>

@InterfaceAudience.Public
 @InterfaceStability.Stable
public enum KeyValueEncodingType
extends Enum<KeyValueEncodingType>

Encoding types of supported KeyValueSchema for Pulsar messages.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INLINE Key and value are stored as message payload.
SEPARATED Key is stored as message key, while value is stored as message payload.

Method Summary

Modifier and Type	Method and Description
static KeyValueEncodingType	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyValueEncodingType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SEPARATED

public static final KeyValueEncodingType SEPARATED

Key is stored as message key, while value is stored as message payload.

INLINE

public static final KeyValueEncodingType INLINE

Key and value are stored as message payload.

Method Detail

values

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

Returns:

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

valueOf

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