Message (AWS SDK for Java

Message (AWS SDK for Java - 2.25.21)

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Message.Builder,Message>

An Amazon SQS message.

See Also:

Nested Class Summary
Nested Classes
static interface
Method Summary
A map of the attributes requested in ReceiveMessage to their respective values. A map of the attributes requested in ReceiveMessage to their respective values.
The message's contents (not URL-encoded).
final boolean
final boolean
Indicates whether some other object is "equal to" this one by SDK fields.
final boolean
For responses, this returns true if the service returned a value for the Attributes property.
final int
final boolean
For responses, this returns true if the service returned a value for the MessageAttributes property.
An MD5 digest of the non-URL-encoded message body string.
An MD5 digest of the non-URL-encoded message attribute string.
Each message attribute consists of a Name, Type, and Value.
A unique identifier for the message.
An identifier associated with the act of receiving the message.
Take this object and create a builder that contains all of the current property values of this object.
Returns a string representation of this object.

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
  The message's contents (not URL-encoded).
  Returns:
  The message's contents (not URL-encoded).
- attributes
  A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:
  
  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:
  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
  A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:
  
  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:
  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
  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
  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
- 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: SdkPojoIndicates 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
- sdkFields
  Specified by:
  sdkFields in interface SdkPojo
  Returns:
  List of SdkField in this POJO. May be empty list but should never be null.