#[non_exhaustive]pub struct PipeTargetBatchJobParametersBuilder { /* private fields */ }
Expand description
A builder for PipeTargetBatchJobParameters
.
Implementations§
Source§impl PipeTargetBatchJobParametersBuilder
impl PipeTargetBatchJobParametersBuilder
Sourcepub fn job_definition(self, input: impl Into<String>) -> Self
pub fn job_definition(self, input: impl Into<String>) -> Self
The job definition used by this job. This value can be one of name
, name:revision
, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
Sourcepub fn set_job_definition(self, input: Option<String>) -> Self
pub fn set_job_definition(self, input: Option<String>) -> Self
The job definition used by this job. This value can be one of name
, name:revision
, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
Sourcepub fn get_job_definition(&self) -> &Option<String>
pub fn get_job_definition(&self) -> &Option<String>
The job definition used by this job. This value can be one of name
, name:revision
, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
Sourcepub fn job_name(self, input: impl Into<String>) -> Self
pub fn job_name(self, input: impl Into<String>) -> Self
The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
This field is required.Sourcepub fn set_job_name(self, input: Option<String>) -> Self
pub fn set_job_name(self, input: Option<String>) -> Self
The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Sourcepub fn get_job_name(&self) -> &Option<String>
pub fn get_job_name(&self) -> &Option<String>
The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Sourcepub fn array_properties(self, input: BatchArrayProperties) -> Self
pub fn array_properties(self, input: BatchArrayProperties) -> Self
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
Sourcepub fn set_array_properties(self, input: Option<BatchArrayProperties>) -> Self
pub fn set_array_properties(self, input: Option<BatchArrayProperties>) -> Self
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
Sourcepub fn get_array_properties(&self) -> &Option<BatchArrayProperties>
pub fn get_array_properties(&self) -> &Option<BatchArrayProperties>
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
Sourcepub fn retry_strategy(self, input: BatchRetryStrategy) -> Self
pub fn retry_strategy(self, input: BatchRetryStrategy) -> Self
The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
Sourcepub fn set_retry_strategy(self, input: Option<BatchRetryStrategy>) -> Self
pub fn set_retry_strategy(self, input: Option<BatchRetryStrategy>) -> Self
The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
Sourcepub fn get_retry_strategy(&self) -> &Option<BatchRetryStrategy>
pub fn get_retry_strategy(&self) -> &Option<BatchRetryStrategy>
The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
Sourcepub fn container_overrides(self, input: BatchContainerOverrides) -> Self
pub fn container_overrides(self, input: BatchContainerOverrides) -> Self
The overrides that are sent to a container.
Sourcepub fn set_container_overrides(
self,
input: Option<BatchContainerOverrides>,
) -> Self
pub fn set_container_overrides( self, input: Option<BatchContainerOverrides>, ) -> Self
The overrides that are sent to a container.
Sourcepub fn get_container_overrides(&self) -> &Option<BatchContainerOverrides>
pub fn get_container_overrides(&self) -> &Option<BatchContainerOverrides>
The overrides that are sent to a container.
Sourcepub fn depends_on(self, input: BatchJobDependency) -> Self
pub fn depends_on(self, input: BatchJobDependency) -> Self
Appends an item to depends_on
.
To override the contents of this collection use set_depends_on
.
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL
type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N
type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
Sourcepub fn set_depends_on(self, input: Option<Vec<BatchJobDependency>>) -> Self
pub fn set_depends_on(self, input: Option<Vec<BatchJobDependency>>) -> Self
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL
type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N
type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
Sourcepub fn get_depends_on(&self) -> &Option<Vec<BatchJobDependency>>
pub fn get_depends_on(&self) -> &Option<Vec<BatchJobDependency>>
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL
type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N
type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
Sourcepub fn parameters(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn parameters(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to parameters
.
To override the contents of this collection use set_parameters
.
Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
Sourcepub fn set_parameters(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_parameters(self, input: Option<HashMap<String, String>>) -> Self
Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
Sourcepub fn get_parameters(&self) -> &Option<HashMap<String, String>>
pub fn get_parameters(&self) -> &Option<HashMap<String, String>>
Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.
Sourcepub fn build(self) -> Result<PipeTargetBatchJobParameters, BuildError>
pub fn build(self) -> Result<PipeTargetBatchJobParameters, BuildError>
Consumes the builder and constructs a PipeTargetBatchJobParameters
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for PipeTargetBatchJobParametersBuilder
impl Clone for PipeTargetBatchJobParametersBuilder
Source§fn clone(&self) -> PipeTargetBatchJobParametersBuilder
fn clone(&self) -> PipeTargetBatchJobParametersBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for PipeTargetBatchJobParametersBuilder
impl Default for PipeTargetBatchJobParametersBuilder
Source§fn default() -> PipeTargetBatchJobParametersBuilder
fn default() -> PipeTargetBatchJobParametersBuilder
Source§impl PartialEq for PipeTargetBatchJobParametersBuilder
impl PartialEq for PipeTargetBatchJobParametersBuilder
Source§fn eq(&self, other: &PipeTargetBatchJobParametersBuilder) -> bool
fn eq(&self, other: &PipeTargetBatchJobParametersBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for PipeTargetBatchJobParametersBuilder
Auto Trait Implementations§
impl Freeze for PipeTargetBatchJobParametersBuilder
impl RefUnwindSafe for PipeTargetBatchJobParametersBuilder
impl Send for PipeTargetBatchJobParametersBuilder
impl Sync for PipeTargetBatchJobParametersBuilder
impl Unpin for PipeTargetBatchJobParametersBuilder
impl UnwindSafe for PipeTargetBatchJobParametersBuilder
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);