/AWS1/CL_IOPGETRETAINEDMSGRSP¶
The output from the GetRetainedMessage operation.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_topic TYPE /AWS1/IOPTOPIC /AWS1/IOPTOPIC¶
The topic name to which the retained message was published.
iv_payload TYPE /AWS1/IOPPAYLOAD /AWS1/IOPPAYLOAD¶
The Base64-encoded message payload of the retained message body.
iv_qos TYPE /AWS1/IOPQOS /AWS1/IOPQOS¶
The quality of service (QoS) level used to publish the retained message.
iv_lastmodifiedtime TYPE /AWS1/IOPTIMESTAMP /AWS1/IOPTIMESTAMP¶
The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
iv_userproperties TYPE /AWS1/IOPUSERPROPERTIESBLOB /AWS1/IOPUSERPROPERTIESBLOB¶
A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.
The following example
userPropertiesparameter is a JSON string that represents two user properties. Note that it will be base64-encoded:
[{"deviceName": "alpha"}, {"deviceCnt": "45"}]
Queryable Attributes¶
topic¶
The topic name to which the retained message was published.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TOPIC() |
Getter for TOPIC, with configurable default |
ASK_TOPIC() |
Getter for TOPIC w/ exceptions if field has no value |
HAS_TOPIC() |
Determine if TOPIC has a value |
payload¶
The Base64-encoded message payload of the retained message body.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PAYLOAD() |
Getter for PAYLOAD, with configurable default |
ASK_PAYLOAD() |
Getter for PAYLOAD w/ exceptions if field has no value |
HAS_PAYLOAD() |
Determine if PAYLOAD has a value |
qos¶
The quality of service (QoS) level used to publish the retained message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QOS() |
Getter for QOS |
lastModifiedTime¶
The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDTIME() |
Getter for LASTMODIFIEDTIME |
userProperties¶
A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.
The following example
userPropertiesparameter is a JSON string that represents two user properties. Note that it will be base64-encoded:
[{"deviceName": "alpha"}, {"deviceCnt": "45"}]
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERPROPERTIES() |
Getter for USERPROPERTIES, with configurable default |
ASK_USERPROPERTIES() |
Getter for USERPROPERTIES w/ exceptions if field has no valu |
HAS_USERPROPERTIES() |
Determine if USERPROPERTIES has a value |