#[non_exhaustive]pub struct InstalledComponentBuilder { /* private fields */ }
Expand description
A builder for InstalledComponent
.
Implementations§
Source§impl InstalledComponentBuilder
impl InstalledComponentBuilder
Sourcepub fn component_name(self, input: impl Into<String>) -> Self
pub fn component_name(self, input: impl Into<String>) -> Self
The name of the component.
Sourcepub fn set_component_name(self, input: Option<String>) -> Self
pub fn set_component_name(self, input: Option<String>) -> Self
The name of the component.
Sourcepub fn get_component_name(&self) -> &Option<String>
pub fn get_component_name(&self) -> &Option<String>
The name of the component.
Sourcepub fn component_version(self, input: impl Into<String>) -> Self
pub fn component_version(self, input: impl Into<String>) -> Self
The version of the component.
Sourcepub fn set_component_version(self, input: Option<String>) -> Self
pub fn set_component_version(self, input: Option<String>) -> Self
The version of the component.
Sourcepub fn get_component_version(&self) -> &Option<String>
pub fn get_component_version(&self) -> &Option<String>
The version of the component.
Sourcepub fn lifecycle_state(self, input: InstalledComponentLifecycleState) -> Self
pub fn lifecycle_state(self, input: InstalledComponentLifecycleState) -> Self
The lifecycle state of the component.
Sourcepub fn set_lifecycle_state(
self,
input: Option<InstalledComponentLifecycleState>,
) -> Self
pub fn set_lifecycle_state( self, input: Option<InstalledComponentLifecycleState>, ) -> Self
The lifecycle state of the component.
Sourcepub fn get_lifecycle_state(&self) -> &Option<InstalledComponentLifecycleState>
pub fn get_lifecycle_state(&self) -> &Option<InstalledComponentLifecycleState>
The lifecycle state of the component.
Sourcepub fn lifecycle_state_details(self, input: impl Into<String>) -> Self
pub fn lifecycle_state_details(self, input: impl Into<String>) -> Self
A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.
Sourcepub fn set_lifecycle_state_details(self, input: Option<String>) -> Self
pub fn set_lifecycle_state_details(self, input: Option<String>) -> Self
A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.
Sourcepub fn get_lifecycle_state_details(&self) -> &Option<String>
pub fn get_lifecycle_state_details(&self) -> &Option<String>
A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.
Sourcepub fn set_is_root(self, input: Option<bool>) -> Self
pub fn set_is_root(self, input: Option<bool>) -> Self
Whether or not the component is a root component.
Sourcepub fn get_is_root(&self) -> &Option<bool>
pub fn get_is_root(&self) -> &Option<bool>
Whether or not the component is a root component.
Sourcepub fn last_status_change_timestamp(self, input: DateTime) -> Self
pub fn last_status_change_timestamp(self, input: DateTime) -> Self
The status of how current the data is.
This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.
Sourcepub fn set_last_status_change_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_last_status_change_timestamp(self, input: Option<DateTime>) -> Self
The status of how current the data is.
This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.
Sourcepub fn get_last_status_change_timestamp(&self) -> &Option<DateTime>
pub fn get_last_status_change_timestamp(&self) -> &Option<DateTime>
The status of how current the data is.
This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.
Sourcepub fn last_reported_timestamp(self, input: DateTime) -> Self
pub fn last_reported_timestamp(self, input: DateTime) -> Self
The last time the Greengrass core device sent a message containing a component's state to the Amazon Web Services Cloud.
A component does not need to see a state change for this field to update.
Sourcepub fn set_last_reported_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_last_reported_timestamp(self, input: Option<DateTime>) -> Self
The last time the Greengrass core device sent a message containing a component's state to the Amazon Web Services Cloud.
A component does not need to see a state change for this field to update.
Sourcepub fn get_last_reported_timestamp(&self) -> &Option<DateTime>
pub fn get_last_reported_timestamp(&self) -> &Option<DateTime>
The last time the Greengrass core device sent a message containing a component's state to the Amazon Web Services Cloud.
A component does not need to see a state change for this field to update.
Sourcepub fn last_installation_source(self, input: impl Into<String>) -> Self
pub fn last_installation_source(self, input: impl Into<String>) -> Self
The most recent deployment source that brought the component to the Greengrass core device. For a thing group deployment or thing deployment, the source will be the ID of the last deployment that contained the component. For local deployments it will be LOCAL
.
Any deployment will attempt to reinstall currently broken components on the device, which will update the last installation source.
Sourcepub fn set_last_installation_source(self, input: Option<String>) -> Self
pub fn set_last_installation_source(self, input: Option<String>) -> Self
The most recent deployment source that brought the component to the Greengrass core device. For a thing group deployment or thing deployment, the source will be the ID of the last deployment that contained the component. For local deployments it will be LOCAL
.
Any deployment will attempt to reinstall currently broken components on the device, which will update the last installation source.
Sourcepub fn get_last_installation_source(&self) -> &Option<String>
pub fn get_last_installation_source(&self) -> &Option<String>
The most recent deployment source that brought the component to the Greengrass core device. For a thing group deployment or thing deployment, the source will be the ID of the last deployment that contained the component. For local deployments it will be LOCAL
.
Any deployment will attempt to reinstall currently broken components on the device, which will update the last installation source.
Sourcepub fn lifecycle_status_codes(self, input: impl Into<String>) -> Self
pub fn lifecycle_status_codes(self, input: impl Into<String>) -> Self
Appends an item to lifecycle_status_codes
.
To override the contents of this collection use set_lifecycle_status_codes
.
The status codes that indicate the reason for failure whenever the lifecycleState
has an error or is in a broken state.
Greengrass nucleus v2.8.0 or later is required to get an accurate lifecycleStatusCodes
response. This response can be inaccurate in earlier Greengrass nucleus versions.
Sourcepub fn set_lifecycle_status_codes(self, input: Option<Vec<String>>) -> Self
pub fn set_lifecycle_status_codes(self, input: Option<Vec<String>>) -> Self
The status codes that indicate the reason for failure whenever the lifecycleState
has an error or is in a broken state.
Greengrass nucleus v2.8.0 or later is required to get an accurate lifecycleStatusCodes
response. This response can be inaccurate in earlier Greengrass nucleus versions.
Sourcepub fn get_lifecycle_status_codes(&self) -> &Option<Vec<String>>
pub fn get_lifecycle_status_codes(&self) -> &Option<Vec<String>>
The status codes that indicate the reason for failure whenever the lifecycleState
has an error or is in a broken state.
Greengrass nucleus v2.8.0 or later is required to get an accurate lifecycleStatusCodes
response. This response can be inaccurate in earlier Greengrass nucleus versions.
Sourcepub fn build(self) -> InstalledComponent
pub fn build(self) -> InstalledComponent
Consumes the builder and constructs a InstalledComponent
.
Trait Implementations§
Source§impl Clone for InstalledComponentBuilder
impl Clone for InstalledComponentBuilder
Source§fn clone(&self) -> InstalledComponentBuilder
fn clone(&self) -> InstalledComponentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for InstalledComponentBuilder
impl Debug for InstalledComponentBuilder
Source§impl Default for InstalledComponentBuilder
impl Default for InstalledComponentBuilder
Source§fn default() -> InstalledComponentBuilder
fn default() -> InstalledComponentBuilder
impl StructuralPartialEq for InstalledComponentBuilder
Auto Trait Implementations§
impl Freeze for InstalledComponentBuilder
impl RefUnwindSafe for InstalledComponentBuilder
impl Send for InstalledComponentBuilder
impl Sync for InstalledComponentBuilder
impl Unpin for InstalledComponentBuilder
impl UnwindSafe for InstalledComponentBuilder
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);