com.amazonaws.services.sqs.model.MessageAttributeValue 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;
/**
*
* The user-specified message attribute value. For string data types, the Value attribute has the same
* restrictions on the content as the message body. For more information, see SendMessage.
*
*
* Name, type, value and the message body must not be empty or null. All parts of
* the message attribute, including Name, Type, and Value, are part of the
* message size restriction (256 KiB or 262,144 bytes).
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class MessageAttributeValue implements Serializable, Cloneable, StructuredPojo {
/**
*
* Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
*
*/
private String stringValue;
/**
*
* Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
*
*/
private java.nio.ByteBuffer binaryValue;
/**
*
* Not implemented. Reserved for future use.
*
*/
private com.amazonaws.internal.SdkInternalList stringListValues;
/**
*
* Not implemented. Reserved for future use.
*
*/
private com.amazonaws.internal.SdkInternalList binaryListValues;
/**
*
* Amazon SQS supports the following logical data types: String, Number, and
* Binary. For the Number data type, you must use StringValue.
*
*
* You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
*
*/
private String dataType;
/**
*
* Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
*
*
* @param stringValue
* Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
*/
public void setStringValue(String stringValue) {
this.stringValue = stringValue;
}
/**
*
* Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
*
*
* @return Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
*/
public String getStringValue() {
return this.stringValue;
}
/**
*
* Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
*
*
* @param stringValue
* Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MessageAttributeValue withStringValue(String stringValue) {
setStringValue(stringValue);
return this;
}
/**
*
* Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param binaryValue
* Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
*/
public void setBinaryValue(java.nio.ByteBuffer binaryValue) {
this.binaryValue = binaryValue;
}
/**
*
* Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
*/
public java.nio.ByteBuffer getBinaryValue() {
return this.binaryValue;
}
/**
*
* Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param binaryValue
* Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MessageAttributeValue withBinaryValue(java.nio.ByteBuffer binaryValue) {
setBinaryValue(binaryValue);
return this;
}
/**
*
* Not implemented. Reserved for future use.
*
*
* @return Not implemented. Reserved for future use.
*/
public java.util.List getStringListValues() {
if (stringListValues == null) {
stringListValues = new com.amazonaws.internal.SdkInternalList();
}
return stringListValues;
}
/**
*
* Not implemented. Reserved for future use.
*
*
* @param stringListValues
* Not implemented. Reserved for future use.
*/
public void setStringListValues(java.util.Collection stringListValues) {
if (stringListValues == null) {
this.stringListValues = null;
return;
}
this.stringListValues = new com.amazonaws.internal.SdkInternalList(stringListValues);
}
/**
*
* Not implemented. Reserved for future use.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setStringListValues(java.util.Collection)} or {@link #withStringListValues(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param stringListValues
* Not implemented. Reserved for future use.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MessageAttributeValue withStringListValues(String... stringListValues) {
if (this.stringListValues == null) {
setStringListValues(new com.amazonaws.internal.SdkInternalList(stringListValues.length));
}
for (String ele : stringListValues) {
this.stringListValues.add(ele);
}
return this;
}
/**
*
* Not implemented. Reserved for future use.
*
*
* @param stringListValues
* Not implemented. Reserved for future use.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MessageAttributeValue withStringListValues(java.util.Collection stringListValues) {
setStringListValues(stringListValues);
return this;
}
/**
*
* Not implemented. Reserved for future use.
*
*
* @return Not implemented. Reserved for future use.
*/
public java.util.List getBinaryListValues() {
if (binaryListValues == null) {
binaryListValues = new com.amazonaws.internal.SdkInternalList();
}
return binaryListValues;
}
/**
*
* Not implemented. Reserved for future use.
*
*
* @param binaryListValues
* Not implemented. Reserved for future use.
*/
public void setBinaryListValues(java.util.Collection binaryListValues) {
if (binaryListValues == null) {
this.binaryListValues = null;
return;
}
this.binaryListValues = new com.amazonaws.internal.SdkInternalList(binaryListValues);
}
/**
*
* Not implemented. Reserved for future use.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setBinaryListValues(java.util.Collection)} or {@link #withBinaryListValues(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param binaryListValues
* Not implemented. Reserved for future use.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MessageAttributeValue withBinaryListValues(java.nio.ByteBuffer... binaryListValues) {
if (this.binaryListValues == null) {
setBinaryListValues(new com.amazonaws.internal.SdkInternalList(binaryListValues.length));
}
for (java.nio.ByteBuffer ele : binaryListValues) {
this.binaryListValues.add(ele);
}
return this;
}
/**
*
* Not implemented. Reserved for future use.
*
*
* @param binaryListValues
* Not implemented. Reserved for future use.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MessageAttributeValue withBinaryListValues(java.util.Collection binaryListValues) {
setBinaryListValues(binaryListValues);
return this;
}
/**
*
* Amazon SQS supports the following logical data types: String, Number, and
* Binary. For the Number data type, you must use StringValue.
*
*
* You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
*
*
* @param dataType
* Amazon SQS supports the following logical data types: String, Number, and
* Binary. For the Number data type, you must use StringValue.
*
* You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
*/
public void setDataType(String dataType) {
this.dataType = dataType;
}
/**
*
* Amazon SQS supports the following logical data types: String, Number, and
* Binary. For the Number data type, you must use StringValue.
*
*
* You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
*
*
* @return Amazon SQS supports the following logical data types: String, Number, and
* Binary. For the Number data type, you must use StringValue.
*
* You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
*/
public String getDataType() {
return this.dataType;
}
/**
*
* Amazon SQS supports the following logical data types: String, Number, and
* Binary. For the Number data type, you must use StringValue.
*
*
* You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
*
*
* @param dataType
* Amazon SQS supports the following logical data types: String, Number, and
* Binary. For the Number data type, you must use StringValue.
*
* You can also append custom labels. 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 MessageAttributeValue withDataType(String dataType) {
setDataType(dataType);
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 (getStringValue() != null)
sb.append("StringValue: ").append(getStringValue()).append(",");
if (getBinaryValue() != null)
sb.append("BinaryValue: ").append(getBinaryValue()).append(",");
if (getStringListValues() != null)
sb.append("StringListValues: ").append(getStringListValues()).append(",");
if (getBinaryListValues() != null)
sb.append("BinaryListValues: ").append(getBinaryListValues()).append(",");
if (getDataType() != null)
sb.append("DataType: ").append(getDataType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof MessageAttributeValue == false)
return false;
MessageAttributeValue other = (MessageAttributeValue) obj;
if (other.getStringValue() == null ^ this.getStringValue() == null)
return false;
if (other.getStringValue() != null && other.getStringValue().equals(this.getStringValue()) == false)
return false;
if (other.getBinaryValue() == null ^ this.getBinaryValue() == null)
return false;
if (other.getBinaryValue() != null && other.getBinaryValue().equals(this.getBinaryValue()) == false)
return false;
if (other.getStringListValues() == null ^ this.getStringListValues() == null)
return false;
if (other.getStringListValues() != null && other.getStringListValues().equals(this.getStringListValues()) == false)
return false;
if (other.getBinaryListValues() == null ^ this.getBinaryListValues() == null)
return false;
if (other.getBinaryListValues() != null && other.getBinaryListValues().equals(this.getBinaryListValues()) == false)
return false;
if (other.getDataType() == null ^ this.getDataType() == null)
return false;
if (other.getDataType() != null && other.getDataType().equals(this.getDataType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStringValue() == null) ? 0 : getStringValue().hashCode());
hashCode = prime * hashCode + ((getBinaryValue() == null) ? 0 : getBinaryValue().hashCode());
hashCode = prime * hashCode + ((getStringListValues() == null) ? 0 : getStringListValues().hashCode());
hashCode = prime * hashCode + ((getBinaryListValues() == null) ? 0 : getBinaryListValues().hashCode());
hashCode = prime * hashCode + ((getDataType() == null) ? 0 : getDataType().hashCode());
return hashCode;
}
@Override
public MessageAttributeValue clone() {
try {
return (MessageAttributeValue) 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.MessageAttributeValueMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}