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

Enum Class ControlMessageType

java.lang.Object
java.lang.Enum<ControlMessageType>
com.linkedin.venice.kafka.protocol.enums.ControlMessageType
All Implemented Interfaces:
VeniceEnumValue, Serializable, Comparable<ControlMessageType>, Constable
public enum ControlMessageType extends Enum<ControlMessageType> implements VeniceEnumValue
A simple enum to map the values of ControlMessage.controlMessageType 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 ControlMessageType[] 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 ControlMessageType 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

    • getNewInstance

      public Object getNewInstance()
      Simple utility function to generate the right type of control message, based on message type.
      Returns:
      an empty instance of either: - StartOfPush - EndOfPush - StartOfSegment - EndOfSegment - StartOfIncrementalPush - EndOfIncrementalPush - TopicSwitch - VersionSwap

    • valueOf

      public static ControlMessageType 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 ControlMessageType valueOf(ControlMessage controlMessage)
      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:
      controlMessage - 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

    • getShallowClassOverhead

      public int getShallowClassOverhead()