SendMessageRequest (AWS Java SDK for Amazon SQS 1.10.13 API)

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

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class SendMessageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Container for the parameters to the SendMessage operation.
Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check the SDK release notes.

IMPORTANT: The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC-xml/#charsets If you send any characters not included in the list, your request will be rejected. #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]

See Also:
AmazonSQS.sendMessage(SendMessageRequest), Serialized Form

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

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`SendMessageRequest`	`addMessageAttributesEntry(String key, MessageAttributeValue value)` Each message attribute consists of a Name, Type, and Value.
`SendMessageRequest`	`clearMessageAttributesEntries()` Removes all the entries added into MessageAttributes.
`SendMessageRequest`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getDelaySeconds()` The number of seconds (0 to 900 - 15 minutes) 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`	`getQueueUrl()` The URL of the Amazon SQS queue to take action on.
`int`	`hashCode()`
`void`	`setDelaySeconds(Integer delaySeconds)` The number of seconds (0 to 900 - 15 minutes) 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`	`setQueueUrl(String queueUrl)` The URL of the Amazon SQS queue to take action on.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SendMessageRequest`	`withDelaySeconds(Integer delaySeconds)` The number of seconds (0 to 900 - 15 minutes) 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`	`withQueueUrl(String queueUrl)` The URL of the Amazon SQS queue to take action on.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - SendMessageRequest
```
public SendMessageRequest()
```
    Default constructor for a new SendMessageRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this 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 take action on.
    messageBody - The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
- Method Detail
  - getQueueUrl
```
public String getQueueUrl()
```
    The URL of the Amazon SQS queue to take action on.
    
    Returns:
    The URL of the Amazon SQS queue to take action on.
  - setQueueUrl
```
public void setQueueUrl(String queueUrl)
```
    The URL of the Amazon SQS queue to take action on.
    
    Parameters:
    queueUrl - The URL of the Amazon SQS queue to take action on.
  - withQueueUrl
```
public SendMessageRequest withQueueUrl(String queueUrl)
```
    The URL of the Amazon SQS queue to take action on.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    queueUrl - The URL of the Amazon SQS queue to take action on.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getMessageBody
```
public String getMessageBody()
```
    The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
    
    Returns:
    The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
  - setMessageBody
```
public void setMessageBody(String messageBody)
```
    The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
    
    Parameters:
    messageBody - The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
  - withMessageBody
```
public SendMessageRequest withMessageBody(String messageBody)
```
    The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    messageBody - The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDelaySeconds
```
public Integer getDelaySeconds()
```
    The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.
    
    Returns:
    The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.
  - setDelaySeconds
```
public void setDelaySeconds(Integer delaySeconds)
```
    The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.
    
    Parameters:
    delaySeconds - The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.
  - withDelaySeconds
```
public SendMessageRequest withDelaySeconds(Integer delaySeconds)
```
    The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    delaySeconds - The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.
    
    Returns:
    A reference to this updated 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.
    
    Returns:
    Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
  - 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.
    
    Parameters:
    messageAttributes - Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    messageAttributes - Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - addMessageAttributesEntry
```
public SendMessageRequest addMessageAttributesEntry(String key,
                                           MessageAttributeValue value)
```
    Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
    The method adds a new key-value pair into MessageAttributes parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    key - The key of the entry to be added into MessageAttributes.
    value - The corresponding value of the entry to be added into MessageAttributes.
  - clearMessageAttributesEntries
```
public SendMessageRequest clearMessageAttributesEntries()
```
    Removes all the entries added into MessageAttributes.
    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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public SendMessageRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

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

getQueueUrl

setQueueUrl

withQueueUrl

getMessageBody

setMessageBody

withMessageBody

getDelaySeconds

setDelaySeconds

withDelaySeconds

getMessageAttributes

setMessageAttributes

withMessageAttributes

addMessageAttributesEntry

clearMessageAttributesEntries

toString

hashCode

equals

clone