@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Message extends Object implements Serializable, Cloneable, StructuredPojo
Information about a message.
Constructor and Description |
---|
Message() |
Modifier and Type | Method and Description |
---|---|
Message |
clone() |
boolean |
equals(Object obj) |
String |
getInputName()
The name of the input into which the message payload is transformed.
|
String |
getMessageId()
The ID to assign to the message.
|
ByteBuffer |
getPayload()
The payload of the message.
|
TimestampValue |
getTimestamp()
The timestamp associated with the message.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setInputName(String inputName)
The name of the input into which the message payload is transformed.
|
void |
setMessageId(String messageId)
The ID to assign to the message.
|
void |
setPayload(ByteBuffer payload)
The payload of the message.
|
void |
setTimestamp(TimestampValue timestamp)
The timestamp associated with the message.
|
String |
toString()
Returns a string representation of this object.
|
Message |
withInputName(String inputName)
The name of the input into which the message payload is transformed.
|
Message |
withMessageId(String messageId)
The ID to assign to the message.
|
Message |
withPayload(ByteBuffer payload)
The payload of the message.
|
Message |
withTimestamp(TimestampValue timestamp)
The timestamp associated with the message.
|
public void setMessageId(String messageId)
The ID to assign to the message. Within each batch sent, each "messageId"
must be unique.
messageId
- The ID to assign to the message. Within each batch sent, each "messageId"
must be unique.public String getMessageId()
The ID to assign to the message. Within each batch sent, each "messageId"
must be unique.
"messageId"
must be unique.public Message withMessageId(String messageId)
The ID to assign to the message. Within each batch sent, each "messageId"
must be unique.
messageId
- The ID to assign to the message. Within each batch sent, each "messageId"
must be unique.public void setInputName(String inputName)
The name of the input into which the message payload is transformed.
inputName
- The name of the input into which the message payload is transformed.public String getInputName()
The name of the input into which the message payload is transformed.
public Message withInputName(String inputName)
The name of the input into which the message payload is transformed.
inputName
- The name of the input into which the message payload is transformed.public void setPayload(ByteBuffer payload)
The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data (in which case you must decode it).
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.
payload
- The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data
(in which case you must decode it).public ByteBuffer getPayload()
The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data (in which case you must decode it).
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 Message withPayload(ByteBuffer payload)
The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data (in which case you must decode it).
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.
payload
- The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data
(in which case you must decode it).public void setTimestamp(TimestampValue timestamp)
The timestamp associated with the message.
timestamp
- The timestamp associated with the message.public TimestampValue getTimestamp()
The timestamp associated with the message.
public Message withTimestamp(TimestampValue timestamp)
The timestamp associated with the message.
timestamp
- The timestamp associated with the message.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.