#[non_exhaustive]pub struct ActionDeclarationBuilder { /* private fields */ }
Expand description
A builder for ActionDeclaration
.
Implementations§
Source§impl ActionDeclarationBuilder
impl ActionDeclarationBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The action declaration's name.
This field is required.Sourcepub fn action_type_id(self, input: ActionTypeId) -> Self
pub fn action_type_id(self, input: ActionTypeId) -> Self
Specifies the action type and the provider of the action.
This field is required.Sourcepub fn set_action_type_id(self, input: Option<ActionTypeId>) -> Self
pub fn set_action_type_id(self, input: Option<ActionTypeId>) -> Self
Specifies the action type and the provider of the action.
Sourcepub fn get_action_type_id(&self) -> &Option<ActionTypeId>
pub fn get_action_type_id(&self) -> &Option<ActionTypeId>
Specifies the action type and the provider of the action.
Sourcepub fn set_run_order(self, input: Option<i32>) -> Self
pub fn set_run_order(self, input: Option<i32>) -> Self
The order in which actions are run.
Sourcepub fn get_run_order(&self) -> &Option<i32>
pub fn get_run_order(&self) -> &Option<i32>
The order in which actions are run.
Sourcepub fn configuration(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn configuration(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to configuration
.
To override the contents of this collection use set_configuration
.
The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
Sourcepub fn set_configuration(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_configuration(self, input: Option<HashMap<String, String>>) -> Self
The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
Sourcepub fn get_configuration(&self) -> &Option<HashMap<String, String>>
pub fn get_configuration(&self) -> &Option<HashMap<String, String>>
The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
Sourcepub fn commands(self, input: impl Into<String>) -> Self
pub fn commands(self, input: impl Into<String>) -> Self
Appends an item to commands
.
To override the contents of this collection use set_commands
.
The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Using compute time for this action will incur separate charges in CodeBuild.
Sourcepub fn set_commands(self, input: Option<Vec<String>>) -> Self
pub fn set_commands(self, input: Option<Vec<String>>) -> Self
The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Using compute time for this action will incur separate charges in CodeBuild.
Sourcepub fn get_commands(&self) -> &Option<Vec<String>>
pub fn get_commands(&self) -> &Option<Vec<String>>
The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Using compute time for this action will incur separate charges in CodeBuild.
Sourcepub fn output_artifacts(self, input: OutputArtifact) -> Self
pub fn output_artifacts(self, input: OutputArtifact) -> Self
Appends an item to output_artifacts
.
To override the contents of this collection use set_output_artifacts
.
The name or ID of the result of the action declaration, such as a test or build artifact.
Sourcepub fn set_output_artifacts(self, input: Option<Vec<OutputArtifact>>) -> Self
pub fn set_output_artifacts(self, input: Option<Vec<OutputArtifact>>) -> Self
The name or ID of the result of the action declaration, such as a test or build artifact.
Sourcepub fn get_output_artifacts(&self) -> &Option<Vec<OutputArtifact>>
pub fn get_output_artifacts(&self) -> &Option<Vec<OutputArtifact>>
The name or ID of the result of the action declaration, such as a test or build artifact.
Sourcepub fn input_artifacts(self, input: InputArtifact) -> Self
pub fn input_artifacts(self, input: InputArtifact) -> Self
Appends an item to input_artifacts
.
To override the contents of this collection use set_input_artifacts
.
The name or ID of the artifact consumed by the action, such as a test or build artifact.
Sourcepub fn set_input_artifacts(self, input: Option<Vec<InputArtifact>>) -> Self
pub fn set_input_artifacts(self, input: Option<Vec<InputArtifact>>) -> Self
The name or ID of the artifact consumed by the action, such as a test or build artifact.
Sourcepub fn get_input_artifacts(&self) -> &Option<Vec<InputArtifact>>
pub fn get_input_artifacts(&self) -> &Option<Vec<InputArtifact>>
The name or ID of the artifact consumed by the action, such as a test or build artifact.
Sourcepub fn output_variables(self, input: impl Into<String>) -> Self
pub fn output_variables(self, input: impl Into<String>) -> Self
Appends an item to output_variables
.
To override the contents of this collection use set_output_variables
.
The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
Sourcepub fn set_output_variables(self, input: Option<Vec<String>>) -> Self
pub fn set_output_variables(self, input: Option<Vec<String>>) -> Self
The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
Sourcepub fn get_output_variables(&self) -> &Option<Vec<String>>
pub fn get_output_variables(&self) -> &Option<Vec<String>>
The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
Sourcepub fn region(self, input: impl Into<String>) -> Self
pub fn region(self, input: impl Into<String>) -> Self
The action declaration's Amazon Web Services Region, such as us-east-1.
Sourcepub fn set_region(self, input: Option<String>) -> Self
pub fn set_region(self, input: Option<String>) -> Self
The action declaration's Amazon Web Services Region, such as us-east-1.
Sourcepub fn get_region(&self) -> &Option<String>
pub fn get_region(&self) -> &Option<String>
The action declaration's Amazon Web Services Region, such as us-east-1.
Sourcepub fn namespace(self, input: impl Into<String>) -> Self
pub fn namespace(self, input: impl Into<String>) -> Self
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
Sourcepub fn set_namespace(self, input: Option<String>) -> Self
pub fn set_namespace(self, input: Option<String>) -> Self
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
Sourcepub fn get_namespace(&self) -> &Option<String>
pub fn get_namespace(&self) -> &Option<String>
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
Sourcepub fn timeout_in_minutes(self, input: i32) -> Self
pub fn timeout_in_minutes(self, input: i32) -> Self
A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline . This attribute is available only to the manual approval ActionType.
Sourcepub fn set_timeout_in_minutes(self, input: Option<i32>) -> Self
pub fn set_timeout_in_minutes(self, input: Option<i32>) -> Self
A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline . This attribute is available only to the manual approval ActionType.
Sourcepub fn get_timeout_in_minutes(&self) -> &Option<i32>
pub fn get_timeout_in_minutes(&self) -> &Option<i32>
A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline . This attribute is available only to the manual approval ActionType.
Sourcepub fn environment_variables(self, input: EnvironmentVariable) -> Self
pub fn environment_variables(self, input: EnvironmentVariable) -> Self
Appends an item to environment_variables
.
To override the contents of this collection use set_environment_variables
.
The environment variables for the action.
Sourcepub fn set_environment_variables(
self,
input: Option<Vec<EnvironmentVariable>>,
) -> Self
pub fn set_environment_variables( self, input: Option<Vec<EnvironmentVariable>>, ) -> Self
The environment variables for the action.
Sourcepub fn get_environment_variables(&self) -> &Option<Vec<EnvironmentVariable>>
pub fn get_environment_variables(&self) -> &Option<Vec<EnvironmentVariable>>
The environment variables for the action.
Sourcepub fn build(self) -> Result<ActionDeclaration, BuildError>
pub fn build(self) -> Result<ActionDeclaration, BuildError>
Consumes the builder and constructs a ActionDeclaration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ActionDeclarationBuilder
impl Clone for ActionDeclarationBuilder
Source§fn clone(&self) -> ActionDeclarationBuilder
fn clone(&self) -> ActionDeclarationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ActionDeclarationBuilder
impl Debug for ActionDeclarationBuilder
Source§impl Default for ActionDeclarationBuilder
impl Default for ActionDeclarationBuilder
Source§fn default() -> ActionDeclarationBuilder
fn default() -> ActionDeclarationBuilder
Source§impl PartialEq for ActionDeclarationBuilder
impl PartialEq for ActionDeclarationBuilder
impl StructuralPartialEq for ActionDeclarationBuilder
Auto Trait Implementations§
impl Freeze for ActionDeclarationBuilder
impl RefUnwindSafe for ActionDeclarationBuilder
impl Send for ActionDeclarationBuilder
impl Sync for ActionDeclarationBuilder
impl Unpin for ActionDeclarationBuilder
impl UnwindSafe for ActionDeclarationBuilder
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);