Struct aws_sdk_iotdataplane::client::fluent_builders::Publish

pub struct Publish { /* private fields */ }

Fluent builder constructing a request to Publish.

Publishes an MQTT message.

Requires permission to access the Publish action.

For more information about MQTT messages, see MQTT Protocol in the IoT Developer Guide.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.

Implementations

impl Publish

pub async fn customize(
    self
) -> Result<CustomizableOperation<Publish, AwsResponseRetryClassifier>, SdkError<PublishError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(self) -> Result<PublishOutput, SdkError<PublishError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn topic(self, input: impl Into<String>) -> Self

The name of the MQTT topic.

pub fn set_topic(self, input: Option<String>) -> Self

The name of the MQTT topic.

pub fn qos(self, input: i32) -> Self

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

pub fn set_qos(self, input: Option<i32>) -> Self

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

pub fn retain(self, input: bool) -> Self

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 set_retain(self, input: Option<bool>) -> Self

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, input: Blob) -> Self

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 set_payload(self, input: Option<Blob>) -> Self

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, input: impl Into<String>) -> Self

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 set_user_properties(self, input: Option<String>) -> Self

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, input: PayloadFormatIndicator) -> Self

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 set_payload_format_indicator(
    self,
    input: Option<PayloadFormatIndicator>
) -> Self

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, input: impl Into<String>) -> Self

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

pub fn set_content_type(self, input: Option<String>) -> Self

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

pub fn response_topic(self, input: impl Into<String>) -> Self

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 set_response_topic(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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 set_correlation_data(self, input: Option<String>) -> Self

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, input: i64) -> Self

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.

pub fn set_message_expiry(self, input: Option<i64>) -> Self

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.

Trait Implementations

impl Clone for Publish

fn clone(&self) -> Publish

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Publish

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

Formats the value using the given formatter.