Package com.flowable.core.aws.sqs

Enum SqsMessageDeletionPolicy

java.lang.Object
java.lang.Enum<SqsMessageDeletionPolicy>
com.flowable.core.aws.sqs.SqsMessageDeletionPolicy
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SqsMessageDeletionPolicy>, java.lang.constant.Constable
public enum SqsMessageDeletionPolicy
extends java.lang.Enum<SqsMessageDeletionPolicy>
Deletion policy for messages. Used to decide when a message needs to be deleted.
Author:
Filip Hrisafov

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    ALWAYS
    Always deletes message in case of success (no exception thrown) or failure (exception thrown) during message processing by the listener method.
    NO_REDRIVE
    Always deletes message in case of success (no exception thrown).
    ON_SUCCESS
    Deletes message when successfully executed by the listener method.

  • Method Summary

    Modifier and Type Method Description
    static SqsMessageDeletionPolicy valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static SqsMessageDeletionPolicy[] 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, 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

    • ALWAYS

      public static final SqsMessageDeletionPolicy ALWAYS
      Always deletes message in case of success (no exception thrown) or failure (exception thrown) during message processing by the listener method.

    • NO_REDRIVE

      public static final SqsMessageDeletionPolicy NO_REDRIVE
      Always deletes message in case of success (no exception thrown). On failure (exception thrown) deletes messages only if the queue has no redrive policy.

    • ON_SUCCESS

      public static final SqsMessageDeletionPolicy ON_SUCCESS
      Deletes message when successfully executed by the listener method. If an exception is thrown by the listener method, the message will not be deleted.

  • Method Details

    • values

      public static SqsMessageDeletionPolicy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static SqsMessageDeletionPolicy 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