Struct aws_sdk_swf::types::WorkflowExecutionInfo

#[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,
}

Contains information about a workflow execution.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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

impl WorkflowExecutionInfo

pub fn execution(&self) -> Option<&WorkflowExecution>

The workflow execution this information is about.

pub fn workflow_type(&self) -> Option<&WorkflowType>

The type of the workflow execution.

pub fn start_timestamp(&self) -> &DateTime

The time when the execution was started.

pub fn close_timestamp(&self) -> Option<&DateTime>

The time when the workflow execution was closed. Set only if the execution status is CLOSED.

pub fn execution_status(&self) -> &ExecutionStatus

The current status of the execution.

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.

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.

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().

pub fn cancel_requested(&self) -> bool

Set to true if a cancellation is requested for this workflow execution.

impl WorkflowExecutionInfo

pub fn builder() -> WorkflowExecutionInfoBuilder

Creates a new builder-style object to manufacture WorkflowExecutionInfo.

Trait Implementations

impl Clone for WorkflowExecutionInfo

fn clone(&self) -> WorkflowExecutionInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkflowExecutionInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for WorkflowExecutionInfo

fn eq(&self, other: &WorkflowExecutionInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WorkflowExecutionInfo