com.amazonaws.services.sqs.model.Message Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sqs Show documentation
/*
* Copyright 2019-2024 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.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* An Amazon SQS message.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Message implements Serializable, Cloneable, StructuredPojo {
/**
*
* A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services
* accounts for an extended period of time.
*
*/
private String messageId;
/**
*
* An identifier associated with the act of receiving the message. A new receipt handle is returned every time you
* receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
*
*/
private String receiptHandle;
/**
*
* An MD5 digest of the non-URL-encoded message body string.
*
*/
private String mD5OfBody;
/**
*
* The message's contents (not URL-encoded).
*
*/
private String body;
/**
*
* A map of the attributes requested in ReceiveMessage to their respective values. Supported
* attributes:
*
*
* -
*
* ApproximateReceiveCount
*
*
* -
*
* ApproximateFirstReceiveTimestamp
*
*
* -
*
* MessageDeduplicationId
*
*
* -
*
* MessageGroupId
*
*
* -
*
* SenderId
*
*
* -
*
* SentTimestamp
*
*
* -
*
* SequenceNumber
*
*
*
*
* ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer
* representing the epoch time in milliseconds.
*
*/
private com.amazonaws.internal.SdkInternalMap attributes;
/**
*
* An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon
* SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For
* information about MD5, see RFC1321.
*
*/
private String mD5OfMessageAttributes;
/**
*
* 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;
/**
*
* A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services
* accounts for an extended period of time.
*
*
* @param messageId
* A unique identifier for the message. A MessageIdis considered unique across all Amazon Web
* Services accounts for an extended period of time.
*/
public void setMessageId(String messageId) {
this.messageId = messageId;
}
/**
*
* A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services
* accounts for an extended period of time.
*
*
* @return A unique identifier for the message. A MessageIdis considered unique across all Amazon Web
* Services accounts for an extended period of time.
*/
public String getMessageId() {
return this.messageId;
}
/**
*
* A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services
* accounts for an extended period of time.
*
*
* @param messageId
* A unique identifier for the message. A MessageIdis considered unique across all Amazon Web
* Services accounts for an extended period of time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Message withMessageId(String messageId) {
setMessageId(messageId);
return this;
}
/**
*
* An identifier associated with the act of receiving the message. A new receipt handle is returned every time you
* receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
*
*
* @param receiptHandle
* An identifier associated with the act of receiving the message. A new receipt handle is returned every
* time you receive a message. When deleting a message, you provide the last received receipt handle to
* delete the message.
*/
public void setReceiptHandle(String receiptHandle) {
this.receiptHandle = receiptHandle;
}
/**
*
* An identifier associated with the act of receiving the message. A new receipt handle is returned every time you
* receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
*
*
* @return An identifier associated with the act of receiving the message. A new receipt handle is returned every
* time you receive a message. When deleting a message, you provide the last received receipt handle to
* delete the message.
*/
public String getReceiptHandle() {
return this.receiptHandle;
}
/**
*
* An identifier associated with the act of receiving the message. A new receipt handle is returned every time you
* receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
*
*
* @param receiptHandle
* An identifier associated with the act of receiving the message. A new receipt handle is returned every
* time you receive a message. When deleting a message, you provide the last received receipt handle to
* delete the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Message withReceiptHandle(String receiptHandle) {
setReceiptHandle(receiptHandle);
return this;
}
/**
*
* An MD5 digest of the non-URL-encoded message body string.
*
*
* @param mD5OfBody
* An MD5 digest of the non-URL-encoded message body string.
*/
public void setMD5OfBody(String mD5OfBody) {
this.mD5OfBody = mD5OfBody;
}
/**
*
* An MD5 digest of the non-URL-encoded message body string.
*
*
* @return An MD5 digest of the non-URL-encoded message body string.
*/
public String getMD5OfBody() {
return this.mD5OfBody;
}
/**
*
* An MD5 digest of the non-URL-encoded message body string.
*
*
* @param mD5OfBody
* An MD5 digest of the non-URL-encoded message body string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Message withMD5OfBody(String mD5OfBody) {
setMD5OfBody(mD5OfBody);
return this;
}
/**
*
* The message's contents (not URL-encoded).
*
*
* @param body
* The message's contents (not URL-encoded).
*/
public void setBody(String body) {
this.body = body;
}
/**
*
* The message's contents (not URL-encoded).
*
*
* @return The message's contents (not URL-encoded).
*/
public String getBody() {
return this.body;
}
/**
*
* The message's contents (not URL-encoded).
*
*
* @param body
* The message's contents (not URL-encoded).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Message withBody(String body) {
setBody(body);
return this;
}
/**
*
* A map of the attributes requested in ReceiveMessage to their respective values. Supported
* attributes:
*
*
* -
*
* ApproximateReceiveCount
*
*
* -
*
* ApproximateFirstReceiveTimestamp
*
*
* -
*
* MessageDeduplicationId
*
*
* -
*
* MessageGroupId
*
*
* -
*
* SenderId
*
*
* -
*
* SentTimestamp
*
*
* -
*
* SequenceNumber
*
*
*
*
* ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer
* representing the epoch time in milliseconds.
*
*
* @return A map of the attributes requested in ReceiveMessage to their respective values.
* Supported attributes:
*
* -
*
* ApproximateReceiveCount
*
*
* -
*
* ApproximateFirstReceiveTimestamp
*
*
* -
*
* MessageDeduplicationId
*
*
* -
*
* MessageGroupId
*
*
* -
*
* SenderId
*
*
* -
*
* SentTimestamp
*
*
* -
*
* SequenceNumber
*
*
*
*
* ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an
* integer representing the epoch time in milliseconds.
*/
public java.util.Map getAttributes() {
if (attributes == null) {
attributes = new com.amazonaws.internal.SdkInternalMap();
}
return attributes;
}
/**
*
* A map of the attributes requested in ReceiveMessage to their respective values. Supported
* attributes:
*
*
* -
*
* ApproximateReceiveCount
*
*
* -
*
* ApproximateFirstReceiveTimestamp
*
*
* -
*
* MessageDeduplicationId
*
*
* -
*
* MessageGroupId
*
*
* -
*
* SenderId
*
*
* -
*
* SentTimestamp
*
*
* -
*
* SequenceNumber
*
*
*
*
* ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer
* representing the epoch time in milliseconds.
*
*
* @param attributes
* A map of the attributes requested in ReceiveMessage to their respective values.
* Supported attributes:
*
* -
*
* ApproximateReceiveCount
*
*
* -
*
* ApproximateFirstReceiveTimestamp
*
*
* -
*
* MessageDeduplicationId
*
*
* -
*
* MessageGroupId
*
*
* -
*
* SenderId
*
*
* -
*
* SentTimestamp
*
*
* -
*
* SequenceNumber
*
*
*
*
* ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an
* integer representing the epoch time in milliseconds.
*/
public void setAttributes(java.util.Map attributes) {
this.attributes = attributes == null ? null : new com.amazonaws.internal.SdkInternalMap(attributes);
}
/**
*
* A map of the attributes requested in ReceiveMessage to their respective values. Supported
* attributes:
*
*
* -
*
* ApproximateReceiveCount
*
*
* -
*
* ApproximateFirstReceiveTimestamp
*
*
* -
*
* MessageDeduplicationId
*
*
* -
*
* MessageGroupId
*
*
* -
*
* SenderId
*
*
* -
*
* SentTimestamp
*
*
* -
*
* SequenceNumber
*
*
*
*
* ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer
* representing the epoch time in milliseconds.
*
*
* @param attributes
* A map of the attributes requested in ReceiveMessage to their respective values.
* Supported attributes:
*
* -
*
* ApproximateReceiveCount
*
*
* -
*
* ApproximateFirstReceiveTimestamp
*
*
* -
*
* MessageDeduplicationId
*
*
* -
*
* MessageGroupId
*
*
* -
*
* SenderId
*
*
* -
*
* SentTimestamp
*
*
* -
*
* SequenceNumber
*
*
*
*
* ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an
* integer representing the epoch time in milliseconds.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Message withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* Add a single Attributes entry
*
* @see Message#withAttributes
* @returns a reference to this object so that method calls can be chained together.
*/
public Message addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new com.amazonaws.internal.SdkInternalMap();
}
if (this.attributes.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.attributes.put(key, value);
return this;
}
/**
* Removes all the entries added into Attributes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Message clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
*
* An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon
* SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For
* information about MD5, see RFC1321.
*
*
* @param mD5OfMessageAttributes
* An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that
* Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5
* digest. For information about MD5, see RFC1321.
*/
public void setMD5OfMessageAttributes(String mD5OfMessageAttributes) {
this.mD5OfMessageAttributes = mD5OfMessageAttributes;
}
/**
*
* An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon
* SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For
* information about MD5, see RFC1321.
*
*
* @return An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that
* Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5
* digest. For information about MD5, see RFC1321.
*/
public String getMD5OfMessageAttributes() {
return this.mD5OfMessageAttributes;
}
/**
*
* An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon
* SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For
* information about MD5, see RFC1321.
*
*
* @param mD5OfMessageAttributes
* An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that
* Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5
* digest. For information about MD5, see RFC1321.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Message withMD5OfMessageAttributes(String mD5OfMessageAttributes) {
setMD5OfMessageAttributes(mD5OfMessageAttributes);
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 Message withMessageAttributes(java.util.Map messageAttributes) {
setMessageAttributes(messageAttributes);
return this;
}
/**
* Add a single MessageAttributes entry
*
* @see Message#withMessageAttributes
* @returns a reference to this object so that method calls can be chained together.
*/
public Message 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 Message clearMessageAttributesEntries() {
this.messageAttributes = null;
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 (getMessageId() != null)
sb.append("MessageId: ").append(getMessageId()).append(",");
if (getReceiptHandle() != null)
sb.append("ReceiptHandle: ").append(getReceiptHandle()).append(",");
if (getMD5OfBody() != null)
sb.append("MD5OfBody: ").append(getMD5OfBody()).append(",");
if (getBody() != null)
sb.append("Body: ").append(getBody()).append(",");
if (getAttributes() != null)
sb.append("Attributes: ").append(getAttributes()).append(",");
if (getMD5OfMessageAttributes() != null)
sb.append("MD5OfMessageAttributes: ").append(getMD5OfMessageAttributes()).append(",");
if (getMessageAttributes() != null)
sb.append("MessageAttributes: ").append(getMessageAttributes());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Message == false)
return false;
Message other = (Message) obj;
if (other.getMessageId() == null ^ this.getMessageId() == null)
return false;
if (other.getMessageId() != null && other.getMessageId().equals(this.getMessageId()) == false)
return false;
if (other.getReceiptHandle() == null ^ this.getReceiptHandle() == null)
return false;
if (other.getReceiptHandle() != null && other.getReceiptHandle().equals(this.getReceiptHandle()) == false)
return false;
if (other.getMD5OfBody() == null ^ this.getMD5OfBody() == null)
return false;
if (other.getMD5OfBody() != null && other.getMD5OfBody().equals(this.getMD5OfBody()) == false)
return false;
if (other.getBody() == null ^ this.getBody() == null)
return false;
if (other.getBody() != null && other.getBody().equals(this.getBody()) == false)
return false;
if (other.getAttributes() == null ^ this.getAttributes() == null)
return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false)
return false;
if (other.getMD5OfMessageAttributes() == null ^ this.getMD5OfMessageAttributes() == null)
return false;
if (other.getMD5OfMessageAttributes() != null && other.getMD5OfMessageAttributes().equals(this.getMD5OfMessageAttributes()) == false)
return false;
if (other.getMessageAttributes() == null ^ this.getMessageAttributes() == null)
return false;
if (other.getMessageAttributes() != null && other.getMessageAttributes().equals(this.getMessageAttributes()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getMessageId() == null) ? 0 : getMessageId().hashCode());
hashCode = prime * hashCode + ((getReceiptHandle() == null) ? 0 : getReceiptHandle().hashCode());
hashCode = prime * hashCode + ((getMD5OfBody() == null) ? 0 : getMD5OfBody().hashCode());
hashCode = prime * hashCode + ((getBody() == null) ? 0 : getBody().hashCode());
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
hashCode = prime * hashCode + ((getMD5OfMessageAttributes() == null) ? 0 : getMD5OfMessageAttributes().hashCode());
hashCode = prime * hashCode + ((getMessageAttributes() == null) ? 0 : getMessageAttributes().hashCode());
return hashCode;
}
@Override
public Message clone() {
try {
return (Message) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.sqs.model.transform.MessageMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}