Enum ContainerProperties.AckMode
- java.lang.Object
-
- java.lang.Enum<ContainerProperties.AckMode>
-
- org.springframework.kafka.listener.ContainerProperties.AckMode
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ContainerProperties.AckMode>
- Enclosing class:
- ContainerProperties
public static enum ContainerProperties.AckMode extends java.lang.Enum<ContainerProperties.AckMode>
The offset commit behavior enumeration.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BATCH
Commit the offsets of all records returned by the previous poll after they all have been processed by the listener.COUNT
Commit pending offsets afterackCount
has been exceeded.COUNT_TIME
MANUAL
Listener is responsible for acking - use aAcknowledgingMessageListener
; 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
Listener is responsible for acking - use aAcknowledgingMessageListener
; the commit will be performed immediately if theAcknowledgment
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.RECORD
Commit the offset after each record is processed by the listener.TIME
Commit pending offsets afterackTime
has elapsed.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static ContainerProperties.AckMode
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static ContainerProperties.AckMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 afterackTime
has elapsed.
-
COUNT
public static final ContainerProperties.AckMode COUNT
Commit pending offsets afterackCount
has been exceeded.
-
COUNT_TIME
public static final ContainerProperties.AckMode COUNT_TIME
-
MANUAL
public static final ContainerProperties.AckMode MANUAL
Listener is responsible for acking - use aAcknowledgingMessageListener
; 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 aAcknowledgingMessageListener
; the commit will be performed immediately if theAcknowledgment
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 Detail
-
values
public static ContainerProperties.AckMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ContainerProperties.AckMode c : ContainerProperties.AckMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ContainerProperties.AckMode valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-