#[non_exhaustive]pub struct PipelineExecutionStep {
pub step_name: Option<String>,
pub step_display_name: Option<String>,
pub step_description: Option<String>,
pub start_time: Option<DateTime>,
pub end_time: Option<DateTime>,
pub step_status: Option<StepStatus>,
pub cache_hit_result: Option<CacheHitResult>,
pub failure_reason: Option<String>,
pub metadata: Option<PipelineExecutionStepMetadata>,
pub attempt_count: Option<i32>,
pub selective_execution_result: Option<SelectiveExecutionResult>,
}
Expand description
An execution of a step in a pipeline.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.step_name: Option<String>
The name of the step that is executed.
step_display_name: Option<String>
The display name of the step.
step_description: Option<String>
The description of the step.
start_time: Option<DateTime>
The time that the step started executing.
end_time: Option<DateTime>
The time that the step stopped executing.
step_status: Option<StepStatus>
The status of the step execution.
cache_hit_result: Option<CacheHitResult>
If this pipeline execution step was cached, details on the cache hit.
failure_reason: Option<String>
The reason why the step failed execution. This is only returned if the step failed its execution.
metadata: Option<PipelineExecutionStepMetadata>
Metadata to run the pipeline step.
attempt_count: Option<i32>
The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
selective_execution_result: Option<SelectiveExecutionResult>
The ARN from an execution of the current pipeline from which results are reused for this step.
Implementations§
Source§impl PipelineExecutionStep
impl PipelineExecutionStep
Sourcepub fn step_display_name(&self) -> Option<&str>
pub fn step_display_name(&self) -> Option<&str>
The display name of the step.
Sourcepub fn step_description(&self) -> Option<&str>
pub fn step_description(&self) -> Option<&str>
The description of the step.
Sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
The time that the step started executing.
Sourcepub fn step_status(&self) -> Option<&StepStatus>
pub fn step_status(&self) -> Option<&StepStatus>
The status of the step execution.
Sourcepub fn cache_hit_result(&self) -> Option<&CacheHitResult>
pub fn cache_hit_result(&self) -> Option<&CacheHitResult>
If this pipeline execution step was cached, details on the cache hit.
Sourcepub fn failure_reason(&self) -> Option<&str>
pub fn failure_reason(&self) -> Option<&str>
The reason why the step failed execution. This is only returned if the step failed its execution.
Sourcepub fn metadata(&self) -> Option<&PipelineExecutionStepMetadata>
pub fn metadata(&self) -> Option<&PipelineExecutionStepMetadata>
Metadata to run the pipeline step.
Sourcepub fn attempt_count(&self) -> Option<i32>
pub fn 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) -> Option<&SelectiveExecutionResult>
pub fn selective_execution_result(&self) -> Option<&SelectiveExecutionResult>
The ARN from an execution of the current pipeline from which results are reused for this step.
Source§impl PipelineExecutionStep
impl PipelineExecutionStep
Sourcepub fn builder() -> PipelineExecutionStepBuilder
pub fn builder() -> PipelineExecutionStepBuilder
Creates a new builder-style object to manufacture PipelineExecutionStep
.
Trait Implementations§
Source§impl Clone for PipelineExecutionStep
impl Clone for PipelineExecutionStep
Source§fn clone(&self) -> PipelineExecutionStep
fn clone(&self) -> PipelineExecutionStep
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PipelineExecutionStep
impl Debug for PipelineExecutionStep
Source§impl PartialEq for PipelineExecutionStep
impl PartialEq for PipelineExecutionStep
impl StructuralPartialEq for PipelineExecutionStep
Auto Trait Implementations§
impl Freeze for PipelineExecutionStep
impl RefUnwindSafe for PipelineExecutionStep
impl Send for PipelineExecutionStep
impl Sync for PipelineExecutionStep
impl Unpin for PipelineExecutionStep
impl UnwindSafe for PipelineExecutionStep
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);