Package io.aiven.kafka.connect.amqp.common.config

Enum Class AmqpFormat

java.lang.Object
java.lang.Enum<AmqpFormat>
io.aiven.kafka.connect.amqp.common.config.AmqpFormat
All Implemented Interfaces:
Serializable, Comparable<AmqpFormat>, Constable
public enum AmqpFormat extends Enum<AmqpFormat>
Definition of the AMQP input/output format.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BODY
    The body of the AMQP message is extracted and placed into the Kafka value, the Kafka value schema is set appropriately for the value, the Key is the key specified by the AMQP message or an ULID string if none was provided.
    NOT_AMQP
    (Only valid for sink) The Kafka message did not an originate as an AMQP message.
    RAW
    AMQP message is encoded into its native byte buffer format and passed to Kafka as a byte[], the Key is the key specified by the AMQP message or an ULID string if none was provided.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Gets the description of the use of this format.
    static AmqpFormat
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static AmqpFormat[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • RAW

      public static final AmqpFormat RAW
      AMQP message is encoded into its native byte buffer format and passed to Kafka as a byte[], the Key is the key specified by the AMQP message or an ULID string if none was provided. All properties, annotations, and footers are copied into Kafka message headers with values prefixed by 'amqp.'

    • BODY

      public static final AmqpFormat BODY
      The body of the AMQP message is extracted and placed into the Kafka value, the Kafka value schema is set appropriately for the value, the Key is the key specified by the AMQP message or an ULID string if none was provided. All properties, annotations, and footers are copied into Kafka message headers with values prefixed by 'amqp.'

    • NOT_AMQP

      public static final AmqpFormat NOT_AMQP
      (Only valid for sink) The Kafka message did not an originate as an AMQP message. The AMQP body will be set with the value from the Kafka message, the AMQP key will be set with the key from the Kafka message. All Kafka headers that are prefixed with "amqp." and are associated with AMQP properties, annotations, or footers will be used to set the appropriate values in the AMQP message.

  • Method Details

    • values

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

    • getDescription

      public String getDescription()
      Gets the description of the use of this format.
      Returns:
      the description of the use of this format.