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

#include <WorkflowExecutionConfiguration.h>

Public Member Functions

 WorkflowExecutionConfiguration ()
 
 WorkflowExecutionConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
WorkflowExecutionConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetTaskStartToCloseTimeout () const
 
bool TaskStartToCloseTimeoutHasBeenSet () const
 
void SetTaskStartToCloseTimeout (const Aws::String &value)
 
void SetTaskStartToCloseTimeout (Aws::String &&value)
 
void SetTaskStartToCloseTimeout (const char *value)
 
WorkflowExecutionConfigurationWithTaskStartToCloseTimeout (const Aws::String &value)
 
WorkflowExecutionConfigurationWithTaskStartToCloseTimeout (Aws::String &&value)
 
WorkflowExecutionConfigurationWithTaskStartToCloseTimeout (const char *value)
 
const Aws::StringGetExecutionStartToCloseTimeout () const
 
bool ExecutionStartToCloseTimeoutHasBeenSet () const
 
void SetExecutionStartToCloseTimeout (const Aws::String &value)
 
void SetExecutionStartToCloseTimeout (Aws::String &&value)
 
void SetExecutionStartToCloseTimeout (const char *value)
 
WorkflowExecutionConfigurationWithExecutionStartToCloseTimeout (const Aws::String &value)
 
WorkflowExecutionConfigurationWithExecutionStartToCloseTimeout (Aws::String &&value)
 
WorkflowExecutionConfigurationWithExecutionStartToCloseTimeout (const char *value)
 
const TaskListGetTaskList () const
 
bool TaskListHasBeenSet () const
 
void SetTaskList (const TaskList &value)
 
void SetTaskList (TaskList &&value)
 
WorkflowExecutionConfigurationWithTaskList (const TaskList &value)
 
WorkflowExecutionConfigurationWithTaskList (TaskList &&value)
 
const Aws::StringGetTaskPriority () const
 
bool TaskPriorityHasBeenSet () const
 
void SetTaskPriority (const Aws::String &value)
 
void SetTaskPriority (Aws::String &&value)
 
void SetTaskPriority (const char *value)
 
WorkflowExecutionConfigurationWithTaskPriority (const Aws::String &value)
 
WorkflowExecutionConfigurationWithTaskPriority (Aws::String &&value)
 
WorkflowExecutionConfigurationWithTaskPriority (const char *value)
 
const ChildPolicyGetChildPolicy () const
 
bool ChildPolicyHasBeenSet () const
 
void SetChildPolicy (const ChildPolicy &value)
 
void SetChildPolicy (ChildPolicy &&value)
 
WorkflowExecutionConfigurationWithChildPolicy (const ChildPolicy &value)
 
WorkflowExecutionConfigurationWithChildPolicy (ChildPolicy &&value)
 
const Aws::StringGetLambdaRole () const
 
bool LambdaRoleHasBeenSet () const
 
void SetLambdaRole (const Aws::String &value)
 
void SetLambdaRole (Aws::String &&value)
 
void SetLambdaRole (const char *value)
 
WorkflowExecutionConfigurationWithLambdaRole (const Aws::String &value)
 
WorkflowExecutionConfigurationWithLambdaRole (Aws::String &&value)
 
WorkflowExecutionConfigurationWithLambdaRole (const char *value)
 

Detailed Description

The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.

See Also:

AWS API Reference

Definition at line 36 of file WorkflowExecutionConfiguration.h.

Constructor & Destructor Documentation

◆ WorkflowExecutionConfiguration() [1/2]

Aws::SWF::Model::WorkflowExecutionConfiguration::WorkflowExecutionConfiguration ( )

◆ WorkflowExecutionConfiguration() [2/2]

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

Member Function Documentation

◆ ChildPolicyHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionConfiguration::ChildPolicyHasBeenSet ( ) const
inline

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

Definition at line 319 of file WorkflowExecutionConfiguration.h.

◆ ExecutionStartToCloseTimeoutHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionConfiguration::ExecutionStartToCloseTimeoutHasBeenSet ( ) const
inline

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 122 of file WorkflowExecutionConfiguration.h.

◆ GetChildPolicy()

const ChildPolicy& Aws::SWF::Model::WorkflowExecutionConfiguration::GetChildPolicy ( ) const
inline

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

Definition at line 305 of file WorkflowExecutionConfiguration.h.

◆ GetExecutionStartToCloseTimeout()

const Aws::String& Aws::SWF::Model::WorkflowExecutionConfiguration::GetExecutionStartToCloseTimeout ( ) const
inline

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 115 of file WorkflowExecutionConfiguration.h.

◆ GetLambdaRole()

const Aws::String& Aws::SWF::Model::WorkflowExecutionConfiguration::GetLambdaRole ( ) const
inline

The IAM role attached to the child workflow execution.

Definition at line 381 of file WorkflowExecutionConfiguration.h.

◆ GetTaskList()

const TaskList& Aws::SWF::Model::WorkflowExecutionConfiguration::GetTaskList ( ) const
inline

The task list used for the decision tasks generated for this workflow execution.

Definition at line 171 of file WorkflowExecutionConfiguration.h.

◆ GetTaskPriority()

const Aws::String& Aws::SWF::Model::WorkflowExecutionConfiguration::GetTaskPriority ( ) const
inline

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 213 of file WorkflowExecutionConfiguration.h.

◆ GetTaskStartToCloseTimeout()

const Aws::String& Aws::SWF::Model::WorkflowExecutionConfiguration::GetTaskStartToCloseTimeout ( ) const
inline

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 51 of file WorkflowExecutionConfiguration.h.

◆ Jsonize()

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

◆ LambdaRoleHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionConfiguration::LambdaRoleHasBeenSet ( ) const
inline

The IAM role attached to the child workflow execution.

Definition at line 386 of file WorkflowExecutionConfiguration.h.

◆ operator=()

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

◆ SetChildPolicy() [1/2]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetChildPolicy ( ChildPolicy &&  value)
inline

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

Definition at line 347 of file WorkflowExecutionConfiguration.h.

◆ SetChildPolicy() [2/2]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetChildPolicy ( const ChildPolicy value)
inline

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

Definition at line 333 of file WorkflowExecutionConfiguration.h.

◆ SetExecutionStartToCloseTimeout() [1/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetExecutionStartToCloseTimeout ( Aws::String &&  value)
inline

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 136 of file WorkflowExecutionConfiguration.h.

◆ SetExecutionStartToCloseTimeout() [2/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetExecutionStartToCloseTimeout ( const Aws::String value)
inline

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 129 of file WorkflowExecutionConfiguration.h.

◆ SetExecutionStartToCloseTimeout() [3/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetExecutionStartToCloseTimeout ( const char *  value)
inline

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 143 of file WorkflowExecutionConfiguration.h.

◆ SetLambdaRole() [1/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetLambdaRole ( Aws::String &&  value)
inline

The IAM role attached to the child workflow execution.

Definition at line 396 of file WorkflowExecutionConfiguration.h.

◆ SetLambdaRole() [2/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetLambdaRole ( const Aws::String value)
inline

The IAM role attached to the child workflow execution.

Definition at line 391 of file WorkflowExecutionConfiguration.h.

◆ SetLambdaRole() [3/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetLambdaRole ( const char *  value)
inline

The IAM role attached to the child workflow execution.

Definition at line 401 of file WorkflowExecutionConfiguration.h.

◆ SetTaskList() [1/2]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetTaskList ( const TaskList value)
inline

The task list used for the decision tasks generated for this workflow execution.

Definition at line 183 of file WorkflowExecutionConfiguration.h.

◆ SetTaskList() [2/2]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetTaskList ( TaskList &&  value)
inline

The task list used for the decision tasks generated for this workflow execution.

Definition at line 189 of file WorkflowExecutionConfiguration.h.

◆ SetTaskPriority() [1/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetTaskPriority ( Aws::String &&  value)
inline

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 246 of file WorkflowExecutionConfiguration.h.

◆ SetTaskPriority() [2/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetTaskPriority ( const Aws::String value)
inline

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 235 of file WorkflowExecutionConfiguration.h.

◆ SetTaskPriority() [3/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetTaskPriority ( const char *  value)
inline

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 257 of file WorkflowExecutionConfiguration.h.

◆ SetTaskStartToCloseTimeout() [1/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetTaskStartToCloseTimeout ( Aws::String &&  value)
inline

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 75 of file WorkflowExecutionConfiguration.h.

◆ SetTaskStartToCloseTimeout() [2/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetTaskStartToCloseTimeout ( const Aws::String value)
inline

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 67 of file WorkflowExecutionConfiguration.h.

◆ SetTaskStartToCloseTimeout() [3/3]

void Aws::SWF::Model::WorkflowExecutionConfiguration::SetTaskStartToCloseTimeout ( const char *  value)
inline

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 83 of file WorkflowExecutionConfiguration.h.

◆ TaskListHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionConfiguration::TaskListHasBeenSet ( ) const
inline

The task list used for the decision tasks generated for this workflow execution.

Definition at line 177 of file WorkflowExecutionConfiguration.h.

◆ TaskPriorityHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionConfiguration::TaskPriorityHasBeenSet ( ) const
inline

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 224 of file WorkflowExecutionConfiguration.h.

◆ TaskStartToCloseTimeoutHasBeenSet()

bool Aws::SWF::Model::WorkflowExecutionConfiguration::TaskStartToCloseTimeoutHasBeenSet ( ) const
inline

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 59 of file WorkflowExecutionConfiguration.h.

◆ WithChildPolicy() [1/2]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithChildPolicy ( ChildPolicy &&  value)
inline

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

Definition at line 375 of file WorkflowExecutionConfiguration.h.

◆ WithChildPolicy() [2/2]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithChildPolicy ( const ChildPolicy value)
inline

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

Definition at line 361 of file WorkflowExecutionConfiguration.h.

◆ WithExecutionStartToCloseTimeout() [1/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithExecutionStartToCloseTimeout ( Aws::String &&  value)
inline

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 157 of file WorkflowExecutionConfiguration.h.

◆ WithExecutionStartToCloseTimeout() [2/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithExecutionStartToCloseTimeout ( const Aws::String value)
inline

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 150 of file WorkflowExecutionConfiguration.h.

◆ WithExecutionStartToCloseTimeout() [3/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithExecutionStartToCloseTimeout ( const char *  value)
inline

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 164 of file WorkflowExecutionConfiguration.h.

◆ WithLambdaRole() [1/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithLambdaRole ( Aws::String &&  value)
inline

The IAM role attached to the child workflow execution.

Definition at line 411 of file WorkflowExecutionConfiguration.h.

◆ WithLambdaRole() [2/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithLambdaRole ( const Aws::String value)
inline

The IAM role attached to the child workflow execution.

Definition at line 406 of file WorkflowExecutionConfiguration.h.

◆ WithLambdaRole() [3/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithLambdaRole ( const char *  value)
inline

The IAM role attached to the child workflow execution.

Definition at line 416 of file WorkflowExecutionConfiguration.h.

◆ WithTaskList() [1/2]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithTaskList ( const TaskList value)
inline

The task list used for the decision tasks generated for this workflow execution.

Definition at line 195 of file WorkflowExecutionConfiguration.h.

◆ WithTaskList() [2/2]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithTaskList ( TaskList &&  value)
inline

The task list used for the decision tasks generated for this workflow execution.

Definition at line 201 of file WorkflowExecutionConfiguration.h.

◆ WithTaskPriority() [1/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithTaskPriority ( Aws::String &&  value)
inline

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 279 of file WorkflowExecutionConfiguration.h.

◆ WithTaskPriority() [2/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithTaskPriority ( const Aws::String value)
inline

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 268 of file WorkflowExecutionConfiguration.h.

◆ WithTaskPriority() [3/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithTaskPriority ( const char *  value)
inline

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Definition at line 290 of file WorkflowExecutionConfiguration.h.

◆ WithTaskStartToCloseTimeout() [1/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithTaskStartToCloseTimeout ( Aws::String &&  value)
inline

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 99 of file WorkflowExecutionConfiguration.h.

◆ WithTaskStartToCloseTimeout() [2/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithTaskStartToCloseTimeout ( const Aws::String value)
inline

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 91 of file WorkflowExecutionConfiguration.h.

◆ WithTaskStartToCloseTimeout() [3/3]

WorkflowExecutionConfiguration& Aws::SWF::Model::WorkflowExecutionConfiguration::WithTaskStartToCloseTimeout ( const char *  value)
inline

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Definition at line 107 of file WorkflowExecutionConfiguration.h.


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