Skip to content

GetRetainedMessageResponse

Source code in docs_src/capo_iot_data_plane/types/get_retained_message_response.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class GetRetainedMessageResponse(TypedDict, closed=True):
    topic: NotRequired["capo_iot_data_plane.types.topic.Topic"]
    """<p>The topic name to which the retained message was published.</p>"""
    payload: NotRequired["capo_iot_data_plane.types.payload.Payload"]
    """<p>The Base64-encoded message payload of the retained message body.</p>"""
    qos: "capo_iot_data_plane.types.qos.Qos"
    """<p>The quality of service (QoS) level used to publish the retained message.</p>"""
    last_modified_time: "capo_iot_data_plane.types.timestamp.Timestamp"
    """<p>The Epoch date and time, in milliseconds, when the retained message was stored by IoT.</p>"""
    user_properties: NotRequired[
        "capo_iot_data_plane.types.user_properties_blob.UserPropertiesBlob"
    ]
    """<p>A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.</p> <p>The following example <code>userProperties</code> parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:</p> <p> <code>[{"deviceName": "alpha"}, {"deviceCnt": "45"}]</code> </p>"""

last_modified_time instance-attribute 

last_modified_time: Timestamp

The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

payload instance-attribute 

payload: NotRequired[Payload]

The Base64-encoded message payload of the retained message body.

qos instance-attribute 

qos: Qos

The quality of service (QoS) level used to publish the retained message.

topic instance-attribute 

topic: NotRequired[Topic]

The topic name to which the retained message was published.

user_properties instance-attribute 

user_properties: NotRequired[UserPropertiesBlob]

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 userProperties parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:

[{"deviceName": "alpha"}, {"deviceCnt": "45"}]