Struct GetRetainedMessageOutput

#[non_exhaustive]
pub struct GetRetainedMessageOutput {
    pub topic: Option<String>,
    pub payload: Option<Blob>,
    pub qos: i32,
    pub last_modified_time: i64,
    pub user_properties: Option<Blob>,
    /* private fields */
}

The output from the GetRetainedMessage operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

topic: Option<String>

The topic name to which the retained message was published.

payload: Option<Blob>

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

qos: i32

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

last_modified_time: i64

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

user_properties: Option<Blob>

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"}\]

Implementations

impl GetRetainedMessageOutput

pub fn topic(&self) -> Option<&str>

The topic name to which the retained message was published.

pub fn payload(&self) -> Option<&Blob>

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

pub fn qos(&self) -> i32

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

pub fn last_modified_time(&self) -> i64

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

pub fn user_properties(&self) -> Option<&Blob>

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"}\]

impl GetRetainedMessageOutput

pub fn builder() -> GetRetainedMessageOutputBuilder

Creates a new builder-style object to manufacture GetRetainedMessageOutput.

Trait Implementations

impl Clone for GetRetainedMessageOutput

fn clone(&self) -> GetRetainedMessageOutput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetRetainedMessageOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetRetainedMessageOutput

fn eq(&self, other: &GetRetainedMessageOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetRetainedMessageOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetRetainedMessageOutput