Class SqsParameters

java.lang.Object
software.amazon.awssdk.services.eventbridgev2.model.SqsParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SqsParameters.Builder,SqsParameters>
@Generated("software.amazon.awssdk:codegen") public final class SqsParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SqsParameters.Builder,SqsParameters>

SQS invocation parameters for subscribers. Values are forwarded to the SQS SendMessageBatch API. All scalar values accept a literal or a JSONata expression (e.g. "{% $events.Data.groupId %}").

See Also:

  • Method Details

    • messageGroupId

      public final String messageGroupId()

      Message group ID for FIFO queues. Accepts JSONata expression.

      Returns:
      Message group ID for FIFO queues. Accepts JSONata expression.

    • messageDeduplicationId

      public final String messageDeduplicationId()

      Message deduplication ID for FIFO queues. Accepts JSONata expression.

      Returns:
      Message deduplication ID for FIFO queues. Accepts JSONata expression.

    • delaySeconds

      public final String delaySeconds()

      Delay in seconds before the message becomes visible, standard queues only. Accepts JSONata expression.

      Returns:
      Delay in seconds before the message becomes visible, standard queues only. Accepts JSONata expression.

    • hasMessageAttributes

      public final boolean hasMessageAttributes()
      For responses, this returns true if the service returned a value for the MessageAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • messageAttributes

      public final Map<String,SqsMessageAttributeValue> messageAttributes()

      Custom message attributes (name/type/value).

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMessageAttributes() method.

      Returns:
      Custom message attributes (name/type/value).

    • hasMessageSystemAttributes

      public final boolean hasMessageSystemAttributes()
      For responses, this returns true if the service returned a value for the MessageSystemAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • messageSystemAttributes

      public final Map<String,SqsMessageAttributeValue> messageSystemAttributes()

      System message attributes (e.g., AWSTraceHeader).

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMessageSystemAttributes() method.

      Returns:
      System message attributes (e.g., AWSTraceHeader).

    • toBuilder

      public SqsParameters.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SqsParameters.Builder,SqsParameters>
      Returns:
      a builder for type T

    • builder

      public static SqsParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SqsParameters.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.