Struct aws_sdk_iotdataplane::input::PublishInput

#[non_exhaustive]
pub struct PublishInput {
    pub topic: Option<String>,
    pub qos: i32,
    pub retain: bool,
    pub payload: Option<Blob>,
}

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: i32

The Quality of Service (QoS) level.

retain: 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.

Implementations

impl PublishInput

pub async fn make_operation(
    self,
    _config: &Config
) -> Result<Operation<Publish, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<Publish>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture PublishInput.

impl PublishInput

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

The name of the MQTT topic.

pub fn qos(&self) -> i32

The Quality of Service (QoS) level.

pub fn retain(&self) -> 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.

Trait Implementations

impl Clone for PublishInput

fn clone(&self) -> PublishInput

Returns a copy 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<PublishInput> for PublishInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for PublishInput