Struct aws_sdk_iotdataplane::input::PublishInput
source · #[non_exhaustive]pub struct PublishInput { /* private fields */ }Expand description
The input for the Publish operation.
Implementations§
source§impl PublishInput
impl PublishInput
sourcepub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<Publish, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<Publish, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<Publish>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture PublishInput.
source§impl PublishInput
impl PublishInput
sourcepub fn retain(&self) -> bool
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
sourcepub fn payload(&self) -> Option<&Blob>
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.
sourcepub fn user_properties(&self) -> Option<&str>
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"}]
sourcepub fn payload_format_indicator(&self) -> Option<&PayloadFormatIndicator>
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.
sourcepub fn content_type(&self) -> Option<&str>
pub fn content_type(&self) -> Option<&str>
A UTF-8 encoded string that describes the content of the publishing message.
sourcepub fn response_topic(&self) -> Option<&str>
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.
sourcepub fn correlation_data(&self) -> Option<&str>
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.
sourcepub fn message_expiry(&self) -> i64
pub fn message_expiry(&self) -> 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 PublishInput
impl Clone for PublishInput
source§fn clone(&self) -> PublishInput
fn clone(&self) -> PublishInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl Debug for PublishInput
impl Debug for PublishInput
source§impl PartialEq<PublishInput> for PublishInput
impl PartialEq<PublishInput> for PublishInput
source§fn eq(&self, other: &PublishInput) -> bool
fn eq(&self, other: &PublishInput) -> bool
self and other values to be equal, and is used
by ==.