#[non_exhaustive]pub struct SendDirectMessageInputBuilder { /* private fields */ }Expand description
A builder for SendDirectMessageInput.
Implementations§
Source§impl SendDirectMessageInputBuilder
impl SendDirectMessageInputBuilder
Sourcepub fn client_id(self, input: impl Into<String>) -> Self
pub fn client_id(self, input: impl Into<String>) -> Self
The unique identifier of the MQTT client to send the message to.
Client IDs must not exceed 128 characters and can't start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.
This field is required.Sourcepub fn set_client_id(self, input: Option<String>) -> Self
pub fn set_client_id(self, input: Option<String>) -> Self
The unique identifier of the MQTT client to send the message to.
Client IDs must not exceed 128 characters and can't start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.
Sourcepub fn get_client_id(&self) -> &Option<String>
pub fn get_client_id(&self) -> &Option<String>
The unique identifier of the MQTT client to send the message to.
Client IDs must not exceed 128 characters and can't start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.
Sourcepub fn topic(self, input: impl Into<String>) -> Self
pub fn topic(self, input: impl Into<String>) -> Self
The topic of the outbound MQTT Publish message to the receiving client. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.
This field is required.Sourcepub fn set_topic(self, input: Option<String>) -> Self
pub fn set_topic(self, input: Option<String>) -> Self
The topic of the outbound MQTT Publish message to the receiving client. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.
Sourcepub fn get_topic(&self) -> &Option<String>
pub fn get_topic(&self) -> &Option<String>
The topic of the outbound MQTT Publish message to the receiving client. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.
Sourcepub fn content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
The MQTT5 content type property forwarded to the receiving client (for example, application/json).
Sourcepub fn set_content_type(self, input: Option<String>) -> Self
pub fn set_content_type(self, input: Option<String>) -> Self
The MQTT5 content type property forwarded to the receiving client (for example, application/json).
Sourcepub fn get_content_type(&self) -> &Option<String>
pub fn get_content_type(&self) -> &Option<String>
The MQTT5 content type property forwarded to the receiving client (for example, application/json).
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 describes 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 Amazon Web Services IoT Core message broker and protocol limits and quotas.
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 describes 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 Amazon Web Services IoT Core message broker and protocol limits and quotas.
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 describes 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 Amazon Web Services IoT Core message broker and protocol limits and quotas.
Sourcepub fn confirmation(self, input: bool) -> Self
pub fn confirmation(self, input: bool) -> Self
A Boolean value that specifies whether to wait for delivery confirmation from the receiving client.
When set to true, the API delivers the message at QoS 1 and waits for the client to send a delivery confirmation (PUBACK) before returning a successful response. If delivery confirmation is not received within the specified timeout period, the API returns HTTP 504.
When set to false, the API delivers the message at QoS 0 and returns after Amazon Web Services IoT Core attempts to deliver the message.
Valid values: true | false
Default value: false
Sourcepub fn set_confirmation(self, input: Option<bool>) -> Self
pub fn set_confirmation(self, input: Option<bool>) -> Self
A Boolean value that specifies whether to wait for delivery confirmation from the receiving client.
When set to true, the API delivers the message at QoS 1 and waits for the client to send a delivery confirmation (PUBACK) before returning a successful response. If delivery confirmation is not received within the specified timeout period, the API returns HTTP 504.
When set to false, the API delivers the message at QoS 0 and returns after Amazon Web Services IoT Core attempts to deliver the message.
Valid values: true | false
Default value: false
Sourcepub fn get_confirmation(&self) -> &Option<bool>
pub fn get_confirmation(&self) -> &Option<bool>
A Boolean value that specifies whether to wait for delivery confirmation from the receiving client.
When set to true, the API delivers the message at QoS 1 and waits for the client to send a delivery confirmation (PUBACK) before returning a successful response. If delivery confirmation is not received within the specified timeout period, the API returns HTTP 504.
When set to false, the API delivers the message at QoS 0 and returns after Amazon Web Services IoT Core attempts to deliver the message.
Valid values: true | false
Default value: false
Sourcepub fn timeout(self, input: i32) -> Self
pub fn timeout(self, input: i32) -> Self
An integer that represents the maximum time, in seconds, to wait for a delivery confirmation (PUBACK) from the receiving client after the message has been delivered. This parameter is only used when confirmation is set to true. If confirmation is false, this parameter is ignored.
The total API response time may be higher than this value due to internal processing. Set your HTTP client timeout to a value greater than this parameter.
Valid range: 1 to 15 seconds.
Default value: 5 seconds.
Sourcepub fn set_timeout(self, input: Option<i32>) -> Self
pub fn set_timeout(self, input: Option<i32>) -> Self
An integer that represents the maximum time, in seconds, to wait for a delivery confirmation (PUBACK) from the receiving client after the message has been delivered. This parameter is only used when confirmation is set to true. If confirmation is false, this parameter is ignored.
The total API response time may be higher than this value due to internal processing. Set your HTTP client timeout to a value greater than this parameter.
Valid range: 1 to 15 seconds.
Default value: 5 seconds.
Sourcepub fn get_timeout(&self) -> &Option<i32>
pub fn get_timeout(&self) -> &Option<i32>
An integer that represents the maximum time, in seconds, to wait for a delivery confirmation (PUBACK) from the receiving client after the message has been delivered. This parameter is only used when confirmation is set to true. If confirmation is false, this parameter is ignored.
The total API response time may be higher than this value due to internal processing. Set your HTTP client timeout to a value greater than this parameter.
Valid range: 1 to 15 seconds.
Default value: 5 seconds.
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.
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.
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.
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.
For MQTT 3.1.1 clients, user properties are silently dropped.
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.
For MQTT 3.1.1 clients, user properties are silently dropped.
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.
For MQTT 3.1.1 clients, user properties are silently dropped.
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 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 build(self) -> Result<SendDirectMessageInput, BuildError>
pub fn build(self) -> Result<SendDirectMessageInput, BuildError>
Consumes the builder and constructs a SendDirectMessageInput.
Source§impl SendDirectMessageInputBuilder
impl SendDirectMessageInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<SendDirectMessageOutput, SdkError<SendDirectMessageError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<SendDirectMessageOutput, SdkError<SendDirectMessageError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for SendDirectMessageInputBuilder
impl Clone for SendDirectMessageInputBuilder
Source§fn clone(&self) -> SendDirectMessageInputBuilder
fn clone(&self) -> SendDirectMessageInputBuilder
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for SendDirectMessageInputBuilder
impl Default for SendDirectMessageInputBuilder
Source§fn default() -> SendDirectMessageInputBuilder
fn default() -> SendDirectMessageInputBuilder
Source§impl PartialEq for SendDirectMessageInputBuilder
impl PartialEq for SendDirectMessageInputBuilder
Source§fn eq(&self, other: &SendDirectMessageInputBuilder) -> bool
fn eq(&self, other: &SendDirectMessageInputBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for SendDirectMessageInputBuilder
Auto Trait Implementations§
impl Freeze for SendDirectMessageInputBuilder
impl RefUnwindSafe for SendDirectMessageInputBuilder
impl Send for SendDirectMessageInputBuilder
impl Sync for SendDirectMessageInputBuilder
impl Unpin for SendDirectMessageInputBuilder
impl UnsafeUnpin for SendDirectMessageInputBuilder
impl UnwindSafe for SendDirectMessageInputBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);