org.springframework.kafka.listener

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 and Description
BATCH Commit whatever has already been processed before the next poll.
COUNT Commit pending updates after ackCount has been exceeded.
COUNT_TIME Commit pending updates after ackCount has been exceeded or after ackTime has elapsed.
MANUAL User takes responsibility for acks using an AcknowledgingMessageListener.
MANUAL_IMMEDIATE User takes responsibility for acks using an AcknowledgingMessageListener.
RECORD Commit after each record is processed by the listener.
TIME Commit pending updates after ackTime has elapsed.

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RECORD

public static final ContainerProperties.AckMode RECORD

Commit after each record is processed by the listener.

BATCH

public static final ContainerProperties.AckMode BATCH

Commit whatever has already been processed before the next poll.

TIME

public static final ContainerProperties.AckMode TIME

Commit pending updates after ackTime has elapsed.

COUNT

public static final ContainerProperties.AckMode COUNT

Commit pending updates after ackCount has been exceeded.

COUNT_TIME

public static final ContainerProperties.AckMode COUNT_TIME

Commit pending updates after ackCount has been exceeded or after ackTime has elapsed.

MANUAL

public static final ContainerProperties.AckMode MANUAL

User takes responsibility for acks using an AcknowledgingMessageListener.

MANUAL_IMMEDIATE

public static final ContainerProperties.AckMode MANUAL_IMMEDIATE

User takes responsibility for acks using an AcknowledgingMessageListener. The consumer immediately processes the commit.

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 name

java.lang.NullPointerException - if the argument is null