#[non_exhaustive]pub struct GatewayInstance {
pub bridge_placement: Option<BridgePlacement>,
pub connection_status: Option<ConnectionStatus>,
pub gateway_arn: Option<String>,
pub gateway_instance_arn: Option<String>,
pub instance_id: Option<String>,
pub instance_messages: Option<Vec<MessageDetail>>,
pub instance_state: Option<InstanceState>,
pub running_bridge_count: Option<i32>,
}
Expand description
The settings for an instance in a gateway.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.bridge_placement: Option<BridgePlacement>
The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance.
connection_status: Option<ConnectionStatus>
The connection state of the instance.
gateway_arn: Option<String>
The Amazon Resource Name (ARN) of the instance.
gateway_instance_arn: Option<String>
The ARN of the gateway.
instance_id: Option<String>
The instance ID generated by the SSM install. This will begin with "mi-".
instance_messages: Option<Vec<MessageDetail>>
Messages with information about the gateway.
instance_state: Option<InstanceState>
The status of the instance.
running_bridge_count: Option<i32>
The running bridge count.
Implementations§
Source§impl GatewayInstance
impl GatewayInstance
Sourcepub fn bridge_placement(&self) -> Option<&BridgePlacement>
pub fn bridge_placement(&self) -> Option<&BridgePlacement>
The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance.
Sourcepub fn connection_status(&self) -> Option<&ConnectionStatus>
pub fn connection_status(&self) -> Option<&ConnectionStatus>
The connection state of the instance.
Sourcepub fn gateway_arn(&self) -> Option<&str>
pub fn gateway_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the instance.
Sourcepub fn gateway_instance_arn(&self) -> Option<&str>
pub fn gateway_instance_arn(&self) -> Option<&str>
The ARN of the gateway.
Sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
The instance ID generated by the SSM install. This will begin with "mi-".
Sourcepub fn instance_messages(&self) -> &[MessageDetail]
pub fn instance_messages(&self) -> &[MessageDetail]
Messages with information about the gateway.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .instance_messages.is_none()
.
Sourcepub fn instance_state(&self) -> Option<&InstanceState>
pub fn instance_state(&self) -> Option<&InstanceState>
The status of the instance.
Sourcepub fn running_bridge_count(&self) -> Option<i32>
pub fn running_bridge_count(&self) -> Option<i32>
The running bridge count.
Source§impl GatewayInstance
impl GatewayInstance
Sourcepub fn builder() -> GatewayInstanceBuilder
pub fn builder() -> GatewayInstanceBuilder
Creates a new builder-style object to manufacture GatewayInstance
.
Trait Implementations§
Source§impl Clone for GatewayInstance
impl Clone for GatewayInstance
Source§fn clone(&self) -> GatewayInstance
fn clone(&self) -> GatewayInstance
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GatewayInstance
impl Debug for GatewayInstance
Source§impl PartialEq for GatewayInstance
impl PartialEq for GatewayInstance
impl StructuralPartialEq for GatewayInstance
Auto Trait Implementations§
impl Freeze for GatewayInstance
impl RefUnwindSafe for GatewayInstance
impl Send for GatewayInstance
impl Sync for GatewayInstance
impl Unpin for GatewayInstance
impl UnwindSafe for GatewayInstance
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>
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);