#[non_exhaustive]pub struct PipelineExecutionStepBuilder { /* private fields */ }
Expand description
A builder for PipelineExecutionStep
.
Implementations§
Source§impl PipelineExecutionStepBuilder
impl PipelineExecutionStepBuilder
Sourcepub fn step_name(self, input: impl Into<String>) -> Self
pub fn step_name(self, input: impl Into<String>) -> Self
The name of the step that is executed.
Sourcepub fn set_step_name(self, input: Option<String>) -> Self
pub fn set_step_name(self, input: Option<String>) -> Self
The name of the step that is executed.
Sourcepub fn get_step_name(&self) -> &Option<String>
pub fn get_step_name(&self) -> &Option<String>
The name of the step that is executed.
Sourcepub fn step_display_name(self, input: impl Into<String>) -> Self
pub fn step_display_name(self, input: impl Into<String>) -> Self
The display name of the step.
Sourcepub fn set_step_display_name(self, input: Option<String>) -> Self
pub fn set_step_display_name(self, input: Option<String>) -> Self
The display name of the step.
Sourcepub fn get_step_display_name(&self) -> &Option<String>
pub fn get_step_display_name(&self) -> &Option<String>
The display name of the step.
Sourcepub fn step_description(self, input: impl Into<String>) -> Self
pub fn step_description(self, input: impl Into<String>) -> Self
The description of the step.
Sourcepub fn set_step_description(self, input: Option<String>) -> Self
pub fn set_step_description(self, input: Option<String>) -> Self
The description of the step.
Sourcepub fn get_step_description(&self) -> &Option<String>
pub fn get_step_description(&self) -> &Option<String>
The description of the step.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The time that the step started executing.
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The time that the step started executing.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The time that the step started executing.
Sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
The time that the step stopped executing.
Sourcepub fn get_end_time(&self) -> &Option<DateTime>
pub fn get_end_time(&self) -> &Option<DateTime>
The time that the step stopped executing.
Sourcepub fn step_status(self, input: StepStatus) -> Self
pub fn step_status(self, input: StepStatus) -> Self
The status of the step execution.
Sourcepub fn set_step_status(self, input: Option<StepStatus>) -> Self
pub fn set_step_status(self, input: Option<StepStatus>) -> Self
The status of the step execution.
Sourcepub fn get_step_status(&self) -> &Option<StepStatus>
pub fn get_step_status(&self) -> &Option<StepStatus>
The status of the step execution.
Sourcepub fn cache_hit_result(self, input: CacheHitResult) -> Self
pub fn cache_hit_result(self, input: CacheHitResult) -> Self
If this pipeline execution step was cached, details on the cache hit.
Sourcepub fn set_cache_hit_result(self, input: Option<CacheHitResult>) -> Self
pub fn set_cache_hit_result(self, input: Option<CacheHitResult>) -> Self
If this pipeline execution step was cached, details on the cache hit.
Sourcepub fn get_cache_hit_result(&self) -> &Option<CacheHitResult>
pub fn get_cache_hit_result(&self) -> &Option<CacheHitResult>
If this pipeline execution step was cached, details on the cache hit.
Sourcepub fn failure_reason(self, input: impl Into<String>) -> Self
pub fn failure_reason(self, input: impl Into<String>) -> Self
The reason why the step failed execution. This is only returned if the step failed its execution.
Sourcepub fn set_failure_reason(self, input: Option<String>) -> Self
pub fn set_failure_reason(self, input: Option<String>) -> Self
The reason why the step failed execution. This is only returned if the step failed its execution.
Sourcepub fn get_failure_reason(&self) -> &Option<String>
pub fn get_failure_reason(&self) -> &Option<String>
The reason why the step failed execution. This is only returned if the step failed its execution.
Sourcepub fn metadata(self, input: PipelineExecutionStepMetadata) -> Self
pub fn metadata(self, input: PipelineExecutionStepMetadata) -> Self
Metadata to run the pipeline step.
Sourcepub fn set_metadata(self, input: Option<PipelineExecutionStepMetadata>) -> Self
pub fn set_metadata(self, input: Option<PipelineExecutionStepMetadata>) -> Self
Metadata to run the pipeline step.
Sourcepub fn get_metadata(&self) -> &Option<PipelineExecutionStepMetadata>
pub fn get_metadata(&self) -> &Option<PipelineExecutionStepMetadata>
Metadata to run the pipeline step.
Sourcepub fn attempt_count(self, input: i32) -> Self
pub fn attempt_count(self, input: i32) -> Self
The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
Sourcepub fn set_attempt_count(self, input: Option<i32>) -> Self
pub fn set_attempt_count(self, input: Option<i32>) -> Self
The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
Sourcepub fn get_attempt_count(&self) -> &Option<i32>
pub fn get_attempt_count(&self) -> &Option<i32>
The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
Sourcepub fn selective_execution_result(self, input: SelectiveExecutionResult) -> Self
pub fn selective_execution_result(self, input: SelectiveExecutionResult) -> Self
The ARN from an execution of the current pipeline from which results are reused for this step.
Sourcepub fn set_selective_execution_result(
self,
input: Option<SelectiveExecutionResult>,
) -> Self
pub fn set_selective_execution_result( self, input: Option<SelectiveExecutionResult>, ) -> Self
The ARN from an execution of the current pipeline from which results are reused for this step.
Sourcepub fn get_selective_execution_result(
&self,
) -> &Option<SelectiveExecutionResult>
pub fn get_selective_execution_result( &self, ) -> &Option<SelectiveExecutionResult>
The ARN from an execution of the current pipeline from which results are reused for this step.
Sourcepub fn build(self) -> PipelineExecutionStep
pub fn build(self) -> PipelineExecutionStep
Consumes the builder and constructs a PipelineExecutionStep
.
Trait Implementations§
Source§impl Clone for PipelineExecutionStepBuilder
impl Clone for PipelineExecutionStepBuilder
Source§fn clone(&self) -> PipelineExecutionStepBuilder
fn clone(&self) -> PipelineExecutionStepBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PipelineExecutionStepBuilder
impl Debug for PipelineExecutionStepBuilder
Source§impl Default for PipelineExecutionStepBuilder
impl Default for PipelineExecutionStepBuilder
Source§fn default() -> PipelineExecutionStepBuilder
fn default() -> PipelineExecutionStepBuilder
Source§impl PartialEq for PipelineExecutionStepBuilder
impl PartialEq for PipelineExecutionStepBuilder
Source§fn eq(&self, other: &PipelineExecutionStepBuilder) -> bool
fn eq(&self, other: &PipelineExecutionStepBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for PipelineExecutionStepBuilder
Auto Trait Implementations§
impl Freeze for PipelineExecutionStepBuilder
impl RefUnwindSafe for PipelineExecutionStepBuilder
impl Send for PipelineExecutionStepBuilder
impl Sync for PipelineExecutionStepBuilder
impl Unpin for PipelineExecutionStepBuilder
impl UnwindSafe for PipelineExecutionStepBuilder
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);