#[non_exhaustive]pub struct WorkflowRun {
pub name: Option<String>,
pub workflow_run_id: Option<String>,
pub previous_run_id: Option<String>,
pub workflow_run_properties: Option<HashMap<String, String>>,
pub started_on: Option<DateTime>,
pub completed_on: Option<DateTime>,
pub status: Option<WorkflowRunStatus>,
pub error_message: Option<String>,
pub statistics: Option<WorkflowRunStatistics>,
pub graph: Option<WorkflowGraph>,
pub starting_event_batch_condition: Option<StartingEventBatchCondition>,
}
Expand description
A workflow run is an execution of a workflow providing all the runtime information.
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.name: Option<String>
Name of the workflow that was run.
workflow_run_id: Option<String>
The ID of this workflow run.
previous_run_id: Option<String>
The ID of the previous workflow run.
workflow_run_properties: Option<HashMap<String, String>>
The workflow run properties which were set during the run.
started_on: Option<DateTime>
The date and time when the workflow run was started.
completed_on: Option<DateTime>
The date and time when the workflow run completed.
status: Option<WorkflowRunStatus>
The status of the workflow run.
error_message: Option<String>
This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo
."
statistics: Option<WorkflowRunStatistics>
The statistics of the run.
graph: Option<WorkflowGraph>
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
starting_event_batch_condition: Option<StartingEventBatchCondition>
The batch condition that started the workflow run.
Implementations§
source§impl WorkflowRun
impl WorkflowRun
sourcepub fn workflow_run_id(&self) -> Option<&str>
pub fn workflow_run_id(&self) -> Option<&str>
The ID of this workflow run.
sourcepub fn previous_run_id(&self) -> Option<&str>
pub fn previous_run_id(&self) -> Option<&str>
The ID of the previous workflow run.
sourcepub fn workflow_run_properties(&self) -> Option<&HashMap<String, String>>
pub fn workflow_run_properties(&self) -> Option<&HashMap<String, String>>
The workflow run properties which were set during the run.
sourcepub fn started_on(&self) -> Option<&DateTime>
pub fn started_on(&self) -> Option<&DateTime>
The date and time when the workflow run was started.
sourcepub fn completed_on(&self) -> Option<&DateTime>
pub fn completed_on(&self) -> Option<&DateTime>
The date and time when the workflow run completed.
sourcepub fn status(&self) -> Option<&WorkflowRunStatus>
pub fn status(&self) -> Option<&WorkflowRunStatus>
The status of the workflow run.
sourcepub fn error_message(&self) -> Option<&str>
pub fn error_message(&self) -> Option<&str>
This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo
."
sourcepub fn statistics(&self) -> Option<&WorkflowRunStatistics>
pub fn statistics(&self) -> Option<&WorkflowRunStatistics>
The statistics of the run.
sourcepub fn graph(&self) -> Option<&WorkflowGraph>
pub fn graph(&self) -> Option<&WorkflowGraph>
The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
sourcepub fn starting_event_batch_condition(
&self,
) -> Option<&StartingEventBatchCondition>
pub fn starting_event_batch_condition( &self, ) -> Option<&StartingEventBatchCondition>
The batch condition that started the workflow run.
source§impl WorkflowRun
impl WorkflowRun
sourcepub fn builder() -> WorkflowRunBuilder
pub fn builder() -> WorkflowRunBuilder
Creates a new builder-style object to manufacture WorkflowRun
.
Trait Implementations§
source§impl Clone for WorkflowRun
impl Clone for WorkflowRun
source§fn clone(&self) -> WorkflowRun
fn clone(&self) -> WorkflowRun
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for WorkflowRun
impl Debug for WorkflowRun
source§impl PartialEq for WorkflowRun
impl PartialEq for WorkflowRun
impl StructuralPartialEq for WorkflowRun
Auto Trait Implementations§
impl Freeze for WorkflowRun
impl RefUnwindSafe for WorkflowRun
impl Send for WorkflowRun
impl Sync for WorkflowRun
impl Unpin for WorkflowRun
impl UnwindSafe for WorkflowRun
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);