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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Message.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<MessageSystemAttributeName,String>`	`attributes()`	A map of the attributes requested in `ReceiveMessage` to their respective values.
`Map<String,String>`	`attributesAsStrings()`	A map of the attributes requested in `ReceiveMessage` to their respective values.
`String`	`body()`	The message's contents (not URL-encoded).
`static Message.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()`	For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`boolean`	`hasMessageAttributes()`	For responses, this returns true if the service returned a value for the MessageAttributes property.
`String`	`md5OfBody()`	An MD5 digest of the non-URL-encoded message body string.
`String`	`md5OfMessageAttributes()`	An MD5 digest of the non-URL-encoded message attribute string.
`Map<String,MessageAttributeValue>`	`messageAttributes()`	Each message attribute consists of a `Name`, `Type`, and `Value`.
`String`	`messageId()`	A unique identifier for the message.
`String`	`receiptHandle()`	An identifier associated with the act of receiving the message.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Message.Builder>`	`serializableBuilderClass()`
`Message.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Message.Builder,Message>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Message

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

messageId

receiptHandle

md5OfBody

body

attributes

hasAttributes

attributesAsStrings

md5OfMessageAttributes

hasMessageAttributes

messageAttributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields