AWS SDK for C++  1.9.131
AWS SDK for C++
Public Member Functions | List of all members
Aws::SWF::Model::WorkflowExecutionInfo Class Reference

#include <WorkflowExecutionInfo.h>

Public Member Functions

 WorkflowExecutionInfo ()
 
 WorkflowExecutionInfo (Aws::Utils::Json::JsonView jsonValue)
 
WorkflowExecutionInfooperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const WorkflowExecutionGetExecution () const
 
bool ExecutionHasBeenSet () const
 
void SetExecution (const WorkflowExecution &value)
 
void SetExecution (WorkflowExecution &&value)
 
WorkflowExecutionInfoWithExecution (const WorkflowExecution &value)
 
WorkflowExecutionInfoWithExecution (WorkflowExecution &&value)
 
const WorkflowTypeGetWorkflowType () const
 
bool WorkflowTypeHasBeenSet () const
 
void SetWorkflowType (const WorkflowType &value)
 
void SetWorkflowType (WorkflowType &&value)
 
WorkflowExecutionInfoWithWorkflowType (const WorkflowType &value)
 
WorkflowExecutionInfoWithWorkflowType (WorkflowType &&value)
 
const Aws::Utils::DateTimeGetStartTimestamp () const
 
bool StartTimestampHasBeenSet () const
 
void SetStartTimestamp (const Aws::Utils::DateTime &value)
 
void SetStartTimestamp (Aws::Utils::DateTime &&value)
 
WorkflowExecutionInfoWithStartTimestamp (const Aws::Utils::DateTime &value)
 
WorkflowExecutionInfoWithStartTimestamp (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCloseTimestamp () const
 
bool CloseTimestampHasBeenSet () const
 
void SetCloseTimestamp (const Aws::Utils::DateTime &value)
 
void SetCloseTimestamp (Aws::Utils::DateTime &&value)
 
WorkflowExecutionInfoWithCloseTimestamp (const Aws::Utils::DateTime &value)
 
WorkflowExecutionInfoWithCloseTimestamp (Aws::Utils::DateTime &&value)
 
const ExecutionStatusGetExecutionStatus () const
 
bool ExecutionStatusHasBeenSet () const
 
void SetExecutionStatus (const ExecutionStatus &value)
 
void SetExecutionStatus (ExecutionStatus &&value)
 
WorkflowExecutionInfoWithExecutionStatus (const ExecutionStatus &value)
 
WorkflowExecutionInfoWithExecutionStatus (ExecutionStatus &&value)
 
const CloseStatusGetCloseStatus () const
 
bool CloseStatusHasBeenSet () const
 
void SetCloseStatus (const CloseStatus &value)
 
void SetCloseStatus (CloseStatus &&value)
 
WorkflowExecutionInfoWithCloseStatus (const CloseStatus &value)
 
WorkflowExecutionInfoWithCloseStatus (CloseStatus &&value)
 
const WorkflowExecutionGetParent () const
 
bool ParentHasBeenSet () const
 
void SetParent (const WorkflowExecution &value)
 
void SetParent (WorkflowExecution &&value)
 
WorkflowExecutionInfoWithParent (const WorkflowExecution &value)
 
WorkflowExecutionInfoWithParent (WorkflowExecution &&value)
 
const Aws::Vector< Aws::String > & GetTagList () const
 
bool TagListHasBeenSet () const
 
void SetTagList (const Aws::Vector< Aws::String > &value)
 
void SetTagList (Aws::Vector< Aws::String > &&value)
 
WorkflowExecutionInfoWithTagList (const Aws::Vector< Aws::String > &value)
 
WorkflowExecutionInfoWithTagList (Aws::Vector< Aws::String > &&value)
 
WorkflowExecutionInfoAddTagList (const Aws::String &value)
 
WorkflowExecutionInfoAddTagList (Aws::String &&value)
 
WorkflowExecutionInfoAddTagList (const char *value)
 
bool GetCancelRequested () const
 
bool CancelRequestedHasBeenSet () const
 
void SetCancelRequested (bool value)
 
WorkflowExecutionInfoWithCancelRequested (bool value)
 

Detailed Description

Contains information about a workflow execution.

See Also:


AWS API Reference

Definition at line 38 of file WorkflowExecutionInfo.h.

Constructor & Destructor Documentation

◆ WorkflowExecutionInfo() [1/2]

Aws::SWF::Model::WorkflowExecutionInfo::WorkflowExecutionInfo ( )

◆ WorkflowExecutionInfo() [2/2]

Aws::SWF::Model::WorkflowExecutionInfo::WorkflowExecutionInfo ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddTagList() [1/3]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::AddTagList ( Aws::String &&  value)
inline

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.

Definition at line 390 of file WorkflowExecutionInfo.h.

◆ AddTagList() [2/3]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::AddTagList ( const Aws::String value)
inline

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.

Definition at line 383 of file WorkflowExecutionInfo.h.

◆ AddTagList() [3/3]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::AddTagList ( const char *  value)
inline

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.

Definition at line 397 of file WorkflowExecutionInfo.h.

◆ CancelRequestedHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionInfo::CancelRequestedHasBeenSet ( ) const
inline

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

Definition at line 408 of file WorkflowExecutionInfo.h.

◆ CloseStatusHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionInfo::CloseStatusHasBeenSet ( ) const
inline

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.

Definition at line 236 of file WorkflowExecutionInfo.h.

◆ CloseTimestampHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionInfo::CloseTimestampHasBeenSet ( ) const
inline

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

Definition at line 150 of file WorkflowExecutionInfo.h.

◆ ExecutionHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionInfo::ExecutionHasBeenSet ( ) const
inline

The workflow execution this information is about.

Definition at line 55 of file WorkflowExecutionInfo.h.

◆ ExecutionStatusHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionInfo::ExecutionStatusHasBeenSet ( ) const
inline

The current status of the execution.

Definition at line 185 of file WorkflowExecutionInfo.h.

◆ GetCancelRequested()

bool Aws::SWF::Model::WorkflowExecutionInfo::GetCancelRequested ( ) const
inline

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

Definition at line 403 of file WorkflowExecutionInfo.h.

◆ GetCloseStatus()

const CloseStatus& Aws::SWF::Model::WorkflowExecutionInfo::GetCloseStatus ( ) const
inline

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.

Definition at line 221 of file WorkflowExecutionInfo.h.

◆ GetCloseTimestamp()

const Aws::Utils::DateTime& Aws::SWF::Model::WorkflowExecutionInfo::GetCloseTimestamp ( ) const
inline

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

Definition at line 144 of file WorkflowExecutionInfo.h.

◆ GetExecution()

const WorkflowExecution& Aws::SWF::Model::WorkflowExecutionInfo::GetExecution ( ) const
inline

The workflow execution this information is about.

Definition at line 50 of file WorkflowExecutionInfo.h.

◆ GetExecutionStatus()

const ExecutionStatus& Aws::SWF::Model::WorkflowExecutionInfo::GetExecutionStatus ( ) const
inline

The current status of the execution.

Definition at line 180 of file WorkflowExecutionInfo.h.

◆ GetParent()

const WorkflowExecution& Aws::SWF::Model::WorkflowExecutionInfo::GetParent ( ) const
inline

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

Definition at line 303 of file WorkflowExecutionInfo.h.

◆ GetStartTimestamp()

const Aws::Utils::DateTime& Aws::SWF::Model::WorkflowExecutionInfo::GetStartTimestamp ( ) const
inline

The time when the execution was started.

Definition at line 112 of file WorkflowExecutionInfo.h.

◆ GetTagList()

const Aws::Vector<Aws::String>& Aws::SWF::Model::WorkflowExecutionInfo::GetTagList ( ) const
inline

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.

Definition at line 341 of file WorkflowExecutionInfo.h.

◆ GetWorkflowType()

const WorkflowType& Aws::SWF::Model::WorkflowExecutionInfo::GetWorkflowType ( ) const
inline

The type of the workflow execution.

Definition at line 81 of file WorkflowExecutionInfo.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SWF::Model::WorkflowExecutionInfo::Jsonize ( ) const

◆ operator=()

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ParentHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionInfo::ParentHasBeenSet ( ) const
inline

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

Definition at line 309 of file WorkflowExecutionInfo.h.

◆ SetCancelRequested()

void Aws::SWF::Model::WorkflowExecutionInfo::SetCancelRequested ( bool  value)
inline

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

Definition at line 413 of file WorkflowExecutionInfo.h.

◆ SetCloseStatus() [1/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetCloseStatus ( CloseStatus &&  value)
inline

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.

Definition at line 266 of file WorkflowExecutionInfo.h.

◆ SetCloseStatus() [2/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetCloseStatus ( const CloseStatus value)
inline

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.

Definition at line 251 of file WorkflowExecutionInfo.h.

◆ SetCloseTimestamp() [1/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetCloseTimestamp ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 162 of file WorkflowExecutionInfo.h.

◆ SetCloseTimestamp() [2/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetCloseTimestamp ( const Aws::Utils::DateTime value)
inline

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

Definition at line 156 of file WorkflowExecutionInfo.h.

◆ SetExecution() [1/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetExecution ( const WorkflowExecution value)
inline

The workflow execution this information is about.

Definition at line 60 of file WorkflowExecutionInfo.h.

◆ SetExecution() [2/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetExecution ( WorkflowExecution &&  value)
inline

The workflow execution this information is about.

Definition at line 65 of file WorkflowExecutionInfo.h.

◆ SetExecutionStatus() [1/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetExecutionStatus ( const ExecutionStatus value)
inline

The current status of the execution.

Definition at line 190 of file WorkflowExecutionInfo.h.

◆ SetExecutionStatus() [2/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetExecutionStatus ( ExecutionStatus &&  value)
inline

The current status of the execution.

Definition at line 195 of file WorkflowExecutionInfo.h.

◆ SetParent() [1/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetParent ( const WorkflowExecution value)
inline

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

Definition at line 315 of file WorkflowExecutionInfo.h.

◆ SetParent() [2/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetParent ( WorkflowExecution &&  value)
inline

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

Definition at line 321 of file WorkflowExecutionInfo.h.

◆ SetStartTimestamp() [1/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetStartTimestamp ( Aws::Utils::DateTime &&  value)
inline

The time when the execution was started.

Definition at line 127 of file WorkflowExecutionInfo.h.

◆ SetStartTimestamp() [2/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetStartTimestamp ( const Aws::Utils::DateTime value)
inline

The time when the execution was started.

Definition at line 122 of file WorkflowExecutionInfo.h.

◆ SetTagList() [1/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetTagList ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 362 of file WorkflowExecutionInfo.h.

◆ SetTagList() [2/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetTagList ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 355 of file WorkflowExecutionInfo.h.

◆ SetWorkflowType() [1/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetWorkflowType ( const WorkflowType value)
inline

The type of the workflow execution.

Definition at line 91 of file WorkflowExecutionInfo.h.

◆ SetWorkflowType() [2/2]

void Aws::SWF::Model::WorkflowExecutionInfo::SetWorkflowType ( WorkflowType &&  value)
inline

The type of the workflow execution.

Definition at line 96 of file WorkflowExecutionInfo.h.

◆ StartTimestampHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionInfo::StartTimestampHasBeenSet ( ) const
inline

The time when the execution was started.

Definition at line 117 of file WorkflowExecutionInfo.h.

◆ TagListHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionInfo::TagListHasBeenSet ( ) const
inline

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.

Definition at line 348 of file WorkflowExecutionInfo.h.

◆ WithCancelRequested()

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithCancelRequested ( bool  value)
inline

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

Definition at line 418 of file WorkflowExecutionInfo.h.

◆ WithCloseStatus() [1/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithCloseStatus ( CloseStatus &&  value)
inline

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.

Definition at line 296 of file WorkflowExecutionInfo.h.

◆ WithCloseStatus() [2/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithCloseStatus ( const CloseStatus value)
inline

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.

Definition at line 281 of file WorkflowExecutionInfo.h.

◆ WithCloseTimestamp() [1/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithCloseTimestamp ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 174 of file WorkflowExecutionInfo.h.

◆ WithCloseTimestamp() [2/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithCloseTimestamp ( const Aws::Utils::DateTime value)
inline

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

Definition at line 168 of file WorkflowExecutionInfo.h.

◆ WithExecution() [1/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithExecution ( const WorkflowExecution value)
inline

The workflow execution this information is about.

Definition at line 70 of file WorkflowExecutionInfo.h.

◆ WithExecution() [2/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithExecution ( WorkflowExecution &&  value)
inline

The workflow execution this information is about.

Definition at line 75 of file WorkflowExecutionInfo.h.

◆ WithExecutionStatus() [1/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithExecutionStatus ( const ExecutionStatus value)
inline

The current status of the execution.

Definition at line 200 of file WorkflowExecutionInfo.h.

◆ WithExecutionStatus() [2/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithExecutionStatus ( ExecutionStatus &&  value)
inline

The current status of the execution.

Definition at line 205 of file WorkflowExecutionInfo.h.

◆ WithParent() [1/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithParent ( const WorkflowExecution value)
inline

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

Definition at line 327 of file WorkflowExecutionInfo.h.

◆ WithParent() [2/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithParent ( WorkflowExecution &&  value)
inline

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

Definition at line 333 of file WorkflowExecutionInfo.h.

◆ WithStartTimestamp() [1/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithStartTimestamp ( Aws::Utils::DateTime &&  value)
inline

The time when the execution was started.

Definition at line 137 of file WorkflowExecutionInfo.h.

◆ WithStartTimestamp() [2/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithStartTimestamp ( const Aws::Utils::DateTime value)
inline

The time when the execution was started.

Definition at line 132 of file WorkflowExecutionInfo.h.

◆ WithTagList() [1/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithTagList ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 376 of file WorkflowExecutionInfo.h.

◆ WithTagList() [2/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithTagList ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 369 of file WorkflowExecutionInfo.h.

◆ WithWorkflowType() [1/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithWorkflowType ( const WorkflowType value)
inline

The type of the workflow execution.

Definition at line 101 of file WorkflowExecutionInfo.h.

◆ WithWorkflowType() [2/2]

WorkflowExecutionInfo& Aws::SWF::Model::WorkflowExecutionInfo::WithWorkflowType ( WorkflowType &&  value)
inline

The type of the workflow execution.

Definition at line 106 of file WorkflowExecutionInfo.h.

◆ WorkflowTypeHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionInfo::WorkflowTypeHasBeenSet ( ) const
inline

The type of the workflow execution.

Definition at line 86 of file WorkflowExecutionInfo.h.


The documentation for this class was generated from the following file: