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

Enum Class MessageType

java.lang.Object
java.lang.Enum<MessageType>
com.linkedin.venice.kafka.protocol.enums.MessageType
All Implemented Interfaces:
VeniceEnumValue, Serializable, Comparable<MessageType>, Constable
public enum MessageType extends 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.

  • Enum Constant Details

  • Method Details

    • values

      public static MessageType[] 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 MessageType 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

    • 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 .

    • getNewInstance

      public 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 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:
      value - 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

    • valueOf

      public static MessageType valueOf(KafkaMessageEnvelope kafkaMessageEnvelope)
      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:
      kafkaMessageEnvelope - 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