Struct aws_sdk_iot::model::mqtt_headers::Builder
source · pub struct Builder { /* private fields */ }
Expand description
A builder for MqttHeaders
.
Implementations§
source§impl Builder
impl Builder
sourcepub fn payload_format_indicator(self, input: impl Into<String>) -> Self
pub fn payload_format_indicator(self, input: impl Into<String>) -> Self
An Enum
string value that indicates whether the payload is formatted as UTF-8.
Valid values are UNSPECIFIED_BYTES
and UTF8_DATA
.
For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates.
sourcepub fn set_payload_format_indicator(self, input: Option<String>) -> Self
pub fn set_payload_format_indicator(self, input: Option<String>) -> Self
An Enum
string value that indicates whether the payload is formatted as UTF-8.
Valid values are UNSPECIFIED_BYTES
and UTF8_DATA
.
For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates.
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.
For more information, see Content Type from the MQTT Version 5.0 specification.
Supports substitution templates.
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.
For more information, see Content Type from the MQTT Version 5.0 specification.
Supports substitution templates.
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.
For more information, see Response Topic from the MQTT Version 5.0 specification.
Supports substitution templates.
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.
For more information, see Response Topic from the MQTT Version 5.0 specification.
Supports substitution templates.
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.
For more information, see Correlation Data from the MQTT Version 5.0 specification.
This binary data must be based64-encoded.
Supports substitution templates.
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.
For more information, see Correlation Data from the MQTT Version 5.0 specification.
This binary data must be based64-encoded.
Supports substitution templates.
sourcepub fn message_expiry(self, input: impl Into<String>) -> Self
pub fn message_expiry(self, input: impl Into<String>) -> Self
A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it's no longer relevant to the subscriber. The value of messageExpiry
represents the number of seconds before it expires. 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.
Supports substitution templates.
sourcepub fn set_message_expiry(self, input: Option<String>) -> Self
pub fn set_message_expiry(self, input: Option<String>) -> Self
A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it's no longer relevant to the subscriber. The value of messageExpiry
represents the number of seconds before it expires. 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.
Supports substitution templates.
sourcepub fn user_properties(self, input: UserProperty) -> Self
pub fn user_properties(self, input: UserProperty) -> Self
Appends an item to user_properties
.
To override the contents of this collection use set_user_properties
.
An array of key-value pairs that you define in the MQTT5 header.
sourcepub fn set_user_properties(self, input: Option<Vec<UserProperty>>) -> Self
pub fn set_user_properties(self, input: Option<Vec<UserProperty>>) -> Self
An array of key-value pairs that you define in the MQTT5 header.
sourcepub fn build(self) -> MqttHeaders
pub fn build(self) -> MqttHeaders
Consumes the builder and constructs a MqttHeaders
.