#[non_exhaustive]pub struct ComponentBuilder { /* private fields */ }
Expand description
A builder for Component
.
Implementations§
Source§impl ComponentBuilder
impl ComponentBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the component.
This field is required.Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the component.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the component.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the component.
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the component.
This field is required.Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the component.
Sourcepub fn environment_name(self, input: impl Into<String>) -> Self
pub fn environment_name(self, input: impl Into<String>) -> Self
The name of the Proton environment that this component is associated with.
This field is required.Sourcepub fn set_environment_name(self, input: Option<String>) -> Self
pub fn set_environment_name(self, input: Option<String>) -> Self
The name of the Proton environment that this component is associated with.
Sourcepub fn get_environment_name(&self) -> &Option<String>
pub fn get_environment_name(&self) -> &Option<String>
The name of the Proton environment that this component is associated with.
Sourcepub fn service_name(self, input: impl Into<String>) -> Self
pub fn service_name(self, input: impl Into<String>) -> Self
The name of the service that serviceInstanceName
is associated with. Provided when a component is attached to a service instance.
Sourcepub fn set_service_name(self, input: Option<String>) -> Self
pub fn set_service_name(self, input: Option<String>) -> Self
The name of the service that serviceInstanceName
is associated with. Provided when a component is attached to a service instance.
Sourcepub fn get_service_name(&self) -> &Option<String>
pub fn get_service_name(&self) -> &Option<String>
The name of the service that serviceInstanceName
is associated with. Provided when a component is attached to a service instance.
Sourcepub fn service_instance_name(self, input: impl Into<String>) -> Self
pub fn service_instance_name(self, input: impl Into<String>) -> Self
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
Sourcepub fn set_service_instance_name(self, input: Option<String>) -> Self
pub fn set_service_instance_name(self, input: Option<String>) -> Self
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
Sourcepub fn get_service_instance_name(&self) -> &Option<String>
pub fn get_service_instance_name(&self) -> &Option<String>
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The time when the component was created.
This field is required.Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The time when the component was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The time when the component was created.
Sourcepub fn last_modified_at(self, input: DateTime) -> Self
pub fn last_modified_at(self, input: DateTime) -> Self
The time when the component was last modified.
This field is required.Sourcepub fn set_last_modified_at(self, input: Option<DateTime>) -> Self
pub fn set_last_modified_at(self, input: Option<DateTime>) -> Self
The time when the component was last modified.
Sourcepub fn get_last_modified_at(&self) -> &Option<DateTime>
pub fn get_last_modified_at(&self) -> &Option<DateTime>
The time when the component was last modified.
Sourcepub fn last_deployment_attempted_at(self, input: DateTime) -> Self
pub fn last_deployment_attempted_at(self, input: DateTime) -> Self
The time when a deployment of the component was last attempted.
Sourcepub fn set_last_deployment_attempted_at(self, input: Option<DateTime>) -> Self
pub fn set_last_deployment_attempted_at(self, input: Option<DateTime>) -> Self
The time when a deployment of the component was last attempted.
Sourcepub fn get_last_deployment_attempted_at(&self) -> &Option<DateTime>
pub fn get_last_deployment_attempted_at(&self) -> &Option<DateTime>
The time when a deployment of the component was last attempted.
Sourcepub fn last_deployment_succeeded_at(self, input: DateTime) -> Self
pub fn last_deployment_succeeded_at(self, input: DateTime) -> Self
The time when the component was last deployed successfully.
Sourcepub fn set_last_deployment_succeeded_at(self, input: Option<DateTime>) -> Self
pub fn set_last_deployment_succeeded_at(self, input: Option<DateTime>) -> Self
The time when the component was last deployed successfully.
Sourcepub fn get_last_deployment_succeeded_at(&self) -> &Option<DateTime>
pub fn get_last_deployment_succeeded_at(&self) -> &Option<DateTime>
The time when the component was last deployed successfully.
Sourcepub fn deployment_status(self, input: DeploymentStatus) -> Self
pub fn deployment_status(self, input: DeploymentStatus) -> Self
The component deployment status.
This field is required.Sourcepub fn set_deployment_status(self, input: Option<DeploymentStatus>) -> Self
pub fn set_deployment_status(self, input: Option<DeploymentStatus>) -> Self
The component deployment status.
Sourcepub fn get_deployment_status(&self) -> &Option<DeploymentStatus>
pub fn get_deployment_status(&self) -> &Option<DeploymentStatus>
The component deployment status.
Sourcepub fn deployment_status_message(self, input: impl Into<String>) -> Self
pub fn deployment_status_message(self, input: impl Into<String>) -> Self
The message associated with the component deployment status.
Sourcepub fn set_deployment_status_message(self, input: Option<String>) -> Self
pub fn set_deployment_status_message(self, input: Option<String>) -> Self
The message associated with the component deployment status.
Sourcepub fn get_deployment_status_message(&self) -> &Option<String>
pub fn get_deployment_status_message(&self) -> &Option<String>
The message associated with the component deployment status.
Sourcepub fn service_spec(self, input: impl Into<String>) -> Self
pub fn service_spec(self, input: impl Into<String>) -> Self
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
Sourcepub fn set_service_spec(self, input: Option<String>) -> Self
pub fn set_service_spec(self, input: Option<String>) -> Self
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
Sourcepub fn get_service_spec(&self) -> &Option<String>
pub fn get_service_spec(&self) -> &Option<String>
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
Sourcepub fn last_client_request_token(self, input: impl Into<String>) -> Self
pub fn last_client_request_token(self, input: impl Into<String>) -> Self
The last token the client requested.
Sourcepub fn set_last_client_request_token(self, input: Option<String>) -> Self
pub fn set_last_client_request_token(self, input: Option<String>) -> Self
The last token the client requested.
Sourcepub fn get_last_client_request_token(&self) -> &Option<String>
pub fn get_last_client_request_token(&self) -> &Option<String>
The last token the client requested.
Sourcepub fn last_attempted_deployment_id(self, input: impl Into<String>) -> Self
pub fn last_attempted_deployment_id(self, input: impl Into<String>) -> Self
The ID of the last attempted deployment of this component.
Sourcepub fn set_last_attempted_deployment_id(self, input: Option<String>) -> Self
pub fn set_last_attempted_deployment_id(self, input: Option<String>) -> Self
The ID of the last attempted deployment of this component.
Sourcepub fn get_last_attempted_deployment_id(&self) -> &Option<String>
pub fn get_last_attempted_deployment_id(&self) -> &Option<String>
The ID of the last attempted deployment of this component.
Sourcepub fn last_succeeded_deployment_id(self, input: impl Into<String>) -> Self
pub fn last_succeeded_deployment_id(self, input: impl Into<String>) -> Self
The ID of the last successful deployment of this component.
Sourcepub fn set_last_succeeded_deployment_id(self, input: Option<String>) -> Self
pub fn set_last_succeeded_deployment_id(self, input: Option<String>) -> Self
The ID of the last successful deployment of this component.
Sourcepub fn get_last_succeeded_deployment_id(&self) -> &Option<String>
pub fn get_last_succeeded_deployment_id(&self) -> &Option<String>
The ID of the last successful deployment of this component.
Trait Implementations§
Source§impl Clone for ComponentBuilder
impl Clone for ComponentBuilder
Source§fn clone(&self) -> ComponentBuilder
fn clone(&self) -> ComponentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ComponentBuilder
impl Debug for ComponentBuilder
Source§impl Default for ComponentBuilder
impl Default for ComponentBuilder
Source§fn default() -> ComponentBuilder
fn default() -> ComponentBuilder
Source§impl PartialEq for ComponentBuilder
impl PartialEq for ComponentBuilder
impl StructuralPartialEq for ComponentBuilder
Auto Trait Implementations§
impl Freeze for ComponentBuilder
impl RefUnwindSafe for ComponentBuilder
impl Send for ComponentBuilder
impl Sync for ComponentBuilder
impl Unpin for ComponentBuilder
impl UnwindSafe for ComponentBuilder
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);