@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class MessageAttributeValue extends Object implements Serializable, Cloneable, StructuredPojo
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).
Constructor and Description |
---|
MessageAttributeValue() |
Modifier and Type | Method and Description |
---|---|
MessageAttributeValue |
clone() |
boolean |
equals(Object obj) |
List<ByteBuffer> |
getBinaryListValues()
Not implemented.
|
ByteBuffer |
getBinaryValue()
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
|
String |
getDataType()
Amazon SQS supports the following logical data types:
String , Number , and
Binary . |
List<String> |
getStringListValues()
Not implemented.
|
String |
getStringValue()
Strings are Unicode with UTF-8 binary encoding.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBinaryListValues(Collection<ByteBuffer> binaryListValues)
Not implemented.
|
void |
setBinaryValue(ByteBuffer binaryValue)
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
|
void |
setDataType(String dataType)
Amazon SQS supports the following logical data types:
String , Number , and
Binary . |
void |
setStringListValues(Collection<String> stringListValues)
Not implemented.
|
void |
setStringValue(String stringValue)
Strings are Unicode with UTF-8 binary encoding.
|
String |
toString()
Returns a string representation of this object.
|
MessageAttributeValue |
withBinaryListValues(ByteBuffer... binaryListValues)
Not implemented.
|
MessageAttributeValue |
withBinaryListValues(Collection<ByteBuffer> binaryListValues)
Not implemented.
|
MessageAttributeValue |
withBinaryValue(ByteBuffer binaryValue)
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
|
MessageAttributeValue |
withDataType(String dataType)
Amazon SQS supports the following logical data types:
String , Number , and
Binary . |
MessageAttributeValue |
withStringListValues(Collection<String> stringListValues)
Not implemented.
|
MessageAttributeValue |
withStringListValues(String... stringListValues)
Not implemented.
|
MessageAttributeValue |
withStringValue(String stringValue)
Strings are Unicode with UTF-8 binary encoding.
|
public void setStringValue(String stringValue)
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
stringValue
- Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.public String getStringValue()
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
public MessageAttributeValue withStringValue(String stringValue)
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
stringValue
- Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.public void setBinaryValue(ByteBuffer 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.
binaryValue
- Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.public ByteBuffer getBinaryValue()
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
ByteBuffer
s are stateful. Calling their get
methods changes their position
. We recommend
using ByteBuffer.asReadOnlyBuffer()
to create a read-only view of the buffer with an independent
position
, and calling get
methods on this rather than directly on the returned ByteBuffer
.
Doing so will ensure that anyone else using the ByteBuffer
will not be affected by changes to the
position
.
public MessageAttributeValue withBinaryValue(ByteBuffer 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.
binaryValue
- Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.public List<String> getStringListValues()
Not implemented. Reserved for future use.
public void setStringListValues(Collection<String> stringListValues)
Not implemented. Reserved for future use.
stringListValues
- Not implemented. Reserved for future use.public MessageAttributeValue withStringListValues(String... stringListValues)
Not implemented. Reserved for future use.
NOTE: This method appends the values to the existing list (if any). Use
setStringListValues(java.util.Collection)
or withStringListValues(java.util.Collection)
if you
want to override the existing values.
stringListValues
- Not implemented. Reserved for future use.public MessageAttributeValue withStringListValues(Collection<String> stringListValues)
Not implemented. Reserved for future use.
stringListValues
- Not implemented. Reserved for future use.public List<ByteBuffer> getBinaryListValues()
Not implemented. Reserved for future use.
public void setBinaryListValues(Collection<ByteBuffer> binaryListValues)
Not implemented. Reserved for future use.
binaryListValues
- Not implemented. Reserved for future use.public MessageAttributeValue withBinaryListValues(ByteBuffer... binaryListValues)
Not implemented. Reserved for future use.
NOTE: This method appends the values to the existing list (if any). Use
setBinaryListValues(java.util.Collection)
or withBinaryListValues(java.util.Collection)
if you
want to override the existing values.
binaryListValues
- Not implemented. Reserved for future use.public MessageAttributeValue withBinaryListValues(Collection<ByteBuffer> binaryListValues)
Not implemented. Reserved for future use.
binaryListValues
- Not implemented. Reserved for future use.public void setDataType(String 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.
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 String getDataType()
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.
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 MessageAttributeValue withDataType(String 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.
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 String toString()
toString
in class Object
Object.toString()
public MessageAttributeValue clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.