org.springframework.cloud.gcp.pubsub.integration

Enum AckMode

java.lang.Object

java.lang.Enum<AckMode>

org.springframework.cloud.gcp.pubsub.integration.AckMode

All Implemented Interfaces:

Serializable, Comparable<AckMode>

public enum AckMode
extends Enum<AckMode>

Determines acknowledgement policy for incoming messages from Google Cloud Pub/Sub.

Author:

João André Martins, Doug Hoard

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO The framework acks the PubsubMessage after it is sent to the channel and processed successfully.
AUTO_ACK The framework acks the PubsubMessage after it is sent to the channel and processed successfully.
MANUAL The framework does not ack / nack the message.

Method Summary

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

MANUAL

public static final AckMode MANUAL

The framework does not ack / nack the message. The AckReplyConsumer is sent back to the user for acking or nacking the PubsubMessage.

AUTO

public static final AckMode AUTO

The framework acks the PubsubMessage after it is sent to the channel and processed successfully.

The framework nacks the PubsubMessage when an exception occurs while processing the message.

AUTO_ACK

public static final AckMode AUTO_ACK

The framework acks the PubsubMessage after it is sent to the channel and processed successfully.

The framework does not immediately nack the message when the exception occurs, and allows the eventual redelivery to take effect.

Since:

1.1

Method Detail

values

public static 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 (AckMode c : 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 AckMode valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null