Interface SqsTemplateOptions

All Superinterfaces:
MessagingTemplateOptions<SqsTemplateOptions>
public interface SqsTemplateOptions extends MessagingTemplateOptions<SqsTemplateOptions>
Sqs specific options for the SqsTemplate.
Since:
3.0.0
Author:
Tomaz Fernandes, Jeongmin Kim

  • Method Details

    • defaultQueue

      SqsTemplateOptions defaultQueue(String defaultQueue)
      Set the default queue for this template. Default is blank.
      Parameters:
      defaultQueue - the default queue.
      Returns:
      the options instance.

    • queueNotFoundStrategy

      SqsTemplateOptions queueNotFoundStrategy(QueueNotFoundStrategy queueNotFoundStrategy)
      The QueueNotFoundStrategy for this template.
      Parameters:
      queueNotFoundStrategy - the strategy.
      Returns:
      the options instance.

    • queueAttributeNames

      SqsTemplateOptions queueAttributeNames(Collection<software.amazon.awssdk.services.sqs.model.QueueAttributeName> queueAttributeNames)
      The queue attribute names that will be retrieved by this template and added as headers to received messages. Default is none.
      Parameters:
      queueAttributeNames - the names.
      Returns:
      the options instance.

    • messageAttributeNames

      SqsTemplateOptions messageAttributeNames(Collection<String> messageAttributeNames)
      The message attributes to be retrieved with the message and added as headers to received messages. Default is ALL.
      Parameters:
      messageAttributeNames - the names.
      Returns:
      the options instance.

    • messageSystemAttributeNames

      SqsTemplateOptions messageSystemAttributeNames(Collection<software.amazon.awssdk.services.sqs.model.MessageSystemAttributeName> messageSystemAttributeNames)
      The message system attributes to be retrieved with the message and added as headers to received messages. Default is ALL.
      Parameters:
      messageSystemAttributeNames - the names.
      Returns:
      the options instance.

    • contentBasedDeduplication

      SqsTemplateOptions contentBasedDeduplication(TemplateContentBasedDeduplication contentBasedDeduplication)
      Set the ContentBasedDeduplication queue attribute value of the queues the template is sending messages to. By default, this is set to AUTO and the queue attribute value will be resolved automatically per queue. If set to ENABLED or DISABLED, the value will apply to all queues.
      Parameters:
      contentBasedDeduplication - the ContentBasedDeduplication value.
      Returns:
      the options instance.

    • observationConvention

      SqsTemplateOptions observationConvention(SqsTemplateObservation.Convention observationConvention)
      Set a custom ObservationConvention to be used by this template.
      Parameters:
      observationConvention - the custom observation convention.
      Returns:
      the options instance.

    • convertMessageIdToUuid

      SqsTemplateOptions convertMessageIdToUuid(boolean convertMessageIdToUuid)
      Set whether to convert SQS message IDs to UUIDs. Set to false for SQS-compatible providers that return non-UUID message IDs.
      Parameters:
      convertMessageIdToUuid - whether to convert message IDs to UUIDs.
      Returns:
      the options instance.