#[non_exhaustive]pub struct WorkflowExecutionMetadata {
pub workflow_build_version_arn: Option<String>,
pub workflow_execution_id: Option<String>,
pub type: Option<WorkflowType>,
pub status: Option<WorkflowExecutionStatus>,
pub message: Option<String>,
pub total_step_count: i32,
pub total_steps_succeeded: i32,
pub total_steps_failed: i32,
pub total_steps_skipped: i32,
pub start_time: Option<String>,
pub end_time: Option<String>,
pub parallel_group: Option<String>,
}
Expand description
Metadata that includes details and status from this runtime instance of the workflow.
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.workflow_build_version_arn: Option<String>
The Amazon Resource Name (ARN) of the workflow resource build version that ran.
workflow_execution_id: Option<String>
Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
type: Option<WorkflowType>
Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
status: Option<WorkflowExecutionStatus>
The current runtime status for this workflow.
message: Option<String>
The runtime output message from the workflow, if applicable.
total_step_count: i32
The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
total_steps_succeeded: i32
A runtime count for the number of steps in the workflow that ran successfully.
total_steps_failed: i32
A runtime count for the number of steps in the workflow that failed.
total_steps_skipped: i32
A runtime count for the number of steps in the workflow that were skipped.
start_time: Option<String>
The timestamp when the runtime instance of this workflow started.
end_time: Option<String>
The timestamp when this runtime instance of the workflow finished.
parallel_group: Option<String>
The name of the test group that included the test workflow resource at runtime.
Implementations§
Source§impl WorkflowExecutionMetadata
impl WorkflowExecutionMetadata
Sourcepub fn workflow_build_version_arn(&self) -> Option<&str>
pub fn workflow_build_version_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the workflow resource build version that ran.
Sourcepub fn workflow_execution_id(&self) -> Option<&str>
pub fn workflow_execution_id(&self) -> Option<&str>
Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
Sourcepub fn type(&self) -> Option<&WorkflowType>
pub fn type(&self) -> Option<&WorkflowType>
Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
Sourcepub fn status(&self) -> Option<&WorkflowExecutionStatus>
pub fn status(&self) -> Option<&WorkflowExecutionStatus>
The current runtime status for this workflow.
Sourcepub fn message(&self) -> Option<&str>
pub fn message(&self) -> Option<&str>
The runtime output message from the workflow, if applicable.
Sourcepub fn total_step_count(&self) -> i32
pub fn total_step_count(&self) -> i32
The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
Sourcepub fn total_steps_succeeded(&self) -> i32
pub fn total_steps_succeeded(&self) -> i32
A runtime count for the number of steps in the workflow that ran successfully.
Sourcepub fn total_steps_failed(&self) -> i32
pub fn total_steps_failed(&self) -> i32
A runtime count for the number of steps in the workflow that failed.
Sourcepub fn total_steps_skipped(&self) -> i32
pub fn total_steps_skipped(&self) -> i32
A runtime count for the number of steps in the workflow that were skipped.
Sourcepub fn start_time(&self) -> Option<&str>
pub fn start_time(&self) -> Option<&str>
The timestamp when the runtime instance of this workflow started.
Sourcepub fn end_time(&self) -> Option<&str>
pub fn end_time(&self) -> Option<&str>
The timestamp when this runtime instance of the workflow finished.
Sourcepub fn parallel_group(&self) -> Option<&str>
pub fn parallel_group(&self) -> Option<&str>
The name of the test group that included the test workflow resource at runtime.
Source§impl WorkflowExecutionMetadata
impl WorkflowExecutionMetadata
Sourcepub fn builder() -> WorkflowExecutionMetadataBuilder
pub fn builder() -> WorkflowExecutionMetadataBuilder
Creates a new builder-style object to manufacture WorkflowExecutionMetadata
.
Trait Implementations§
Source§impl Clone for WorkflowExecutionMetadata
impl Clone for WorkflowExecutionMetadata
Source§fn clone(&self) -> WorkflowExecutionMetadata
fn clone(&self) -> WorkflowExecutionMetadata
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for WorkflowExecutionMetadata
impl Debug for WorkflowExecutionMetadata
Source§impl PartialEq for WorkflowExecutionMetadata
impl PartialEq for WorkflowExecutionMetadata
Source§fn eq(&self, other: &WorkflowExecutionMetadata) -> bool
fn eq(&self, other: &WorkflowExecutionMetadata) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for WorkflowExecutionMetadata
Auto Trait Implementations§
impl Freeze for WorkflowExecutionMetadata
impl RefUnwindSafe for WorkflowExecutionMetadata
impl Send for WorkflowExecutionMetadata
impl Sync for WorkflowExecutionMetadata
impl Unpin for WorkflowExecutionMetadata
impl UnwindSafe for WorkflowExecutionMetadata
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);