Class StartChildWorkflowExecutionDecisionAttributes
- All Implemented Interfaces:
Serializable
,Cloneable
Provides details of the StartChildWorkflowExecution
decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
- Use a
Resource
element with the domain name to limit the action to only specified domains. - Use an
Action
element to allow or deny permission to call this action. - Constrain the following parameters by using a
Condition
element with the appropriate keys.-
tagList.member.N
: The key is "swf:tagList.N" where N is the tag number from 0 to 4, inclusive. taskList
: String constraint. The key isswf:taskList.name
.workflowType.name
: String constraint. The key isswf:workflowType.name
.workflowType.version
: String constraint. The key isswf:workflowType.version
.
-
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.The total duration for this workflow execution.getInput()
The input to be provided to the workflow execution.The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.The list of tags to associate with the child workflow execution.The name of the task list to be used for decision tasks of the child workflow execution.Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution.Specifies the maximum duration of decision tasks for this workflow execution.Required. TheworkflowId
of the workflow execution.Required. The type of the workflow execution to be started.int
hashCode()
void
setChildPolicy
(ChildPolicy childPolicy) Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.void
setChildPolicy
(String childPolicy) Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.void
setControl
(String control) Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.void
setExecutionStartToCloseTimeout
(String executionStartToCloseTimeout) The total duration for this workflow execution.void
The input to be provided to the workflow execution.void
setLambdaRole
(String lambdaRole) The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.void
setTagList
(Collection<String> tagList) The list of tags to associate with the child workflow execution.void
setTaskList
(TaskList taskList) The name of the task list to be used for decision tasks of the child workflow execution.void
setTaskPriority
(String taskPriority) Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution.void
setTaskStartToCloseTimeout
(String taskStartToCloseTimeout) Specifies the maximum duration of decision tasks for this workflow execution.void
setWorkflowId
(String workflowId) Required. TheworkflowId
of the workflow execution.void
setWorkflowType
(WorkflowType workflowType) Required. The type of the workflow execution to be started.toString()
Returns a string representation of this object; useful for testing and debugging.withChildPolicy
(ChildPolicy childPolicy) Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.withChildPolicy
(String childPolicy) Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.withControl
(String control) Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.withExecutionStartToCloseTimeout
(String executionStartToCloseTimeout) The total duration for this workflow execution.The input to be provided to the workflow execution.withLambdaRole
(String lambdaRole) The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.withTagList
(String... tagList) The list of tags to associate with the child workflow execution.withTagList
(Collection<String> tagList) The list of tags to associate with the child workflow execution.withTaskList
(TaskList taskList) The name of the task list to be used for decision tasks of the child workflow execution.withTaskPriority
(String taskPriority) Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution.withTaskStartToCloseTimeout
(String taskStartToCloseTimeout) Specifies the maximum duration of decision tasks for this workflow execution.withWorkflowId
(String workflowId) Required. TheworkflowId
of the workflow execution.withWorkflowType
(WorkflowType workflowType) Required. The type of the workflow execution to be started.
-
Constructor Details
-
StartChildWorkflowExecutionDecisionAttributes
public StartChildWorkflowExecutionDecisionAttributes()
-
-
Method Details
-
setWorkflowType
Required. The type of the workflow execution to be started.
- Parameters:
workflowType
- Required.
-
getWorkflowType
Required. The type of the workflow execution to be started.
- Returns:
- Required.
-
withWorkflowType
Required. The type of the workflow execution to be started.
- Parameters:
workflowType
- Required.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setWorkflowId
Required. The
workflowId
of the workflow execution.The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Parameters:
workflowId
- Required. TheworkflowId
of the workflow execution.The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
-
getWorkflowId
Required. The
workflowId
of the workflow execution.The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Returns:
- Required. The
workflowId
of the workflow execution.The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
-
withWorkflowId
Required. The
workflowId
of the workflow execution.The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Parameters:
workflowId
- Required. TheworkflowId
of the workflow execution.The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setControl
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.
- Parameters:
control
- Optional.
-
getControl
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.
- Returns:
- Optional.
-
withControl
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.
- Parameters:
control
- Optional.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInput
The input to be provided to the workflow execution.
- Parameters:
input
- The input to be provided to the workflow execution.
-
getInput
The input to be provided to the workflow execution.
- Returns:
- The input to be provided to the workflow execution.
-
withInput
The input to be provided to the workflow execution.
- Parameters:
input
- The input to be provided to the workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setExecutionStartToCloseTimeout
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned. - Parameters:
executionStartToCloseTimeout
- The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.
-
getExecutionStartToCloseTimeout
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned. - Returns:
- The total duration for this workflow execution. This overrides
the defaultExecutionStartToCloseTimeout specified when
registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.
-
withExecutionStartToCloseTimeout
public StartChildWorkflowExecutionDecisionAttributes withExecutionStartToCloseTimeout(String executionStartToCloseTimeout) The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned. - Parameters:
executionStartToCloseTimeout
- The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned. - Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTaskList
The name of the task list to be used for decision tasks of the child workflow execution.
A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Parameters:
taskList
- The name of the task list to be used for decision tasks of the child workflow execution.A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.
-
getTaskList
The name of the task list to be used for decision tasks of the child workflow execution.
A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Returns:
- The name of the task list to be used for decision tasks of the
child workflow execution.
A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.
-
withTaskList
The name of the task list to be used for decision tasks of the child workflow execution.
A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Parameters:
taskList
- The name of the task list to be used for decision tasks of the child workflow execution.A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTaskPriority
Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
- Parameters:
taskPriority
- Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java'sInteger.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide
-
getTaskPriority
Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
- Returns:
- Optional. A task priority that, if set, specifies the
priority for a decision task of this workflow execution. This
overrides the defaultTaskPriority specified when registering the
workflow type. Valid values are integers that range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide
-
withTaskPriority
Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
- Parameters:
taskPriority
- Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java'sInteger.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTaskStartToCloseTimeout
Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the
defaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned. - Parameters:
taskStartToCloseTimeout
- Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides thedefaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
-
getTaskStartToCloseTimeout
Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the
defaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned. - Returns:
- Specifies the maximum duration of decision tasks for this
workflow execution. This parameter overrides the
defaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
-
withTaskStartToCloseTimeout
public StartChildWorkflowExecutionDecisionAttributes withTaskStartToCloseTimeout(String taskStartToCloseTimeout) Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the
defaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned. - Parameters:
taskStartToCloseTimeout
- Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides thedefaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned. - Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setChildPolicy
Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Parameters:
childPolicy
- Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.
- See Also:
-
getChildPolicy
Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Returns:
- Optional. If set, specifies the policy to use for the child
workflow executions if the workflow execution being started is
terminated by calling the TerminateWorkflowExecution
action explicitly or due to an expired timeout. This policy
overrides the default child policy specified when registering the
workflow type using RegisterWorkflowType.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.
- See Also:
-
withChildPolicy
Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Parameters:
childPolicy
- Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setChildPolicy
Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Parameters:
childPolicy
- Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.
- See Also:
-
withChildPolicy
Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Parameters:
childPolicy
- Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
getTagList
The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
- Returns:
- The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
-
setTagList
The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
- Parameters:
tagList
- The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
-
withTagList
The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
NOTE: This method appends the values to the existing list (if any). Use
setTagList(java.util.Collection)
orwithTagList(java.util.Collection)
if you want to override the existing values.- Parameters:
tagList
- The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTagList
The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
- Parameters:
tagList
- The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLambdaRole
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field. - Parameters:
lambdaRole
- The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.
-
getLambdaRole
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field. - Returns:
- The ARN of an IAM role that authorizes Amazon SWF to invoke AWS
Lambda functions.
In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.
-
withLambdaRole
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field. - Parameters:
lambdaRole
- The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field. - Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-