#[non_exhaustive]pub struct EnvironmentBuilder { /* private fields */ }
Expand description
A builder for Environment
.
Implementations§
Source§impl EnvironmentBuilder
impl EnvironmentBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the environment.
This field is required.Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the environment.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the environment.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the environment.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The time when the environment 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 environment was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The time when the environment was created.
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 environment was last attempted.
This field is required.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 environment 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 environment 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 environment was last deployed successfully.
This field is required.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 environment 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 environment was last deployed successfully.
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 environment.
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 environment.
Sourcepub fn template_name(self, input: impl Into<String>) -> Self
pub fn template_name(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the environment template.
This field is required.Sourcepub fn set_template_name(self, input: Option<String>) -> Self
pub fn set_template_name(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the environment template.
Sourcepub fn get_template_name(&self) -> &Option<String>
pub fn get_template_name(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the environment template.
Sourcepub fn template_major_version(self, input: impl Into<String>) -> Self
pub fn template_major_version(self, input: impl Into<String>) -> Self
The major version of the environment template.
This field is required.Sourcepub fn set_template_major_version(self, input: Option<String>) -> Self
pub fn set_template_major_version(self, input: Option<String>) -> Self
The major version of the environment template.
Sourcepub fn get_template_major_version(&self) -> &Option<String>
pub fn get_template_major_version(&self) -> &Option<String>
The major version of the environment template.
Sourcepub fn template_minor_version(self, input: impl Into<String>) -> Self
pub fn template_minor_version(self, input: impl Into<String>) -> Self
The minor version of the environment template.
This field is required.Sourcepub fn set_template_minor_version(self, input: Option<String>) -> Self
pub fn set_template_minor_version(self, input: Option<String>) -> Self
The minor version of the environment template.
Sourcepub fn get_template_minor_version(&self) -> &Option<String>
pub fn get_template_minor_version(&self) -> &Option<String>
The minor version of the environment template.
Sourcepub fn deployment_status(self, input: DeploymentStatus) -> Self
pub fn deployment_status(self, input: DeploymentStatus) -> Self
The environment 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 environment deployment status.
Sourcepub fn get_deployment_status(&self) -> &Option<DeploymentStatus>
pub fn get_deployment_status(&self) -> &Option<DeploymentStatus>
The environment deployment status.
Sourcepub fn deployment_status_message(self, input: impl Into<String>) -> Self
pub fn deployment_status_message(self, input: impl Into<String>) -> Self
An environment deployment status message.
Sourcepub fn set_deployment_status_message(self, input: Option<String>) -> Self
pub fn set_deployment_status_message(self, input: Option<String>) -> Self
An environment deployment status message.
Sourcepub fn get_deployment_status_message(&self) -> &Option<String>
pub fn get_deployment_status_message(&self) -> &Option<String>
An environment deployment status message.
Sourcepub fn proton_service_role_arn(self, input: impl Into<String>) -> Self
pub fn proton_service_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
Sourcepub fn set_proton_service_role_arn(self, input: Option<String>) -> Self
pub fn set_proton_service_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
Sourcepub fn get_proton_service_role_arn(&self) -> &Option<String>
pub fn get_proton_service_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
Sourcepub fn environment_account_connection_id(self, input: impl Into<String>) -> Self
pub fn environment_account_connection_id(self, input: impl Into<String>) -> Self
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
Sourcepub fn set_environment_account_connection_id(
self,
input: Option<String>,
) -> Self
pub fn set_environment_account_connection_id( self, input: Option<String>, ) -> Self
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
Sourcepub fn get_environment_account_connection_id(&self) -> &Option<String>
pub fn get_environment_account_connection_id(&self) -> &Option<String>
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
Sourcepub fn environment_account_id(self, input: impl Into<String>) -> Self
pub fn environment_account_id(self, input: impl Into<String>) -> Self
The ID of the environment account that the environment infrastructure resources are provisioned in.
Sourcepub fn set_environment_account_id(self, input: Option<String>) -> Self
pub fn set_environment_account_id(self, input: Option<String>) -> Self
The ID of the environment account that the environment infrastructure resources are provisioned in.
Sourcepub fn get_environment_account_id(&self) -> &Option<String>
pub fn get_environment_account_id(&self) -> &Option<String>
The ID of the environment account that the environment infrastructure resources are provisioned in.
Sourcepub fn provisioning(self, input: Provisioning) -> Self
pub fn provisioning(self, input: Provisioning) -> Self
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
Sourcepub fn set_provisioning(self, input: Option<Provisioning>) -> Self
pub fn set_provisioning(self, input: Option<Provisioning>) -> Self
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
Sourcepub fn get_provisioning(&self) -> &Option<Provisioning>
pub fn get_provisioning(&self) -> &Option<Provisioning>
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
Sourcepub fn provisioning_repository(self, input: RepositoryBranch) -> Self
pub fn provisioning_repository(self, input: RepositoryBranch) -> Self
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
Sourcepub fn set_provisioning_repository(
self,
input: Option<RepositoryBranch>,
) -> Self
pub fn set_provisioning_repository( self, input: Option<RepositoryBranch>, ) -> Self
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
Sourcepub fn get_provisioning_repository(&self) -> &Option<RepositoryBranch>
pub fn get_provisioning_repository(&self) -> &Option<RepositoryBranch>
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
Sourcepub fn component_role_arn(self, input: impl Into<String>) -> Self
pub fn component_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn
to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide.
Sourcepub fn set_component_role_arn(self, input: Option<String>) -> Self
pub fn set_component_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn
to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide.
Sourcepub fn get_component_role_arn(&self) -> &Option<String>
pub fn get_component_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn
to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide.
Sourcepub fn codebuild_role_arn(self, input: impl Into<String>) -> Self
pub fn codebuild_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
Sourcepub fn set_codebuild_role_arn(self, input: Option<String>) -> Self
pub fn set_codebuild_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
Sourcepub fn get_codebuild_role_arn(&self) -> &Option<String>
pub fn get_codebuild_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
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 environment.
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 environment.
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 environment.
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 environment.
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 environment.
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 environment.
Sourcepub fn build(self) -> Result<Environment, BuildError>
pub fn build(self) -> Result<Environment, BuildError>
Consumes the builder and constructs a Environment
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for EnvironmentBuilder
impl Clone for EnvironmentBuilder
Source§fn clone(&self) -> EnvironmentBuilder
fn clone(&self) -> EnvironmentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EnvironmentBuilder
impl Debug for EnvironmentBuilder
Source§impl Default for EnvironmentBuilder
impl Default for EnvironmentBuilder
Source§fn default() -> EnvironmentBuilder
fn default() -> EnvironmentBuilder
Source§impl PartialEq for EnvironmentBuilder
impl PartialEq for EnvironmentBuilder
impl StructuralPartialEq for EnvironmentBuilder
Auto Trait Implementations§
impl Freeze for EnvironmentBuilder
impl RefUnwindSafe for EnvironmentBuilder
impl Send for EnvironmentBuilder
impl Sync for EnvironmentBuilder
impl Unpin for EnvironmentBuilder
impl UnwindSafe for EnvironmentBuilder
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);