Enum Class Role

java.lang.Object
java.lang.Enum<Role>
io.krabka.streams.schema.Role
All Implemented Interfaces:
Serializable, Comparable<Role>, Constable
public enum Role extends Enum<Role>
Identifies whether a schema belongs to a record key or value.

The role selects the registry subject through the configured SubjectNameStrategy (for example orders-key versus orders-value under the default TopicNameStrategy) and is checked against Kafka's isKey flag when a serde is configured.

Example

var keySerde = AvroSerde.forKey(OrderKey.class, cache);     // Role.KEY
var valueSerde = AvroSerde.forValue(Order.class, cache);    // Role.VALUE
var generic = AvroSerde.generic(schema, cache, Role.VALUE); // explicit role

  • Enum Constant Details

    • KEY

      public static final Role KEY
      The schema describes the record key.

    • VALUE

      public static final Role VALUE
      The schema describes the record value.

  • Method Details

    • values

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