#[non_exhaustive]pub struct GetConnectionOutputBuilder { /* private fields */ }Expand description
A builder for GetConnectionOutput.
Implementations§
Source§impl GetConnectionOutputBuilder
impl GetConnectionOutputBuilder
Sourcepub fn connected(self, input: bool) -> Self
pub fn connected(self, input: bool) -> Self
The connection state of the client. Returns true if the client is currently connected, or false if the client is not connected.
Sourcepub fn set_connected(self, input: Option<bool>) -> Self
pub fn set_connected(self, input: Option<bool>) -> Self
The connection state of the client. Returns true if the client is currently connected, or false if the client is not connected.
Sourcepub fn get_connected(&self) -> &Option<bool>
pub fn get_connected(&self) -> &Option<bool>
The connection state of the client. Returns true if the client is currently connected, or false if the client is not connected.
Sourcepub fn thing_name(self, input: impl Into<String>) -> Self
pub fn thing_name(self, input: impl Into<String>) -> Self
The name of the thing associated with the principal of the MQTT client, if applicable.
Sourcepub fn set_thing_name(self, input: Option<String>) -> Self
pub fn set_thing_name(self, input: Option<String>) -> Self
The name of the thing associated with the principal of the MQTT client, if applicable.
Sourcepub fn get_thing_name(&self) -> &Option<String>
pub fn get_thing_name(&self) -> &Option<String>
The name of the thing associated with the principal of the MQTT client, if applicable.
Sourcepub fn clean_session(self, input: bool) -> Self
pub fn clean_session(self, input: bool) -> Self
Indicates whether the client is using a clean session. Returns true for clean sessions or false for persistent sessions.
Sourcepub fn set_clean_session(self, input: Option<bool>) -> Self
pub fn set_clean_session(self, input: Option<bool>) -> Self
Indicates whether the client is using a clean session. Returns true for clean sessions or false for persistent sessions.
Sourcepub fn get_clean_session(&self) -> &Option<bool>
pub fn get_clean_session(&self) -> &Option<bool>
Indicates whether the client is using a clean session. Returns true for clean sessions or false for persistent sessions.
Sourcepub fn source_ip(self, input: impl Into<String>) -> Self
pub fn source_ip(self, input: impl Into<String>) -> Self
The IP address of the client that initiated the connection.
Sourcepub fn set_source_ip(self, input: Option<String>) -> Self
pub fn set_source_ip(self, input: Option<String>) -> Self
The IP address of the client that initiated the connection.
Sourcepub fn get_source_ip(&self) -> &Option<String>
pub fn get_source_ip(&self) -> &Option<String>
The IP address of the client that initiated the connection.
Sourcepub fn source_port(self, input: i32) -> Self
pub fn source_port(self, input: i32) -> Self
The client's source port.
Sourcepub fn set_source_port(self, input: Option<i32>) -> Self
pub fn set_source_port(self, input: Option<i32>) -> Self
The client's source port.
Sourcepub fn get_source_port(&self) -> &Option<i32>
pub fn get_source_port(&self) -> &Option<i32>
The client's source port.
Sourcepub fn target_ip(self, input: impl Into<String>) -> Self
pub fn target_ip(self, input: impl Into<String>) -> Self
The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.
Sourcepub fn set_target_ip(self, input: Option<String>) -> Self
pub fn set_target_ip(self, input: Option<String>) -> Self
The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.
Sourcepub fn get_target_ip(&self) -> &Option<String>
pub fn get_target_ip(&self) -> &Option<String>
The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.
Sourcepub fn target_port(self, input: i32) -> Self
pub fn target_port(self, input: i32) -> Self
The port number of the Amazon Web Services IoT Core endpoint that the client connected to.
Sourcepub fn set_target_port(self, input: Option<i32>) -> Self
pub fn set_target_port(self, input: Option<i32>) -> Self
The port number of the Amazon Web Services IoT Core endpoint that the client connected to.
Sourcepub fn get_target_port(&self) -> &Option<i32>
pub fn get_target_port(&self) -> &Option<i32>
The port number of the Amazon Web Services IoT Core endpoint that the client connected to.
Sourcepub fn keep_alive_duration(self, input: i32) -> Self
pub fn keep_alive_duration(self, input: i32) -> Self
The keep-alive interval in seconds that the client specified when establishing the connection.
Sourcepub fn set_keep_alive_duration(self, input: Option<i32>) -> Self
pub fn set_keep_alive_duration(self, input: Option<i32>) -> Self
The keep-alive interval in seconds that the client specified when establishing the connection.
Sourcepub fn get_keep_alive_duration(&self) -> &Option<i32>
pub fn get_keep_alive_duration(&self) -> &Option<i32>
The keep-alive interval in seconds that the client specified when establishing the connection.
Sourcepub fn connected_since(self, input: i64) -> Self
pub fn connected_since(self, input: i64) -> Self
Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.
Sourcepub fn set_connected_since(self, input: Option<i64>) -> Self
pub fn set_connected_since(self, input: Option<i64>) -> Self
Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.
Sourcepub fn get_connected_since(&self) -> &Option<i64>
pub fn get_connected_since(&self) -> &Option<i64>
Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.
Sourcepub fn disconnected_since(self, input: i64) -> Self
pub fn disconnected_since(self, input: i64) -> Self
Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.
Sourcepub fn set_disconnected_since(self, input: Option<i64>) -> Self
pub fn set_disconnected_since(self, input: Option<i64>) -> Self
Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.
Sourcepub fn get_disconnected_since(&self) -> &Option<i64>
pub fn get_disconnected_since(&self) -> &Option<i64>
Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.
Sourcepub fn disconnect_reason(self, input: impl Into<String>) -> Self
pub fn disconnect_reason(self, input: impl Into<String>) -> Self
The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.
Sourcepub fn set_disconnect_reason(self, input: Option<String>) -> Self
pub fn set_disconnect_reason(self, input: Option<String>) -> Self
The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.
Sourcepub fn get_disconnect_reason(&self) -> &Option<String>
pub fn get_disconnect_reason(&self) -> &Option<String>
The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.
Sourcepub fn session_expiry(self, input: i64) -> Self
pub fn session_expiry(self, input: i64) -> Self
The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects.
Sourcepub fn set_session_expiry(self, input: Option<i64>) -> Self
pub fn set_session_expiry(self, input: Option<i64>) -> Self
The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects.
Sourcepub fn get_session_expiry(&self) -> &Option<i64>
pub fn get_session_expiry(&self) -> &Option<i64>
The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects.
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. This is the same client ID that was used when the client established the connection.
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. This is the same client ID that was used when the client established the connection.
Sourcepub fn get_client_id(&self) -> &Option<String>
pub fn get_client_id(&self) -> &Option<String>
The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection.
Sourcepub fn vpc_endpoint_id(self, input: impl Into<String>) -> Self
pub fn vpc_endpoint_id(self, input: impl Into<String>) -> Self
The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.
Sourcepub fn set_vpc_endpoint_id(self, input: Option<String>) -> Self
pub fn set_vpc_endpoint_id(self, input: Option<String>) -> Self
The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.
Sourcepub fn get_vpc_endpoint_id(&self) -> &Option<String>
pub fn get_vpc_endpoint_id(&self) -> &Option<String>
The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.
Sourcepub fn build(self) -> GetConnectionOutput
pub fn build(self) -> GetConnectionOutput
Consumes the builder and constructs a GetConnectionOutput.
Trait Implementations§
Source§impl Clone for GetConnectionOutputBuilder
impl Clone for GetConnectionOutputBuilder
Source§fn clone(&self) -> GetConnectionOutputBuilder
fn clone(&self) -> GetConnectionOutputBuilder
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for GetConnectionOutputBuilder
impl Debug for GetConnectionOutputBuilder
Source§impl Default for GetConnectionOutputBuilder
impl Default for GetConnectionOutputBuilder
Source§fn default() -> GetConnectionOutputBuilder
fn default() -> GetConnectionOutputBuilder
impl StructuralPartialEq for GetConnectionOutputBuilder
Auto Trait Implementations§
impl Freeze for GetConnectionOutputBuilder
impl RefUnwindSafe for GetConnectionOutputBuilder
impl Send for GetConnectionOutputBuilder
impl Sync for GetConnectionOutputBuilder
impl Unpin for GetConnectionOutputBuilder
impl UnsafeUnpin for GetConnectionOutputBuilder
impl UnwindSafe for GetConnectionOutputBuilder
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
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);