/* * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.sqs.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Delivers a message to the specified queue. *

* *

* The following list shows the characters (in Unicode) that are allowed in your * message, according to the W3C XML specification: *

*

* #x9 | #xA | #xD | [#x20 * to #xD7FF] | [#xE000 to #xFFFD] | [ * #x10000 to #x10FFFF] *

*

* For more information, see RFC1321. If you send any * characters that aren't included in this list, your request will be rejected. *

*
*/ public class SendMessageRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The URL of the Amazon SQS queue to take action on. *

*

* Queue URLs are case-sensitive. *

*/ private String queueUrl; /** *

* The message to send. String maximum 256 KB in size. For a list of allowed * characters, see the preceding note. *

*/ private String messageBody; /** *

* 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. *

* *

* When you set FifoQueue, you can't set * DelaySeconds per message. You can set this parameter only on * a queue level. *

*
*/ private Integer delaySeconds; /** *

* Each message attribute consists of a Name, Type, and Value. For more * information, see Message Attribute Items in the Amazon SQS Developer Guide. *

*/ private java.util.Map messageAttributes = new java.util.HashMap(); /** *

* 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 SQS Developer Guide. *

* * *

* 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 acknowledgdment 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. *

*/ private String messageDeduplicationId; /** *

* 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. *

* *

* 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. *

*/ private String messageGroupId; /** * Default constructor for SendMessageRequest object. Callers should use the * setter or fluent setter (with...) methods to initialize any additional * object members. */ public SendMessageRequest() { } /** * Constructs a new SendMessageRequest object. Callers should use the setter * or fluent setter (with...) methods to initialize any additional object * members. * * @param queueUrl

* The URL of the Amazon SQS queue to take action on. *

*

* Queue URLs are case-sensitive. *

* @param messageBody

* The message to send. String maximum 256 KB in size. For a list * of allowed characters, see the preceding note. *

*/ public SendMessageRequest(String queueUrl, String messageBody) { setQueueUrl(queueUrl); setMessageBody(messageBody); } /** *

* The URL of the Amazon SQS queue to take action on. *

*

* Queue URLs are case-sensitive. *

* * @return

* The URL of the Amazon SQS queue to take action on. *

*

* Queue URLs are case-sensitive. *

*/ public String getQueueUrl() { return queueUrl; } /** *

* The URL of the Amazon SQS queue to take action on. *

*

* Queue URLs are case-sensitive. *

* * @param queueUrl

* The URL of the Amazon SQS queue to take action on. *

*

* Queue URLs are case-sensitive. *

*/ public void setQueueUrl(String queueUrl) { this.queueUrl = queueUrl; } /** *

* The URL of the Amazon SQS queue to take action on. *

*

* Queue URLs are case-sensitive. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param queueUrl

* The URL of the Amazon SQS queue to take action on. *

*

* Queue URLs are case-sensitive. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SendMessageRequest withQueueUrl(String queueUrl) { this.queueUrl = queueUrl; return this; } /** *

* The message to send. String maximum 256 KB in size. For a list of allowed * characters, see the preceding note. *

* * @return

* The message to send. String maximum 256 KB in size. For a list of * allowed characters, see the preceding note. *

*/ public String getMessageBody() { return messageBody; } /** *

* The message to send. String maximum 256 KB in size. For a list of allowed * characters, see the preceding note. *

* * @param messageBody

* The message to send. String maximum 256 KB in size. For a list * of allowed characters, see the preceding note. *

*/ public void setMessageBody(String messageBody) { this.messageBody = messageBody; } /** *

* The message to send. String maximum 256 KB in size. For a list of allowed * characters, see the preceding note. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param messageBody

* The message to send. String maximum 256 KB in size. For a list * of allowed characters, see the preceding note. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SendMessageRequest withMessageBody(String messageBody) { this.messageBody = messageBody; return this; } /** *

* 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. *

* *

* When you set FifoQueue, you can't set * DelaySeconds per message. You can set this parameter only on * a queue level. *

*
* * @return

* 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. *

* *

* When you set FifoQueue, you can't set * DelaySeconds per message. You can set this parameter * only on a queue level. *

*
*/ public Integer getDelaySeconds() { return 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. *

* *

* When you set FifoQueue, you can't set * DelaySeconds per message. You can set this parameter only on * a queue level. *

*
* * @param 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. *

* *

* When you set FifoQueue, you can't set * DelaySeconds per message. You can set this * parameter only on a queue level. *

*
*/ public void setDelaySeconds(Integer delaySeconds) { this.delaySeconds = 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. *

* *

* When you set FifoQueue, you can't set * DelaySeconds per message. You can set this parameter only on * a queue level. *

*
*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

* *

* When you set FifoQueue, you can't set * DelaySeconds per message. You can set this * parameter only on a queue level. *

*
* @return A reference to this updated object so that method calls can be * chained together. */ public SendMessageRequest withDelaySeconds(Integer delaySeconds) { this.delaySeconds = delaySeconds; return this; } /** *

* Each message attribute consists of a Name, Type, and Value. For more * information, see Message Attribute Items in the Amazon SQS Developer Guide. *

* * @return

* Each message attribute consists of a Name, Type, and Value. For * more information, see Message Attribute Items in the Amazon SQS Developer * Guide. *

*/ public java.util.Map getMessageAttributes() { return messageAttributes; } /** *

* Each message attribute consists of a Name, Type, and Value. For more * information, see Message Attribute Items in the Amazon SQS Developer Guide. *

* * @param messageAttributes

* Each message attribute consists of a Name, Type, and Value. * For more information, see Message Attribute Items in the Amazon SQS Developer * Guide. *

*/ public void setMessageAttributes(java.util.Map messageAttributes) { this.messageAttributes = messageAttributes; } /** *

* Each message attribute consists of a Name, Type, and Value. For more * information, see Message Attribute Items in the Amazon SQS Developer Guide. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param messageAttributes

* Each message attribute consists of a Name, Type, and Value. * For more information, see Message Attribute Items in the Amazon SQS Developer * Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SendMessageRequest withMessageAttributes( java.util.Map messageAttributes) { this.messageAttributes = messageAttributes; return this; } /** *

* Each message attribute consists of a Name, Type, and Value. For more * information, see Message Attribute Items in the Amazon SQS Developer Guide. *

*

* 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. * * @param key The key of the entry to be added into MessageAttributes. * @param value The corresponding value of the entry to be added into * MessageAttributes. * @return A reference to this updated object so that method calls can be * chained together. */ public SendMessageRequest addMessageAttributesEntry(String key, MessageAttributeValue value) { if (null == this.messageAttributes) { this.messageAttributes = new java.util.HashMap(); } if (this.messageAttributes.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.messageAttributes.put(key, value); return this; } /** * Removes all the entries added into MessageAttributes. *

* Returns a reference to this object so that method calls can be chained * together. */ public SendMessageRequest clearMessageAttributesEntries() { this.messageAttributes = null; return this; } /** *

* 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 SQS 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. *

    *
  • *
  • *

    * You can also use ContentBasedDeduplication for messages with * identical content to be treated as duplicates. *

    *
  • *
  • *

    * 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 acknowledgdment 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. *

* * @return

* 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 SQS 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. *

    *
  • *
  • *

    * You can also use ContentBasedDeduplication for * messages with identical content to be treated as duplicates. *

    *
  • *
  • *

    * 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 acknowledgdment 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. *

*/ public String getMessageDeduplicationId() { return 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 SQS 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. *

    *
  • *
  • *

    * You can also use ContentBasedDeduplication for messages with * identical content to be treated as duplicates. *

    *
  • *
  • *

    * 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 acknowledgdment 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. *

* * @param 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 SQS 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. *

    *
  • *
  • *

    * You can also use ContentBasedDeduplication for * messages with identical content to be treated as duplicates. *

    *
  • *
  • *

    * 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 acknowledgdment 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. *

*/ public void setMessageDeduplicationId(String messageDeduplicationId) { this.messageDeduplicationId = 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 SQS 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. *

    *
  • *
  • *

    * You can also use ContentBasedDeduplication for messages with * identical content to be treated as duplicates. *

    *
  • *
  • *

    * 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 acknowledgdment 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 a reference to this object so that method calls can be chained * together. * * @param 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 SQS 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. *

    *
  • *
  • *

    * You can also use ContentBasedDeduplication for * messages with identical content to be treated as duplicates. *

    *
  • *
  • *

    * 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 acknowledgdment 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SendMessageRequest withMessageDeduplicationId(String messageDeduplicationId) { this.messageDeduplicationId = messageDeduplicationId; return this; } /** *

* 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. *

* * @return

* 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. *

*/ public String getMessageGroupId() { return 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. *

* * @param 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. *

*/ public void setMessageGroupId(String messageGroupId) { this.messageGroupId = 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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SendMessageRequest withMessageGroupId(String messageGroupId) { this.messageGroupId = messageGroupId; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getQueueUrl() != null) sb.append("QueueUrl: " + getQueueUrl() + ","); if (getMessageBody() != null) sb.append("MessageBody: " + getMessageBody() + ","); if (getDelaySeconds() != null) sb.append("DelaySeconds: " + getDelaySeconds() + ","); if (getMessageAttributes() != null) sb.append("MessageAttributes: " + getMessageAttributes() + ","); if (getMessageDeduplicationId() != null) sb.append("MessageDeduplicationId: " + getMessageDeduplicationId() + ","); if (getMessageGroupId() != null) sb.append("MessageGroupId: " + getMessageGroupId()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getQueueUrl() == null) ? 0 : getQueueUrl().hashCode()); hashCode = prime * hashCode + ((getMessageBody() == null) ? 0 : getMessageBody().hashCode()); hashCode = prime * hashCode + ((getDelaySeconds() == null) ? 0 : getDelaySeconds().hashCode()); hashCode = prime * hashCode + ((getMessageAttributes() == null) ? 0 : getMessageAttributes().hashCode()); hashCode = prime * hashCode + ((getMessageDeduplicationId() == null) ? 0 : getMessageDeduplicationId() .hashCode()); hashCode = prime * hashCode + ((getMessageGroupId() == null) ? 0 : getMessageGroupId().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SendMessageRequest == false) return false; SendMessageRequest other = (SendMessageRequest) obj; if (other.getQueueUrl() == null ^ this.getQueueUrl() == null) return false; if (other.getQueueUrl() != null && other.getQueueUrl().equals(this.getQueueUrl()) == false) return false; if (other.getMessageBody() == null ^ this.getMessageBody() == null) return false; if (other.getMessageBody() != null && other.getMessageBody().equals(this.getMessageBody()) == false) return false; if (other.getDelaySeconds() == null ^ this.getDelaySeconds() == null) return false; if (other.getDelaySeconds() != null && other.getDelaySeconds().equals(this.getDelaySeconds()) == false) return false; if (other.getMessageAttributes() == null ^ this.getMessageAttributes() == null) return false; if (other.getMessageAttributes() != null && other.getMessageAttributes().equals(this.getMessageAttributes()) == false) return false; if (other.getMessageDeduplicationId() == null ^ this.getMessageDeduplicationId() == null) return false; if (other.getMessageDeduplicationId() != null && other.getMessageDeduplicationId().equals(this.getMessageDeduplicationId()) == false) return false; if (other.getMessageGroupId() == null ^ this.getMessageGroupId() == null) return false; if (other.getMessageGroupId() != null && other.getMessageGroupId().equals(this.getMessageGroupId()) == false) return false; return true; } }