AWSIotMessage (aws-iot-device-sdk-java 1.3.7 API)

java.lang.Object
- com.amazonaws.services.iot.client.AWSIotMessage

All Implemented Interfaces:

AwsIotMessageCallback

Direct Known Subclasses:

AwsIotCompletion, AwsIotDeviceReportMessage, AwsIotDeviceSyncMessage, AWSIotTopic
```
public class AWSIotMessage
extends Object
implements AwsIotMessageCallback
```
A common data structure that is used in a lot of non-blocking APIs in this library.
It provides common data elements, such as topic, qos, and payload, used by the APIs.

It also contains callback functions that can be overridden to provide customized handlers. The callback functions are invoked when a non-blocking API call has completed successfully, unsuccessfully, or timed out. Applications wish to have customized callback functions must extend this class or its child classes, such as AWSIotTopic.

Field Summary

Fields
Modifier and Type	Field and Description
`protected AWSIotDeviceErrorCode`	`errorCode` Error code for shadow methods.
`protected String`	`errorMessage` Error message for shadow methods.
`protected byte[]`	`payload` The payload of the message.
`protected AWSIotQos`	`qos` The MQTT QoS level for the message.
`protected String`	`topic` The topic the message is received from or published to.

Constructor Summary

Constructors
Constructor and Description
`AWSIotMessage(String topic, AWSIotQos qos)` Instantiates a new message object.
`AWSIotMessage(String topic, AWSIotQos qos, byte[] payload)` Instantiates a new message object.
`AWSIotMessage(String topic, AWSIotQos qos, String payload)` Instantiates a new message object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AWSIotDeviceErrorCode`	`getErrorCode()` Error code for shadow methods.
`String`	`getErrorMessage()` Error message for shadow methods.
`byte[]`	`getPayload()` Gets the byte array payload.
`AWSIotQos`	`getQos()` The MQTT QoS level for the message.
`String`	`getStringPayload()` Gets the string payload.
`String`	`getTopic()` The topic the message is received from or published to.
`void`	`onFailure()` Callback function to be invoked a non-block API has completed unsuccessfully.
`void`	`onSuccess()` Callback function to be invoked a non-block API has completed successfully.
`void`	`onTimeout()` Callback function to be invoked a non-block API has timed out.
`void`	`setErrorCode(AWSIotDeviceErrorCode errorCode)` Error code for shadow methods.
`void`	`setErrorMessage(String errorMessage)` Error message for shadow methods.
`void`	`setPayload(byte[] payload)` Sets the byte array payload.
`void`	`setQos(AWSIotQos qos)` The MQTT QoS level for the message.
`void`	`setStringPayload(String payload)` Sets the string payload.
`void`	`setTopic(String topic)` The topic the message is received from or published to.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - topic
```
protected String topic
```
    The topic the message is received from or published to.
  - qos
```
protected AWSIotQos qos
```
    The MQTT QoS level for the message.
  - payload
```
protected byte[] payload
```
    The payload of the message.
  - errorCode
```
protected AWSIotDeviceErrorCode errorCode
```
    Error code for shadow methods. It's only applicable to messages returned by those shadow method APIs.
  - errorMessage
```
protected String errorMessage
```
    Error message for shadow methods. It's only applicable to messages returned by those shadow method APIs.
- Constructor Detail
  - AWSIotMessage
```
public AWSIotMessage(String topic,
                     AWSIotQos qos)
```
    Instantiates a new message object.
    
    Parameters:
    
    topic - the topic of the message
    
    qos - the QoS level of the message
  - AWSIotMessage
```
public AWSIotMessage(String topic,
                     AWSIotQos qos,
                     byte[] payload)
```
    Instantiates a new message object.
    
    Parameters:
    
    topic - the topic of the message
    
    qos - the QoS level of the message
    
    payload - the payload of the message
  - AWSIotMessage
```
public AWSIotMessage(String topic,
                     AWSIotQos qos,
                     String payload)
```
    Instantiates a new message object.
    
    Parameters:
    
    topic - the topic of the message
    
    qos - the QoS level of the message
    
    payload - the payload of the message
- Method Detail
  - getPayload
```
public byte[] getPayload()
```
    Gets the byte array payload.
    
    Returns:
    
    the byte array payload
  - setPayload
```
public void setPayload(byte[] payload)
```
    Sets the byte array payload.
    
    Parameters:
    
    payload - the new byte array payload
  - getStringPayload
```
public String getStringPayload()
```
    Gets the string payload.
    
    Returns:
    
    the string payload
  - setStringPayload
```
public void setStringPayload(String payload)
```
    Sets the string payload.
    
    Parameters:
    
    payload - the new string payload
  - onSuccess
```
public void onSuccess()
```
    Callback function to be invoked a non-block API has completed successfully.
    
    Specified by:
    
    onSuccess in interface AwsIotMessageCallback
  - onFailure
```
public void onFailure()
```
    Callback function to be invoked a non-block API has completed unsuccessfully.
    
    Specified by:
    
    onFailure in interface AwsIotMessageCallback
  - onTimeout
```
public void onTimeout()
```
    Callback function to be invoked a non-block API has timed out.
    
    Specified by:
    
    onTimeout in interface AwsIotMessageCallback
  - getTopic
```
public String getTopic()
```
    The topic the message is received from or published to.
    
    Returns:
    
    the current topic of the message
  - setTopic
```
public void setTopic(String topic)
```
    The topic the message is received from or published to.
    
    Parameters:
    
    topic - the new topic of the message
  - getQos
```
public AWSIotQos getQos()
```
    The MQTT QoS level for the message.
    
    Returns:
    
    the current QoS level
  - setQos
```
public void setQos(AWSIotQos qos)
```
    The MQTT QoS level for the message.
    
    Parameters:
    
    qos - the new QoS level
  - getErrorCode
```
public AWSIotDeviceErrorCode getErrorCode()
```
    Error code for shadow methods. It's only applicable to messages returned by those shadow method APIs.
    
    Returns:
    
    the current error code of the shadow method
  - setErrorCode
```
public void setErrorCode(AWSIotDeviceErrorCode errorCode)
```
    Error code for shadow methods. It's only applicable to messages returned by those shadow method APIs.
    
    Parameters:
    
    errorCode - the new error code for the shadow method
  - getErrorMessage
```
public String getErrorMessage()
```
    Error message for shadow methods. It's only applicable to messages returned by those shadow method APIs.
    
    Returns:
    
    the current error message of the shadow method
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    Error message for shadow methods. It's only applicable to messages returned by those shadow method APIs.
    
    Parameters:
    
    errorMessage - the new error message for the shadow method

Class AWSIotMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

topic

qos

payload

errorCode

errorMessage

Constructor Detail

AWSIotMessage

AWSIotMessage

AWSIotMessage

Method Detail

getPayload

setPayload

getStringPayload

setStringPayload

onSuccess

onFailure

onTimeout

getTopic

setTopic

getQos

setQos

getErrorCode

setErrorCode

getErrorMessage

setErrorMessage