pub struct PublishFluentBuilder { /* private fields */ }
Expand description
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§
source§impl PublishFluentBuilder
impl PublishFluentBuilder
sourcepub fn as_input(&self) -> &PublishInputBuilder
pub fn as_input(&self) -> &PublishInputBuilder
Access the Publish as a reference.
sourcepub async fn send(
self
) -> Result<PublishOutput, SdkError<PublishError, HttpResponse>>
pub async fn send( self ) -> Result<PublishOutput, SdkError<PublishError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<PublishOutput, PublishError, Self>
pub fn customize( self ) -> CustomizableOperation<PublishOutput, PublishError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn qos(self, input: i32) -> Self
pub fn qos(self, input: i32) -> Self
The Quality of Service (QoS) level. The default QoS level is 0.
sourcepub fn set_qos(self, input: Option<i32>) -> Self
pub fn set_qos(self, input: Option<i32>) -> Self
The Quality of Service (QoS) level. The default QoS level is 0.
sourcepub fn get_qos(&self) -> &Option<i32>
pub fn get_qos(&self) -> &Option<i32>
The Quality of Service (QoS) level. The default QoS level is 0.
sourcepub fn retain(self, input: bool) -> Self
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
sourcepub fn set_retain(self, input: Option<bool>) -> Self
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
sourcepub fn get_retain(&self) -> &Option<bool>
pub fn get_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
sourcepub fn payload(self, input: Blob) -> Self
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.
sourcepub fn set_payload(self, input: Option<Blob>) -> Self
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.
sourcepub fn get_payload(&self) -> &Option<Blob>
pub fn get_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.
sourcepub fn user_properties(self, input: impl Into<String>) -> Self
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"}]
sourcepub fn set_user_properties(self, input: Option<String>) -> Self
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"}]
sourcepub fn get_user_properties(&self) -> &Option<String>
pub fn get_user_properties(&self) -> &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"}]
sourcepub fn payload_format_indicator(self, input: PayloadFormatIndicator) -> Self
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.
sourcepub fn set_payload_format_indicator(
self,
input: Option<PayloadFormatIndicator>
) -> Self
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.
sourcepub fn get_payload_format_indicator(&self) -> &Option<PayloadFormatIndicator>
pub fn get_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.
sourcepub fn content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
A UTF-8 encoded string that describes the content of the publishing message.
sourcepub fn set_content_type(self, input: Option<String>) -> Self
pub fn set_content_type(self, input: Option<String>) -> Self
A UTF-8 encoded string that describes the content of the publishing message.
sourcepub fn get_content_type(&self) -> &Option<String>
pub fn get_content_type(&self) -> &Option<String>
A UTF-8 encoded string that describes the content of the publishing message.
sourcepub fn response_topic(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_response_topic(self, input: Option<String>) -> Self
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.
sourcepub fn get_response_topic(&self) -> &Option<String>
pub fn get_response_topic(&self) -> &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.
sourcepub fn correlation_data(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_correlation_data(self, input: Option<String>) -> Self
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.
sourcepub fn get_correlation_data(&self) -> &Option<String>
pub fn get_correlation_data(&self) -> &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.
sourcepub fn message_expiry(self, input: i64) -> Self
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.
sourcepub fn set_message_expiry(self, input: Option<i64>) -> Self
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.
sourcepub fn get_message_expiry(&self) -> &Option<i64>
pub fn get_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.
Trait Implementations§
source§impl Clone for PublishFluentBuilder
impl Clone for PublishFluentBuilder
source§fn clone(&self) -> PublishFluentBuilder
fn clone(&self) -> PublishFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for PublishFluentBuilder
impl !RefUnwindSafe for PublishFluentBuilder
impl Send for PublishFluentBuilder
impl Sync for PublishFluentBuilder
impl Unpin for PublishFluentBuilder
impl !UnwindSafe for PublishFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more