Message (AWS Java SDK for AWS IoT Events Data 1.11.825 API)

java.lang.Object
- com.amazonaws.services.ioteventsdata.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()

Constructors
Constructor and Description
`Message()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller 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.
`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.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Message
```
public Message()
```
- Method Detail
  - setMessageId
```
public void setMessageId(String messageId)
```
    The ID to assign to the message. Within each batch sent, each "messageId" must be unique.
    
    Parameters:
    
    messageId - The ID to assign to the message. Within each batch sent, each "messageId" must be unique.
  - getMessageId
```
public String getMessageId()
```
    The ID to assign to the message. Within each batch sent, each "messageId" must be unique.
    
    Returns:
    
    The ID to assign to the message. Within each batch sent, each "messageId" must be unique.
  - withMessageId
```
public Message withMessageId(String messageId)
```
    The ID to assign to the message. Within each batch sent, each "messageId" must be unique.
    
    Parameters:
    
    messageId - The ID to assign to the message. Within each batch sent, each "messageId" must be unique.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputName
```
public void setInputName(String inputName)
```
    The name of the input into which the message payload is transformed.
    
    Parameters:
    
    inputName - The name of the input into which the message payload is transformed.
  - getInputName
```
public String getInputName()
```
    The name of the input into which the message payload is transformed.
    
    Returns:
    
    The name of the input into which the message payload is transformed.
  - withInputName
```
public Message withInputName(String inputName)
```
    The name of the input into which the message payload is transformed.
    
    Parameters:
    
    inputName - The name of the input into which the message payload is transformed.
    
    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 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.
    
    Parameters:
    
    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).
  - getPayload
```
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).
    
    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 can be a JSON string or a Base-64-encoded string representing binary data (in which case you must decode it).
  - withPayload
```
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.
    
    Parameters:
    
    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).
    
    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)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Message

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Message

Method Detail

setMessageId

getMessageId

withMessageId

setInputName

getInputName

withInputName

setPayload

getPayload

withPayload

toString

equals

hashCode

clone

marshall