SendMessageRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sqs.model.SendMessageRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`SendMessageRequest()` Default constructor for SendMessageRequest object.
`SendMessageRequest(String queueUrl, String messageBody)` Constructs a new SendMessageRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SendMessageRequest`	`addMessageAttributesEntry(String key, MessageAttributeValue value)`
`SendMessageRequest`	`clearMessageAttributesEntries()` Removes all the entries added into MessageAttributes.
`SendMessageRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Integer`	`getDelaySeconds()` The length of time, in seconds, for which to delay a specific message.
`Map<String,MessageAttributeValue>`	`getMessageAttributes()` Each message attribute consists of a `Name`, `Type`, and `Value`.
`String`	`getMessageBody()` The message to send.
`String`	`getMessageDeduplicationId()` This parameter applies only to FIFO (first-in-first-out) queues.
`String`	`getMessageGroupId()` This parameter applies only to FIFO (first-in-first-out) queues.
`String`	`getQueueUrl()` The URL of the Amazon SQS queue to which a message is sent.
`int`	`hashCode()`
`void`	`setDelaySeconds(Integer delaySeconds)` The length of time, in seconds, for which to delay a specific message.
`void`	`setMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)` Each message attribute consists of a `Name`, `Type`, and `Value`.
`void`	`setMessageBody(String messageBody)` The message to send.
`void`	`setMessageDeduplicationId(String messageDeduplicationId)` This parameter applies only to FIFO (first-in-first-out) queues.
`void`	`setMessageGroupId(String messageGroupId)` This parameter applies only to FIFO (first-in-first-out) queues.
`void`	`setQueueUrl(String queueUrl)` The URL of the Amazon SQS queue to which a message is sent.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SendMessageRequest`	`withDelaySeconds(Integer delaySeconds)` The length of time, in seconds, for which to delay a specific message.
`SendMessageRequest`	`withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)` Each message attribute consists of a `Name`, `Type`, and `Value`.
`SendMessageRequest`	`withMessageBody(String messageBody)` The message to send.
`SendMessageRequest`	`withMessageDeduplicationId(String messageDeduplicationId)` This parameter applies only to FIFO (first-in-first-out) queues.
`SendMessageRequest`	`withMessageGroupId(String messageGroupId)` This parameter applies only to FIFO (first-in-first-out) queues.
`SendMessageRequest`	`withQueueUrl(String queueUrl)` The URL of the Amazon SQS queue to which a message is sent.

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

- Constructor Detail
  - SendMessageRequest
```
public SendMessageRequest()
```
    Default constructor for SendMessageRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
  - SendMessageRequest
```
public SendMessageRequest(String queueUrl,
                          String messageBody)
```
    Constructs a new SendMessageRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    
    queueUrl - The URL of the Amazon SQS queue to which a message is sent.
    
    Queue URLs are case-sensitive.
    
    messageBody - The message to send. The maximum string size is 256 KB.
    
    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
    
    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
    
    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
- Method Detail
  - setQueueUrl
```
public void setQueueUrl(String queueUrl)
```
    The URL of the Amazon SQS queue to which a message is sent.
    
    Queue URLs are case-sensitive.
    
    Parameters:
    
    queueUrl - The URL of the Amazon SQS queue to which a message is sent.
    
    Queue URLs are case-sensitive.
  - getQueueUrl
```
public String getQueueUrl()
```
    The URL of the Amazon SQS queue to which a message is sent.
    
    Queue URLs are case-sensitive.
    
    Returns:
    
    The URL of the Amazon SQS queue to which a message is sent.
    
    Queue URLs are case-sensitive.
  - withQueueUrl
```
public SendMessageRequest withQueueUrl(String queueUrl)
```
    The URL of the Amazon SQS queue to which a message is sent.
    
    Queue URLs are case-sensitive.
    
    Parameters:
    
    queueUrl - The URL of the Amazon SQS queue to which a message is sent.
    
    Queue URLs are case-sensitive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageBody
```
public void setMessageBody(String messageBody)
```
    The message to send. The maximum string size is 256 KB.
    
    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
    
    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
    
    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
    
    Parameters:
    
    messageBody - The message to send. The maximum string size is 256 KB.
    
    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
    
    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
    
    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
  - getMessageBody
```
public String getMessageBody()
```
    The message to send. The maximum string size is 256 KB.
    
    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
    
    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
    
    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
    
    Returns:
    
    The message to send. The maximum string size is 256 KB.
    
    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
    
    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
    
    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
  - withMessageBody
```
public SendMessageRequest withMessageBody(String messageBody)
```
    The message to send. The maximum string size is 256 KB.
    
    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
    
    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
    
    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
    
    Parameters:
    
    messageBody - The message to send. The maximum string size is 256 KB.
    
    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
    
    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
    
    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDelaySeconds
```
public void setDelaySeconds(Integer delaySeconds)
```
    The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.
    
    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
    
    Parameters:
    
    delaySeconds - The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.
    
    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
  - getDelaySeconds
```
public Integer getDelaySeconds()
```
    The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.
    
    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
    
    Returns:
    
    The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.
    
    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
  - withDelaySeconds
```
public SendMessageRequest withDelaySeconds(Integer delaySeconds)
```
    The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.
    
    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
    
    Parameters:
    
    delaySeconds - The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.
    
    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
    
    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 Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide.
    
    Returns:
    
    Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items and Validation 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 Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide.
    
    Parameters:
    
    messageAttributes - Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide.
  - withMessageAttributes
```
public SendMessageRequest withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
```
    Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide.
    
    Parameters:
    
    messageAttributes - Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items and Validation 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 SendMessageRequest addMessageAttributesEntry(String key,
                                                    MessageAttributeValue value)
```
  - clearMessageAttributesEntries
```
public SendMessageRequest clearMessageAttributesEntries()
```
    Removes all the entries added into MessageAttributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageDeduplicationId
```
public void setMessageDeduplicationId(String messageDeduplicationId)
```
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
    - Every message must have a unique MessageDeduplicationId,
      
      You may provide a MessageDeduplicationId explicitly.
      
      If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
      
      If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
      
      If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
    - When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
    - If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
    The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).
    
    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
    
    The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.
    Parameters:
    messageDeduplicationId - This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
    
    Every message must have a unique MessageDeduplicationId,
    
    You may provide a MessageDeduplicationId explicitly.
    
    If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
    
    If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
    
    If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
    
    When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
    
    If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
    
    The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).
    
    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
    
    The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.
  - getMessageDeduplicationId
```
public String getMessageDeduplicationId()
```
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
    - Every message must have a unique MessageDeduplicationId,
      
      You may provide a MessageDeduplicationId explicitly.
      
      If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
      
      If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
      
      If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
    - When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
    - If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
    The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).
    
    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
    
    The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.
    Returns:
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
    
    Every message must have a unique MessageDeduplicationId,
    
    You may provide a MessageDeduplicationId explicitly.
    
    If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
    
    If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
    
    If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
    
    When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
    
    If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
    
    The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).
    
    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
    
    The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.
  - withMessageDeduplicationId
```
public SendMessageRequest withMessageDeduplicationId(String messageDeduplicationId)
```
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
    - Every message must have a unique MessageDeduplicationId,
      
      You may provide a MessageDeduplicationId explicitly.
      
      If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
      
      If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
      
      If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
    - When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
    - If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
    The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).
    
    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
    
    The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.
    Parameters:
    messageDeduplicationId - This parameter applies only to FIFO (first-in-first-out) queues.
    
    The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
    
    Every message must have a unique MessageDeduplicationId,
    
    You may provide a MessageDeduplicationId explicitly.
    
    If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
    
    If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
    
    If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
    
    When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
    
    If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
    
    The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).
    
    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
    
    The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageGroupId
```
public void setMessageGroupId(String messageGroupId)
```
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.
    - You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
    - ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.
    The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.
    
    MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
    Parameters:
    messageGroupId - This parameter applies only to FIFO (first-in-first-out) queues.
    
    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.
    
    You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
    
    ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.
    
    The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.
    
    MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
  - getMessageGroupId
```
public String getMessageGroupId()
```
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.
    - You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
    - ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.
    The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.
    
    MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
    Returns:
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.
    
    You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
    
    ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.
    
    The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.
    
    MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
  - withMessageGroupId
```
public SendMessageRequest withMessageGroupId(String messageGroupId)
```
    This parameter applies only to FIFO (first-in-first-out) queues.
    
    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.
    - You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
    - ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.
    The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.
    
    MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
    Parameters:
    messageGroupId - This parameter applies only to FIFO (first-in-first-out) queues.
    
    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.
    
    You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
    
    ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.
    
    The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
    
    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.
    
    MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
    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; useful for testing and debugging.
    
    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 SendMessageRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class SendMessageRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SendMessageRequest

SendMessageRequest

Method Detail

setQueueUrl

getQueueUrl

withQueueUrl

setMessageBody

getMessageBody

withMessageBody

setDelaySeconds

getDelaySeconds

withDelaySeconds

getMessageAttributes

setMessageAttributes

withMessageAttributes

addMessageAttributesEntry

clearMessageAttributesEntries

setMessageDeduplicationId

getMessageDeduplicationId

withMessageDeduplicationId

setMessageGroupId

getMessageGroupId

withMessageGroupId

toString

equals

hashCode

clone