Struct aws_sdk_swf::types::WorkflowExecutionInfo
source · #[non_exhaustive]pub struct WorkflowExecutionInfo {
pub execution: Option<WorkflowExecution>,
pub workflow_type: Option<WorkflowType>,
pub start_timestamp: DateTime,
pub close_timestamp: Option<DateTime>,
pub execution_status: ExecutionStatus,
pub close_status: Option<CloseStatus>,
pub parent: Option<WorkflowExecution>,
pub tag_list: Option<Vec<String>>,
pub cancel_requested: bool,
}
Expand description
Contains information about a workflow execution.
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.execution: Option<WorkflowExecution>
The workflow execution this information is about.
workflow_type: Option<WorkflowType>
The type of the workflow execution.
start_timestamp: DateTime
The time when the execution was started.
close_timestamp: Option<DateTime>
The time when the workflow execution was closed. Set only if the execution status is CLOSED.
execution_status: ExecutionStatus
The current status of the execution.
close_status: Option<CloseStatus>
If the execution status is closed then this specifies how the execution was closed:
-
COMPLETED
– the execution was successfully completed. -
CANCELED
– the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed. -
TERMINATED
– the execution was force terminated. -
FAILED
– the execution failed to complete. -
TIMED_OUT
– the execution did not complete in the alloted time and was automatically timed out. -
CONTINUED_AS_NEW
– the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.
parent: Option<WorkflowExecution>
If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
tag_list: Option<Vec<String>>
The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.
cancel_requested: bool
Set to true if a cancellation is requested for this workflow execution.
Implementations§
source§impl WorkflowExecutionInfo
impl WorkflowExecutionInfo
sourcepub fn execution(&self) -> Option<&WorkflowExecution>
pub fn execution(&self) -> Option<&WorkflowExecution>
The workflow execution this information is about.
sourcepub fn workflow_type(&self) -> Option<&WorkflowType>
pub fn workflow_type(&self) -> Option<&WorkflowType>
The type of the workflow execution.
sourcepub fn start_timestamp(&self) -> &DateTime
pub fn start_timestamp(&self) -> &DateTime
The time when the execution was started.
sourcepub fn close_timestamp(&self) -> Option<&DateTime>
pub fn close_timestamp(&self) -> Option<&DateTime>
The time when the workflow execution was closed. Set only if the execution status is CLOSED.
sourcepub fn execution_status(&self) -> &ExecutionStatus
pub fn execution_status(&self) -> &ExecutionStatus
The current status of the execution.
sourcepub fn close_status(&self) -> Option<&CloseStatus>
pub fn close_status(&self) -> Option<&CloseStatus>
If the execution status is closed then this specifies how the execution was closed:
-
COMPLETED
– the execution was successfully completed. -
CANCELED
– the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed. -
TERMINATED
– the execution was force terminated. -
FAILED
– the execution failed to complete. -
TIMED_OUT
– the execution did not complete in the alloted time and was automatically timed out. -
CONTINUED_AS_NEW
– the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.
sourcepub fn parent(&self) -> Option<&WorkflowExecution>
pub fn parent(&self) -> Option<&WorkflowExecution>
If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
sourcepub fn tag_list(&self) -> &[String]
pub fn tag_list(&self) -> &[String]
The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_list.is_none()
.
sourcepub fn cancel_requested(&self) -> bool
pub fn cancel_requested(&self) -> bool
Set to true if a cancellation is requested for this workflow execution.
source§impl WorkflowExecutionInfo
impl WorkflowExecutionInfo
sourcepub fn builder() -> WorkflowExecutionInfoBuilder
pub fn builder() -> WorkflowExecutionInfoBuilder
Creates a new builder-style object to manufacture WorkflowExecutionInfo
.
Trait Implementations§
source§impl Clone for WorkflowExecutionInfo
impl Clone for WorkflowExecutionInfo
source§fn clone(&self) -> WorkflowExecutionInfo
fn clone(&self) -> WorkflowExecutionInfo
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for WorkflowExecutionInfo
impl Debug for WorkflowExecutionInfo
source§impl PartialEq for WorkflowExecutionInfo
impl PartialEq for WorkflowExecutionInfo
source§fn eq(&self, other: &WorkflowExecutionInfo) -> bool
fn eq(&self, other: &WorkflowExecutionInfo) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for WorkflowExecutionInfo
Auto Trait Implementations§
impl Freeze for WorkflowExecutionInfo
impl RefUnwindSafe for WorkflowExecutionInfo
impl Send for WorkflowExecutionInfo
impl Sync for WorkflowExecutionInfo
impl Unpin for WorkflowExecutionInfo
impl UnwindSafe for WorkflowExecutionInfo
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> 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 more