Package com.linkedin.venice.kafka.protocol.enums

Enum MessageType

java.lang.Object

java.lang.Enum<MessageType>

com.linkedin.venice.kafka.protocol.enums.MessageType

All Implemented Interfaces:

VeniceEnumValue, java.io.Serializable, java.lang.Comparable<MessageType>

public enum MessageType
extends java.lang.Enum<MessageType>
implements VeniceEnumValue

A simple enum to map the values of KafkaMessageEnvelope.messageType N.B.: We maintain this enum manually because Avro's auto-generated enums do not support evolution (i.e.: adding values) properly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageType.Constants

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTROL_MESSAGE
DELETE
PUT
UPDATE

Method Summary

Modifier and Type	Method	Description
byte	getKeyHeaderByte()
java.lang.Object	getNewInstance()	Simple utility function to generate the right type of payload, based on message type.
int	getValue()
static MessageType	valueOf(int value)	Returns the enum constant of this type with the specified name.
static MessageType	valueOf(KafkaMessageEnvelope kafkaMessageEnvelope)	Returns the enum constant of this type with the specified name.
static MessageType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static MessageType[]	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

PUT

public static final MessageType PUT

DELETE

public static final MessageType DELETE

CONTROL_MESSAGE

public static final MessageType CONTROL_MESSAGE

UPDATE

public static final MessageType UPDATE

Method Detail

values

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

Returns:

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

valueOf

public static MessageType valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

Specified by:

getValue in interface VeniceEnumValue

Returns:

This is the value used in KafkaMessageEnvelope.messageType to distinguish message types.

getKeyHeaderByte

public byte getKeyHeaderByte()

Returns:

This is the value used at the beginning of our Kafka keys, in order to ensure that Kafka's Log Compaction has the correct overwriting semantics. For example, DELETE must overwrite PUT and vice versa, so they share the same {@param keyHeaderByte}.

getNewInstance

public java.lang.Object getNewInstance()

Simple utility function to generate the right type of payload, based on message type.

Returns:

an empty instance of either: - Put - Delete - ControlMessage

valueOf

public static MessageType valueOf(int value)

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:

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

Returns:

the enum constant with the specified name

Throws:

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

java.lang.NullPointerException - if the argument is null

valueOf

public static MessageType valueOf(KafkaMessageEnvelope kafkaMessageEnvelope)

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:

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

Returns:

the enum constant with the specified name

Throws:

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

java.lang.NullPointerException - if the argument is null