/* * Copyright 2018-2023 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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SendMessageRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The URL of the Amazon SQS queue to which a message is sent. *

*

* Queue URLs and names are case-sensitive. *

*/ private String queueUrl; /** *

* The message to send. The minimum size is one character. The maximum size is 256 KiB. *

* *

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

* */ private String messageBody; /** *

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

* */ private Integer delaySeconds; /** *

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

*/ private com.amazonaws.internal.SdkInternalMap messageAttributes; /** *

* The message system attribute to send. Each message system attribute consists of a Name, * Type, and Value. *

* * * */ private com.amazonaws.internal.SdkInternalMap messageSystemAttributes; /** *

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

*

* Amazon SQS continues to keep track of the message deduplication ID even after the message is received and * deleted. *

* *

* The maximum 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 SQS 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 consumers 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: alphanumeric characters and * punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). *

*

* For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide. *

* *

* MessageGroupId is required for FIFO queues. You can't use it for Standard queues. *

* */ private String messageGroupId; /** * Default constructor for SendMessageRequest object. Callers should use the setter or fluent setter (with...) * methods to initialize the object after creating it. */ 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 which a message is sent.

*

* Queue URLs and names are case-sensitive. * @param messageBody * The message to send. The minimum size is one character. The maximum size is 256 KiB. *

* *

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

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

* The URL of the Amazon SQS queue to which a message is sent. *

*

* Queue URLs and names are case-sensitive. *

* * @param queueUrl * The URL of the Amazon SQS queue to which a message is sent.

*

* Queue URLs and names are case-sensitive. */ public void setQueueUrl(String queueUrl) { this.queueUrl = queueUrl; } /** *

* The URL of the Amazon SQS queue to which a message is sent. *

*

* Queue URLs and names are case-sensitive. *

* * @return The URL of the Amazon SQS queue to which a message is sent.

*

* Queue URLs and names are case-sensitive. */ public String getQueueUrl() { return this.queueUrl; } /** *

* The URL of the Amazon SQS queue to which a message is sent. *

*

* Queue URLs and names are case-sensitive. *

* * @param queueUrl * The URL of the Amazon SQS queue to which a message is sent.

*

* Queue URLs and names are case-sensitive. * @return Returns a reference to this object so that method calls can be chained together. */ public SendMessageRequest withQueueUrl(String queueUrl) { setQueueUrl(queueUrl); return this; } /** *

* The message to send. The minimum size is one character. The maximum size is 256 KiB. *

* *

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

* * * @param messageBody * The message to send. The minimum size is one character. The maximum size is 256 KiB.

*

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

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

* The message to send. The minimum size is one character. The maximum size is 256 KiB. *

* *

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

* * * @return The message to send. The minimum size is one character. The maximum size is 256 KiB.

*

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

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

* The message to send. The minimum size is one character. The maximum size is 256 KiB. *

* *

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

* * * @param messageBody * The message to send. The minimum size is one character. The maximum size is 256 KiB.

*

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

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

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

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

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

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

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

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

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

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

* * @return Each message attribute consists of a Name, Type, and Value. For * more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide. */ public java.util.Map getMessageAttributes() { if (messageAttributes == null) { messageAttributes = new com.amazonaws.internal.SdkInternalMap(); } return messageAttributes; } /** *

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

* * @param messageAttributes * Each message attribute consists of a Name, Type, and Value. For * more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide. */ public void setMessageAttributes(java.util.Map messageAttributes) { this.messageAttributes = messageAttributes == null ? null : new com.amazonaws.internal.SdkInternalMap(messageAttributes); } /** *

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

* * @param messageAttributes * Each message attribute consists of a Name, Type, and Value. For * more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public SendMessageRequest withMessageAttributes(java.util.Map messageAttributes) { setMessageAttributes(messageAttributes); return this; } /** * Add a single MessageAttributes entry * * @see SendMessageRequest#withMessageAttributes * @returns a reference to this object so that method calls can be chained together. */ public SendMessageRequest addMessageAttributesEntry(String key, MessageAttributeValue value) { if (null == this.messageAttributes) { this.messageAttributes = new com.amazonaws.internal.SdkInternalMap(); } 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. * * @return Returns a reference to this object so that method calls can be chained together. */ public SendMessageRequest clearMessageAttributesEntries() { this.messageAttributes = null; return this; } /** *

* The message system attribute to send. Each message system attribute consists of a Name, * Type, and Value. *

* *
    *
  • *

    * Currently, the only supported message system attribute is AWSTraceHeader. Its type must be * String and its value must be a correctly formatted X-Ray trace header string. *

    *
    • *
  • *

    * The size of a message system attribute doesn't count towards the total size of a message. *

    *
    • *
* * * @return The message system attribute to send. Each message system attribute consists of a Name, * Type, and Value.

*
    *
  • *

    * Currently, the only supported message system attribute is AWSTraceHeader. Its type must be * String and its value must be a correctly formatted X-Ray trace header string. *

    *
    • *
  • *

    * The size of a message system attribute doesn't count towards the total size of a message. *

    *
    • *
*/ public java.util.Map getMessageSystemAttributes() { if (messageSystemAttributes == null) { messageSystemAttributes = new com.amazonaws.internal.SdkInternalMap(); } return messageSystemAttributes; } /** *

* The message system attribute to send. Each message system attribute consists of a Name, * Type, and Value. *

* *
    *
  • *

    * Currently, the only supported message system attribute is AWSTraceHeader. Its type must be * String and its value must be a correctly formatted X-Ray trace header string. *

    *
    • *
  • *

    * The size of a message system attribute doesn't count towards the total size of a message. *

    *
    • *
* * * @param messageSystemAttributes * The message system attribute to send. Each message system attribute consists of a Name, * Type, and Value.

*
    *
  • *

    * Currently, the only supported message system attribute is AWSTraceHeader. Its type must be * String and its value must be a correctly formatted X-Ray trace header string. *

    *
    • *
  • *

    * The size of a message system attribute doesn't count towards the total size of a message. *

    *
    • *
*/ public void setMessageSystemAttributes(java.util.Map messageSystemAttributes) { this.messageSystemAttributes = messageSystemAttributes == null ? null : new com.amazonaws.internal.SdkInternalMap( messageSystemAttributes); } /** *

* The message system attribute to send. Each message system attribute consists of a Name, * Type, and Value. *

* *
    *
  • *

    * Currently, the only supported message system attribute is AWSTraceHeader. Its type must be * String and its value must be a correctly formatted X-Ray trace header string. *

    *
    • *
  • *

    * The size of a message system attribute doesn't count towards the total size of a message. *

    *
    • *
* * * @param messageSystemAttributes * The message system attribute to send. Each message system attribute consists of a Name, * Type, and Value.

*
    *
  • *

    * Currently, the only supported message system attribute is AWSTraceHeader. Its type must be * String and its value must be a correctly formatted X-Ray trace header string. *

    *
    • *
  • *

    * The size of a message system attribute doesn't count towards the total size of a message. *

    *
    • *
* @return Returns a reference to this object so that method calls can be chained together. */ public SendMessageRequest withMessageSystemAttributes(java.util.Map messageSystemAttributes) { setMessageSystemAttributes(messageSystemAttributes); return this; } /** * Add a single MessageSystemAttributes entry * * @see SendMessageRequest#withMessageSystemAttributes * @returns a reference to this object so that method calls can be chained together. */ public SendMessageRequest addMessageSystemAttributesEntry(String key, MessageSystemAttributeValue value) { if (null == this.messageSystemAttributes) { this.messageSystemAttributes = new com.amazonaws.internal.SdkInternalMap(); } if (this.messageSystemAttributes.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.messageSystemAttributes.put(key, value); return this; } /** * Removes all the entries added into MessageSystemAttributes. * * @return Returns a reference to this object so that method calls can be chained together. */ public SendMessageRequest clearMessageSystemAttributesEntries() { this.messageSystemAttributes = 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. *

    *
    • *
  • *

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

*

* Amazon SQS continues to keep track of the message deduplication ID even after the message is received and * deleted. *

* *

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

    *
    • *
  • *

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

*

* Amazon SQS continues to keep track of the message deduplication ID even after the message is received and * deleted. *

* *

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

    *
    • *
  • *

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

*

* Amazon SQS continues to keep track of the message deduplication ID even after the message is received and * deleted. *

* *

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

    *
    • *
  • *

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

*

* Amazon SQS continues to keep track of the message deduplication ID even after the message is received and * deleted. *

* *

* The maximum 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 SQS Developer Guide. */ public String getMessageDeduplicationId() { return this.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. *

    *
    • *
  • *

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

*

* Amazon SQS continues to keep track of the message deduplication ID even after the message is received and * deleted. *

* *

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

    *
    • *
  • *

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

*

* Amazon SQS continues to keep track of the message deduplication ID even after the message is received and * deleted. *

* *

* The maximum 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 SQS Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public SendMessageRequest withMessageDeduplicationId(String messageDeduplicationId) { setMessageDeduplicationId(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 consumers 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: alphanumeric characters and * punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). *

*

* For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide. *

* *

* MessageGroupId is required for FIFO queues. You can't use it for Standard queues. *

* * * @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 consumers 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: alphanumeric characters and * punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). *

*

* For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide. *

* *

* MessageGroupId is required for FIFO queues. You can't use it for Standard queues. *

*/ 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 consumers 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: alphanumeric characters and * punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). *

*

* For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide. *

* *

* MessageGroupId is required for FIFO queues. You can't use it for Standard queues. *

* * * @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 consumers 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: alphanumeric characters and * punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). *

*

* For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide. *

* *

* MessageGroupId is required for FIFO queues. You can't use it for Standard queues. *

*/ public String getMessageGroupId() { return this.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 consumers 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: alphanumeric characters and * punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). *

*

* For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide. *

* *

* MessageGroupId is required for FIFO queues. You can't use it for Standard queues. *

* * * @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 consumers 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: alphanumeric characters and * punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). *

*

* For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide. *

* *

* MessageGroupId is required for FIFO queues. You can't use it for Standard queues. *

* @return Returns a reference to this object so that method calls can be chained together. */ public SendMessageRequest withMessageGroupId(String messageGroupId) { setMessageGroupId(messageGroupId); return this; } /** * 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. * * @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: ").append(getQueueUrl()).append(","); if (getMessageBody() != null) sb.append("MessageBody: ").append(getMessageBody()).append(","); if (getDelaySeconds() != null) sb.append("DelaySeconds: ").append(getDelaySeconds()).append(","); if (getMessageAttributes() != null) sb.append("MessageAttributes: ").append(getMessageAttributes()).append(","); if (getMessageSystemAttributes() != null) sb.append("MessageSystemAttributes: ").append(getMessageSystemAttributes()).append(","); if (getMessageDeduplicationId() != null) sb.append("MessageDeduplicationId: ").append(getMessageDeduplicationId()).append(","); if (getMessageGroupId() != null) sb.append("MessageGroupId: ").append(getMessageGroupId()); sb.append("}"); return sb.toString(); } @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.getMessageSystemAttributes() == null ^ this.getMessageSystemAttributes() == null) return false; if (other.getMessageSystemAttributes() != null && other.getMessageSystemAttributes().equals(this.getMessageSystemAttributes()) == 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; } @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 + ((getMessageSystemAttributes() == null) ? 0 : getMessageSystemAttributes().hashCode()); hashCode = prime * hashCode + ((getMessageDeduplicationId() == null) ? 0 : getMessageDeduplicationId().hashCode()); hashCode = prime * hashCode + ((getMessageGroupId() == null) ? 0 : getMessageGroupId().hashCode()); return hashCode; } @Override public SendMessageRequest clone() { return (SendMessageRequest) super.clone(); } }