Package io.awspring.cloud.sqs.listener

Class SqsContainerOptions

java.lang.Object
io.awspring.cloud.sqs.listener.AbstractContainerOptions<SqsContainerOptions,SqsContainerOptionsBuilder>
io.awspring.cloud.sqs.listener.SqsContainerOptions
All Implemented Interfaces:
ContainerOptions<SqsContainerOptions,SqsContainerOptionsBuilder>
public class SqsContainerOptions extends AbstractContainerOptions<SqsContainerOptions,SqsContainerOptionsBuilder>
Sqs specific implementation of ContainerOptions.
Since:
3.0
Author:
Tomaz Fernandes

  • Constructor Details

    • SqsContainerOptions

      protected SqsContainerOptions(io.awspring.cloud.sqs.listener.SqsContainerOptions.BuilderImpl builder)
      Create a ContainerOptions instance from the builder.
      Parameters:
      builder - the builder.

  • Method Details

    • builder

      public static SqsContainerOptionsBuilder builder()
      Create a new builder instance.
      Returns:
      the new builder instance.

    • getQueueAttributeNames

      public Collection<software.amazon.awssdk.services.sqs.model.QueueAttributeName> getQueueAttributeNames()
      Get the QueueAttributeNames that will be retrieved from the queue and added as headers to the messages.
      Returns:
      the names.

    • getMessageAttributeNames

      public Collection<String> getMessageAttributeNames()
      Get the messageAttributeNames that will be retrieved and added as headers in messages. Default is ALL.
      Returns:
      the names.

    • getMessageSystemAttributeNames

      public Collection<String> getMessageSystemAttributeNames()
      Get the MessageSystemAttributeNames that will be retrieved and added as headers in messages.
      Returns:
      the names.

    • getMessageVisibility

      @Nullable public Duration getMessageVisibility()
      Get the message visibility for messages retrieved by the container.
      Returns:
      the visibility.

    • getFifoBatchGroupingStrategy

      public FifoBatchGroupingStrategy getFifoBatchGroupingStrategy()
      Get messages grouping strategy in FIFO queues when retrieved by the container in listener mode ListenerMode.BATCH.
      Returns:
      the fifo batch message grouping strategy.

    • getQueueNotFoundStrategy

      public QueueNotFoundStrategy getQueueNotFoundStrategy()
      Get the QueueNotFoundStrategy for the container.
      Returns:
      the strategy.

    • toBuilder

      public SqsContainerOptionsBuilder toBuilder()
      Description copied from interface: ContainerOptions
      Creates a new ) instance configured with this options. Note that any changes made to the builder will have no effect on this object.
      Returns:
      the new builder instance.