docs(batch-processing): Support for moving non retryable msg to DLQ

Author: Pankaj Agrawal

powertools-sqs/src/main/java/software/amazon/lambda/powertools/sqs/SqsBatch.java

@@ -33,9 +33,9 @@
  * </p>
  *
  * <p>
- * If you want certain exceptions to be treated as permanent failures, i.e. exceptions which are not worth retrying and
- * want such message should be moved to configured dead letter queue of the source SQS queue, you can use
- * {@link SqsBatch#nonRetryableExceptions()} to configure such exceptions.
+ * If you want certain exceptions to be treated as permanent failures, i.e. exceptions where the result of retrying will
+ * always be a failure and want such message should be moved to configured dead letter queue of the source SQS queue, you
+ * can use {@link SqsBatch#nonRetryableExceptions()} to configure such exceptions.
  * If you want such messages to be deleted instead, set {@link SqsBatch#deleteNonRetryableMessageFromQueue()} to true.
  * By default its value is false.
  *

powertools-sqs/src/main/java/software/amazon/lambda/powertools/sqs/SqsUtils.java

@@ -158,9 +158,9 @@ public static <R> List<R> batchProcessor(final SQSEvent event,
      * </p>
      *
      * <p>
-     * If you want certain exceptions to be treated as permanent failures, i.e. exceptions which are not worth retrying and
-     * want such message should be moved to configured dead letter queue of the source SQS queue, you can use
-     * {@link SqsBatch#nonRetryableExceptions()} to configure such exceptions.
+     * If you want certain exceptions to be treated as permanent failures, i.e. exceptions where the result of retrying will
+     * always be a failure and want such message should be moved to configured dead letter queue of the source SQS queue, you
+     * can use nonRetryableExceptions parameter to configure such exceptions.
      *
      * If there is no DLQ configured on source SQS queue and {@link SqsBatch#nonRetryableExceptions()} attribute is set, if
      * nonRetryableExceptions occurs from {@link SqsMessageHandler}, such exceptions will still be treated as temporary
@@ -244,9 +244,9 @@ public static <R> List<R> batchProcessor(final SQSEvent event,
      * </p>
      *
      * <p>
-     * If you want certain exceptions to be treated as permanent failures, i.e. exceptions which are not worth retrying and
-     * want such message should be moved to configured dead letter queue of the source SQS queue, you can use
-     * {@link SqsBatch#nonRetryableExceptions()} to configure such exceptions.
+     * If you want certain exceptions to be treated as permanent failures, i.e. exceptions where the result of retrying will
+     * always be a failure and want such message should be moved to configured dead letter queue of the source SQS queue, you
+     * can use nonRetryableExceptions parameter to configure such exceptions.
      *
      * If there is no DLQ configured on source SQS queue and {@link SqsBatch#nonRetryableExceptions()} attribute is set, if
      * nonRetryableExceptions occurs from {@link SqsMessageHandler}, such exceptions will still be treated as temporary
@@ -300,10 +300,10 @@ public static <R> List<R> batchProcessor(final SQSEvent event,
      * </p>
      *
      * <p>
-     * If you want certain exceptions to be treated as permanent failures, i.e. exceptions which are not worth retrying and
-     * want such message should be moved to configured dead letter queue of the source SQS queue, you can use
-     * {@link SqsBatch#nonRetryableExceptions()} to configure such exceptions. If you want such messages to be deleted
-     * instead, set deleteNonRetryableMessageFromQueue to true.
+     * If you want certain exceptions to be treated as permanent failures, i.e. exceptions where the result of retrying will
+     * always be a failure and want such message should be moved to configured dead letter queue of the source SQS queue, you
+     * can use nonRetryableExceptions parameter to configure such exceptions.
+     * If you want such messages to be deleted instead, set deleteNonRetryableMessageFromQueue to true.
      *
      * If there is no DLQ configured on source SQS queue and {@link SqsBatch#nonRetryableExceptions()} attribute is set, if
      * nonRetryableExceptions occurs from {@link SqsMessageHandler}, such exceptions will still be treated as temporary
@@ -393,9 +393,9 @@ public static <R> List<R> batchProcessor(final SQSEvent event,
      * </p>
      *
      * <p>
-     * If you want certain exceptions to be treated as permanent failures, i.e. exceptions which are not worth retrying and
-     * want such message should be moved to configured dead letter queue of the source SQS queue, you can use
-     * {@link SqsBatch#nonRetryableExceptions()} to configure such exceptions.
+     * If you want certain exceptions to be treated as permanent failures, i.e. exceptions where the result of retrying will
+     * always be a failure and want such message should be moved to configured dead letter queue of the source SQS queue, you
+     * can use nonRetryableExceptions parameter to configure such exceptions.
      *
      * If there is no DLQ configured on source SQS queue and {@link SqsBatch#nonRetryableExceptions()} attribute is set, if
      * nonRetryableExceptions occurs from {@link SqsMessageHandler}, such exceptions will still be treated as temporary