Struct PublishInput

#[non_exhaustive]
pub struct PublishInput {
    pub topic: Option<String>,
    pub qos: Option<i32>,
    pub retain: Option<bool>,
    pub payload: Option<Blob>,
    pub user_properties: Option<String>,
    pub payload_format_indicator: Option<PayloadFormatIndicator>,
    pub content_type: Option<String>,
    pub response_topic: Option<String>,
    pub correlation_data: Option<String>,
    pub message_expiry: Option<i64>,
}

The input for the Publish 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 name of the MQTT topic.

qos: Option<i32>

The Quality of Service (QoS) level. The default QoS level is 0.

retain: Option<bool>

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

payload: Option<Blob>

The message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

user_properties: Option<String>

A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.

The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:

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

payload_format_indicator: Option<PayloadFormatIndicator>

An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.

content_type: Option<String>

A UTF-8 encoded string that describes the content of the publishing message.

response_topic: Option<String>

A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.

correlation_data: Option<String>

The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.

message_expiry: Option<i64>

A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.

Implementations

impl PublishInput

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

The name of the MQTT topic.

pub fn qos(&self) -> Option<i32>

The Quality of Service (QoS) level. The default QoS level is 0.

pub fn retain(&self) -> Option<bool>

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

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

The message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

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

A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.

The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:

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

pub fn payload_format_indicator(&self) -> Option<&PayloadFormatIndicator>

An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.

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

A UTF-8 encoded string that describes the content of the publishing message.

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

A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.

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

The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.

pub fn message_expiry(&self) -> Option<i64>

A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.

impl PublishInput

pub fn builder() -> PublishInputBuilder

Creates a new builder-style object to manufacture PublishInput.

Trait Implementations

impl Clone for PublishInput

fn clone(&self) -> PublishInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublishInput

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

Formats the value using the given formatter.

impl PartialEq for PublishInput

fn eq(&self, other: &PublishInput) -> 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 StructuralPartialEq for PublishInput