Package org.apache.beam.sdk.io.jms

Enum Class JmsIO.AcknowledgeMode

java.lang.Object

java.lang.Enum<JmsIO.AcknowledgeMode>

org.apache.beam.sdk.io.jms.JmsIO.AcknowledgeMode

All Implemented Interfaces:

Serializable, Comparable<JmsIO.AcknowledgeMode>, Constable

Enclosing class:

JmsIO

public static enum JmsIO.AcknowledgeMode
extends Enum<JmsIO.AcknowledgeMode>

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
CLIENT_ACKNOWLEDGE	Acknowledge on checkpoint finalization with session isolation across checkpoints.
CLIENT_ACKNOWLEDGE_UNSAFE	CLIENT_ACKNOWLEDGE but without session isolation across checkpoints.
INDIVIDUAL_ACKNOWLEDGE	Acknowledge messages individually on checkpoint finalization.

Method Summary

Modifier and Type	Method	Description
static JmsIO.AcknowledgeMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JmsIO.AcknowledgeMode[]	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

CLIENT_ACKNOWLEDGE

public static final JmsIO.AcknowledgeMode CLIENT_ACKNOWLEDGE

Acknowledge on checkpoint finalization with session isolation across checkpoints. Due to that runners may or may not finalize checkpoint in timely minor, unacked messages in unclosed consumer could be stuck when source throughput is zero. When using this mode in low throughput use cases, client-side prefetch buffers should be disabled (e.g. set prefetch=0 for ActiveMQ) in connection factory properties.

CLIENT_ACKNOWLEDGE_UNSAFE

public static final JmsIO.AcknowledgeMode CLIENT_ACKNOWLEDGE_UNSAFE

CLIENT_ACKNOWLEDGE but without session isolation across checkpoints. Acknowledging a message implicitly acknowledge all messages received up to that point per JMS spec. Best for performance but not safe on worker crash or scaling down. Good when best effort delivery is acceptable.

INDIVIDUAL_ACKNOWLEDGE

public static final JmsIO.AcknowledgeMode INDIVIDUAL_ACKNOWLEDGE

Acknowledge messages individually on checkpoint finalization. Recommended for JMS providers that support individual message acknowledgment (e.g., ActiveMQ, Amazon MQ, Artemis, Qpid JMS).

Method Details

values

public static JmsIO.AcknowledgeMode[] 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 JmsIO.AcknowledgeMode 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