Class Message

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

An Amazon SQS message.

See Also:

  • Method Details

    • messageId

      public final String messageId()

      A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.

      Returns:
      A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.

    • receiptHandle

      public final String receiptHandle()

      An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

      Returns:
      An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

    • md5OfBody

      public final String md5OfBody()

      An MD5 digest of the non-URL-encoded message body string.

      Returns:
      An MD5 digest of the non-URL-encoded message body string.

    • body

      public final String body()

      The message's contents (not URL-encoded).

      Returns:
      The message's contents (not URL-encoded).

    • attributes

      public final Map<MessageSystemAttributeName,String> attributes()

      A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:

      • ApproximateReceiveCount

      • ApproximateFirstReceiveTimestamp

      • MessageDeduplicationId

      • MessageGroupId

      • SenderId

      • SentTimestamp

      • SequenceNumber

      ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

      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 hasAttributes() method.

      Returns:
      A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:

      • ApproximateReceiveCount

      • ApproximateFirstReceiveTimestamp

      • MessageDeduplicationId

      • MessageGroupId

      • SenderId

      • SentTimestamp

      • SequenceNumber

      ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes 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.

    • attributesAsStrings

      public final Map<String,String> attributesAsStrings()

      A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:

      • ApproximateReceiveCount

      • ApproximateFirstReceiveTimestamp

      • MessageDeduplicationId

      • MessageGroupId

      • SenderId

      • SentTimestamp

      • SequenceNumber

      ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

      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 hasAttributes() method.

      Returns:
      A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:

      • ApproximateReceiveCount

      • ApproximateFirstReceiveTimestamp

      • MessageDeduplicationId

      • MessageGroupId

      • SenderId

      • SentTimestamp

      • SequenceNumber

      ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

    • md5OfMessageAttributes

      public final String md5OfMessageAttributes()

      An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

      Returns:
      An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    • 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,MessageAttributeValue> messageAttributes()

      Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

      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:
      Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

    • toBuilder

      public Message.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<Message.Builder,Message>
      Returns:
      a builder for type T

    • builder

      public static Message.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Message.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.