com.amazonaws.services.iotanalytics.model

Class Message

java.lang.Object

com.amazonaws.services.iotanalytics.model.Message

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Message
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about a message.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
Message	clone()
boolean	equals(Object obj)
String	getMessageId() The ID you wish to assign to the message.
ByteBuffer	getPayload() The payload of the message.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setMessageId(String messageId) The ID you wish to assign to the message.
void	setPayload(ByteBuffer payload) The payload of the message.
String	toString() Returns a string representation of this object.
Message	withMessageId(String messageId) The ID you wish to assign to the message.
Message	withPayload(ByteBuffer payload) The payload of the message.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message()

Method Detail

setMessageId

public void setMessageId(String messageId)

The ID you wish to assign to the message. Each "messageId" must be unique within each batch sent.

Parameters:

messageId - The ID you wish to assign to the message. Each "messageId" must be unique within each batch sent.

getMessageId

public String getMessageId()

The ID you wish to assign to the message. Each "messageId" must be unique within each batch sent.

Returns:

The ID you wish to assign to the message. Each "messageId" must be unique within each batch sent.

withMessageId

public Message withMessageId(String messageId)

The ID you wish to assign to the message. Each "messageId" must be unique within each batch sent.

Parameters:

messageId - The ID you wish to assign to the message. Each "messageId" must be unique within each batch sent.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPayload

public void setPayload(ByteBuffer payload)

The payload of the message. This may be a JSON string or a Base64-encoded string representing binary data (in which case you must decode it by means of a pipeline activity).

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.

Parameters:

payload - The payload of the message. This may be a JSON string or a Base64-encoded string representing binary data (in which case you must decode it by means of a pipeline activity).

getPayload

public ByteBuffer getPayload()

The payload of the message. This may be a JSON string or a Base64-encoded string representing binary data (in which case you must decode it by means of a pipeline activity).

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

Returns:

The payload of the message. This may be a JSON string or a Base64-encoded string representing binary data (in which case you must decode it by means of a pipeline activity).

withPayload

public Message withPayload(ByteBuffer payload)

The payload of the message. This may be a JSON string or a Base64-encoded string representing binary data (in which case you must decode it by means of a pipeline activity).

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.

Parameters:

payload - The payload of the message. This may be a JSON string or a Base64-encoded string representing binary data (in which case you must decode it by means of a pipeline activity).

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Message clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.