#[non_exhaustive]pub struct StartSimulationJobBatchOutputBuilder { /* private fields */ }
Expand description
A builder for StartSimulationJobBatchOutput
.
Implementations§
Source§impl StartSimulationJobBatchOutputBuilder
impl StartSimulationJobBatchOutputBuilder
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 batch.
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 batch.
Sourcepub fn status(self, input: SimulationJobBatchStatus) -> Self
pub fn status(self, input: SimulationJobBatchStatus) -> Self
The status of the simulation job batch.
- Pending
-
The simulation job batch request is pending.
- InProgress
-
The simulation job batch is in progress.
- Failed
-
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
-
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
-
The simulation batch job was cancelled.
- Canceling
-
The simulation batch job is being cancelled.
- Completing
-
The simulation batch job is completing.
- TimingOut
-
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
-
The simulation batch job timed out.
Sourcepub fn set_status(self, input: Option<SimulationJobBatchStatus>) -> Self
pub fn set_status(self, input: Option<SimulationJobBatchStatus>) -> Self
The status of the simulation job batch.
- Pending
-
The simulation job batch request is pending.
- InProgress
-
The simulation job batch is in progress.
- Failed
-
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
-
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
-
The simulation batch job was cancelled.
- Canceling
-
The simulation batch job is being cancelled.
- Completing
-
The simulation batch job is completing.
- TimingOut
-
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
-
The simulation batch job timed out.
Sourcepub fn get_status(&self) -> &Option<SimulationJobBatchStatus>
pub fn get_status(&self) -> &Option<SimulationJobBatchStatus>
The status of the simulation job batch.
- Pending
-
The simulation job batch request is pending.
- InProgress
-
The simulation job batch is in progress.
- Failed
-
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like
InternalServiceError
). SeefailureCode
andfailureReason
for more information. - Completed
-
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to
InternalServiceError
and (2) when all created simulation jobs have reached a terminal state (for example,Completed
orFailed
). - Canceled
-
The simulation batch job was cancelled.
- Canceling
-
The simulation batch job is being cancelled.
- Completing
-
The simulation batch job is completing.
- TimingOut
-
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like
InternalServiceError
), the batch status will beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
-
The simulation batch job timed out.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The time, in milliseconds since the epoch, when the simulation job batch was created.
Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The time, in milliseconds since the epoch, when the simulation job batch was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The time, in milliseconds since the epoch, when the simulation job batch was created.
Sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Sourcepub fn batch_policy(self, input: BatchPolicy) -> Self
pub fn batch_policy(self, input: BatchPolicy) -> Self
The batch policy.
Sourcepub fn set_batch_policy(self, input: Option<BatchPolicy>) -> Self
pub fn set_batch_policy(self, input: Option<BatchPolicy>) -> Self
The batch policy.
Sourcepub fn get_batch_policy(&self) -> &Option<BatchPolicy>
pub fn get_batch_policy(&self) -> &Option<BatchPolicy>
The batch policy.
Sourcepub fn failure_code(self, input: SimulationJobBatchErrorCode) -> Self
pub fn failure_code(self, input: SimulationJobBatchErrorCode) -> Self
The failure code if the simulation job batch failed.
Sourcepub fn set_failure_code(
self,
input: Option<SimulationJobBatchErrorCode>,
) -> Self
pub fn set_failure_code( self, input: Option<SimulationJobBatchErrorCode>, ) -> Self
The failure code if the simulation job batch failed.
Sourcepub fn get_failure_code(&self) -> &Option<SimulationJobBatchErrorCode>
pub fn get_failure_code(&self) -> &Option<SimulationJobBatchErrorCode>
The failure code if the simulation job batch failed.
Sourcepub fn failure_reason(self, input: impl Into<String>) -> Self
pub fn failure_reason(self, input: impl Into<String>) -> Self
The reason the simulation job batch failed.
Sourcepub fn set_failure_reason(self, input: Option<String>) -> Self
pub fn set_failure_reason(self, input: Option<String>) -> Self
The reason the simulation job batch failed.
Sourcepub fn get_failure_reason(&self) -> &Option<String>
pub fn get_failure_reason(&self) -> &Option<String>
The reason the simulation job batch failed.
Sourcepub fn failed_requests(self, input: FailedCreateSimulationJobRequest) -> Self
pub fn failed_requests(self, input: FailedCreateSimulationJobRequest) -> Self
Appends an item to failed_requests
.
To override the contents of this collection use set_failed_requests
.
A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
Sourcepub fn set_failed_requests(
self,
input: Option<Vec<FailedCreateSimulationJobRequest>>,
) -> Self
pub fn set_failed_requests( self, input: Option<Vec<FailedCreateSimulationJobRequest>>, ) -> Self
A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
Sourcepub fn get_failed_requests(
&self,
) -> &Option<Vec<FailedCreateSimulationJobRequest>>
pub fn get_failed_requests( &self, ) -> &Option<Vec<FailedCreateSimulationJobRequest>>
A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
Sourcepub fn pending_requests(self, input: SimulationJobRequest) -> Self
pub fn pending_requests(self, input: SimulationJobRequest) -> Self
Appends an item to pending_requests
.
To override the contents of this collection use set_pending_requests
.
A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
Sourcepub fn set_pending_requests(
self,
input: Option<Vec<SimulationJobRequest>>,
) -> Self
pub fn set_pending_requests( self, input: Option<Vec<SimulationJobRequest>>, ) -> Self
A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
Sourcepub fn get_pending_requests(&self) -> &Option<Vec<SimulationJobRequest>>
pub fn get_pending_requests(&self) -> &Option<Vec<SimulationJobRequest>>
A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
Sourcepub fn created_requests(self, input: SimulationJobSummary) -> Self
pub fn created_requests(self, input: SimulationJobSummary) -> Self
Appends an item to created_requests
.
To override the contents of this collection use set_created_requests
.
A list of created simulation job request summaries.
Sourcepub fn set_created_requests(
self,
input: Option<Vec<SimulationJobSummary>>,
) -> Self
pub fn set_created_requests( self, input: Option<Vec<SimulationJobSummary>>, ) -> Self
A list of created simulation job request summaries.
Sourcepub fn get_created_requests(&self) -> &Option<Vec<SimulationJobSummary>>
pub fn get_created_requests(&self) -> &Option<Vec<SimulationJobSummary>>
A list of created simulation job request summaries.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
A map that contains tag keys and tag values that are attached to the deployment job batch.
A map that contains tag keys and tag values that are attached to the deployment job batch.
A map that contains tag keys and tag values that are attached to the deployment job batch.
Sourcepub fn build(self) -> StartSimulationJobBatchOutput
pub fn build(self) -> StartSimulationJobBatchOutput
Consumes the builder and constructs a StartSimulationJobBatchOutput
.
Trait Implementations§
Source§impl Clone for StartSimulationJobBatchOutputBuilder
impl Clone for StartSimulationJobBatchOutputBuilder
Source§fn clone(&self) -> StartSimulationJobBatchOutputBuilder
fn clone(&self) -> StartSimulationJobBatchOutputBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for StartSimulationJobBatchOutputBuilder
impl Default for StartSimulationJobBatchOutputBuilder
Source§fn default() -> StartSimulationJobBatchOutputBuilder
fn default() -> StartSimulationJobBatchOutputBuilder
Source§impl PartialEq for StartSimulationJobBatchOutputBuilder
impl PartialEq for StartSimulationJobBatchOutputBuilder
Source§fn eq(&self, other: &StartSimulationJobBatchOutputBuilder) -> bool
fn eq(&self, other: &StartSimulationJobBatchOutputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for StartSimulationJobBatchOutputBuilder
Auto Trait Implementations§
impl Freeze for StartSimulationJobBatchOutputBuilder
impl RefUnwindSafe for StartSimulationJobBatchOutputBuilder
impl Send for StartSimulationJobBatchOutputBuilder
impl Sync for StartSimulationJobBatchOutputBuilder
impl Unpin for StartSimulationJobBatchOutputBuilder
impl UnwindSafe for StartSimulationJobBatchOutputBuilder
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);