Message (AWS Java SDK for Amazon SQS 1.11.665 API)

java.lang.Object
- com.amazonaws.services.sqs.model.Message

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Message
extends Object
implements Serializable, Cloneable

An Amazon SQS message.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Message()

Constructors
Constructor and Description
`Message()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Message`	`addAttributesEntry(String key, String value)`
`Message`	`addMessageAttributesEntry(String key, MessageAttributeValue value)`
`Message`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`Message`	`clearMessageAttributesEntries()` Removes all the entries added into MessageAttributes.
`Message`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributes()` A map of the attributes requested in `ReceiveMessage` to their respective values.
`String`	`getBody()` The message's contents (not URL-encoded).
`String`	`getMD5OfBody()` An MD5 digest of the non-URL-encoded message body string.
`String`	`getMD5OfMessageAttributes()` An MD5 digest of the non-URL-encoded message attribute string.
`Map<String,MessageAttributeValue>`	`getMessageAttributes()` Each message attribute consists of a `Name`, `Type`, and `Value`.
`String`	`getMessageId()` A unique identifier for the message.
`String`	`getReceiptHandle()` An identifier associated with the act of receiving the message.
`int`	`hashCode()`
`void`	`setAttributes(Map<String,String> attributes)` A map of the attributes requested in `ReceiveMessage` to their respective values.
`void`	`setBody(String body)` The message's contents (not URL-encoded).
`void`	`setMD5OfBody(String mD5OfBody)` An MD5 digest of the non-URL-encoded message body string.
`void`	`setMD5OfMessageAttributes(String mD5OfMessageAttributes)` An MD5 digest of the non-URL-encoded message attribute string.
`void`	`setMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)` Each message attribute consists of a `Name`, `Type`, and `Value`.
`void`	`setMessageId(String messageId)` A unique identifier for the message.
`void`	`setReceiptHandle(String receiptHandle)` An identifier associated with the act of receiving the message.
`String`	`toString()` Returns a string representation of this object.
`Message`	`withAttributes(Map<String,String> attributes)` A map of the attributes requested in `ReceiveMessage` to their respective values.
`Message`	`withBody(String body)` The message's contents (not URL-encoded).
`Message`	`withMD5OfBody(String mD5OfBody)` An MD5 digest of the non-URL-encoded message body string.
`Message`	`withMD5OfMessageAttributes(String mD5OfMessageAttributes)` An MD5 digest of the non-URL-encoded message attribute string.
`Message`	`withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)` Each message attribute consists of a `Name`, `Type`, and `Value`.
`Message`	`withMessageId(String messageId)` A unique identifier for the message.
`Message`	`withReceiptHandle(String receiptHandle)` An identifier associated with the act of receiving the message.

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

- Constructor Detail
  - Message
```
public Message()
```
- Method Detail
  - setMessageId
```
public void setMessageId(String messageId)
```
    A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.
    
    Parameters:
    
    messageId - A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.
  - getMessageId
```
public String getMessageId()
```
    A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.
    
    Returns:
    
    A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.
  - withMessageId
```
public Message withMessageId(String messageId)
```
    A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.
    
    Parameters:
    
    messageId - A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReceiptHandle
```
public void setReceiptHandle(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.
    
    Parameters:
    
    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.
  - getReceiptHandle
```
public String getReceiptHandle()
```
    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.
  - withReceiptHandle
```
public Message withReceiptHandle(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMD5OfBody
```
public void setMD5OfBody(String mD5OfBody)
```
    An MD5 digest of the non-URL-encoded message body string.
    
    Parameters:
    
    mD5OfBody - An MD5 digest of the non-URL-encoded message body string.
  - getMD5OfBody
```
public String getMD5OfBody()
```
    An MD5 digest of the non-URL-encoded message body string.
    
    Returns:
    
    An MD5 digest of the non-URL-encoded message body string.
  - withMD5OfBody
```
public Message withMD5OfBody(String mD5OfBody)
```
    An MD5 digest of the non-URL-encoded message body string.
    
    Parameters:
    
    mD5OfBody - An MD5 digest of the non-URL-encoded message body string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBody
```
public void setBody(String body)
```
    The message's contents (not URL-encoded).
    
    Parameters:
    
    body - The message's contents (not URL-encoded).
  - getBody
```
public String getBody()
```
    The message's contents (not URL-encoded).
    
    Returns:
    
    The message's contents (not URL-encoded).
  - withBody
```
public Message withBody(String body)
```
    The message's contents (not URL-encoded).
    
    Parameters:
    
    body - The message's contents (not URL-encoded).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    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.
    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.
  - setAttributes
```
public void setAttributes(Map<String,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.
    Parameters:
    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.
  - withAttributes
```
public Message withAttributes(Map<String,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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public Message addAttributesEntry(String key,
                                  String value)
```
  - clearAttributesEntries
```
public Message clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMD5OfMessageAttributes
```
public void setMD5OfMessageAttributes(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.
    
    Parameters:
    
    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.
  - getMD5OfMessageAttributes
```
public String getMD5OfMessageAttributes()
```
    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.
  - withMD5OfMessageAttributes
```
public Message withMD5OfMessageAttributes(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMessageAttributes
```
public Map<String,MessageAttributeValue> getMessageAttributes()
```
    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.
    
    Returns:
    
    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.
  - setMessageAttributes
```
public void setMessageAttributes(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 Simple Queue Service Developer Guide.
    
    Parameters:
    
    messageAttributes - Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.
  - withMessageAttributes
```
public Message withMessageAttributes(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 Simple Queue Service Developer Guide.
    
    Parameters:
    
    messageAttributes - Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMessageAttributesEntry
```
public Message addMessageAttributesEntry(String key,
                                         MessageAttributeValue value)
```
  - clearMessageAttributesEntries
```
public Message clearMessageAttributesEntries()
```
    Removes all the entries added into MessageAttributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Message clone()
```
    Overrides:
    
    clone in class Object

Class Message

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Message

Method Detail

setMessageId

getMessageId

withMessageId

setReceiptHandle

getReceiptHandle

withReceiptHandle

setMD5OfBody

getMD5OfBody

withMD5OfBody

setBody

getBody

withBody

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

setMD5OfMessageAttributes

getMD5OfMessageAttributes

withMD5OfMessageAttributes

getMessageAttributes

setMessageAttributes

withMessageAttributes

addMessageAttributesEntry

clearMessageAttributesEntries

toString

equals

hashCode

clone