Package org.springframework.kafka.listener

Enum Class ContainerProperties.AckMode

java.lang.Object
java.lang.Enum<ContainerProperties.AckMode>
org.springframework.kafka.listener.ContainerProperties.AckMode
All Implemented Interfaces:
Serializable, Comparable<ContainerProperties.AckMode>, Constable
Enclosing class:
ContainerProperties
public static enum ContainerProperties.AckMode extends Enum<ContainerProperties.AckMode>
The offset commit behavior enumeration.

  • Enum Constant Details

    • RECORD

      public static final ContainerProperties.AckMode RECORD
      Commit the offset after each record is processed by the listener.

    • BATCH

      public static final ContainerProperties.AckMode BATCH
      Commit the offsets of all records returned by the previous poll after they all have been processed by the listener.

    • TIME

      public static final ContainerProperties.AckMode TIME
      Commit pending offsets after ackTime has elapsed.

    • COUNT

      public static final ContainerProperties.AckMode COUNT
      Commit pending offsets after ackCount has been exceeded.

    • COUNT_TIME

      public static final ContainerProperties.AckMode COUNT_TIME
      Commit pending offsets after ackCount has been exceeded or after ackTime has elapsed.

    • MANUAL

      public static final ContainerProperties.AckMode MANUAL
      Listener is responsible for acking - use a AcknowledgingMessageListener; acks will be queued and offsets will be committed when all the records returned by the previous poll have been processed by the listener.

    • MANUAL_IMMEDIATE

      public static final ContainerProperties.AckMode MANUAL_IMMEDIATE
      Listener is responsible for acking - use a AcknowledgingMessageListener; the commit will be performed immediately if the Acknowledgment is acknowledged on the calling consumer thread; otherwise, the acks will be queued and offsets will be committed when all the records returned by the previous poll have been processed by the listener; results will be indeterminate if you sometimes acknowledge on the calling thread and sometimes not.

  • Method Details

    • values

      public static ContainerProperties.AckMode[] 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 ContainerProperties.AckMode 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