public class StartChildWorkflowExecutionDecisionAttributes extends Object implements Serializable
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:
Resource
element with the domain name to limit
the action to only specified domains.Action
element to allow or deny permission to
call this action.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 is
swf:taskList.name
.workflowType.name
: String constraint. The key is
swf:workflowType.name
.workflowType.version
: String constraint. The key
is swf: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 .
Constructor and Description |
---|
StartChildWorkflowExecutionDecisionAttributes() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
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.
|
String |
getControl()
Optional. Data attached to the event that can be used by the
decider in subsequent workflow tasks.
|
String |
getExecutionStartToCloseTimeout()
The total duration for this workflow execution.
|
String |
getInput()
The input to be provided to the workflow execution.
|
List<String> |
getTagList()
The list of tags to associate with the child workflow execution.
|
TaskList |
getTaskList()
The name of the task list to be used for decision tasks of the child
workflow execution.
|
String |
getTaskPriority()
Optional. A task priority that, if set, specifies the priority
for a decision task of this workflow execution.
|
String |
getTaskStartToCloseTimeout()
Specifies the maximum duration of decision tasks for this workflow
execution.
|
String |
getWorkflowId()
Required. The
workflowId of the workflow
execution. |
WorkflowType |
getWorkflowType()
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 |
setInput(String input)
The input to be provided to the workflow execution.
|
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. The
workflowId of the workflow
execution. |
void |
setWorkflowType(WorkflowType workflowType)
Required. The type of the workflow execution to be started.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
StartChildWorkflowExecutionDecisionAttributes |
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.
|
StartChildWorkflowExecutionDecisionAttributes |
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.
|
StartChildWorkflowExecutionDecisionAttributes |
withControl(String control)
Optional. Data attached to the event that can be used by the
decider in subsequent workflow tasks.
|
StartChildWorkflowExecutionDecisionAttributes |
withExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The total duration for this workflow execution.
|
StartChildWorkflowExecutionDecisionAttributes |
withInput(String input)
The input to be provided to the workflow execution.
|
StartChildWorkflowExecutionDecisionAttributes |
withTagList(Collection<String> tagList)
The list of tags to associate with the child workflow execution.
|
StartChildWorkflowExecutionDecisionAttributes |
withTagList(String... tagList)
The list of tags to associate with the child workflow execution.
|
StartChildWorkflowExecutionDecisionAttributes |
withTaskList(TaskList taskList)
The name of the task list to be used for decision tasks of the child
workflow execution.
|
StartChildWorkflowExecutionDecisionAttributes |
withTaskPriority(String taskPriority)
Optional. A task priority that, if set, specifies the priority
for a decision task of this workflow execution.
|
StartChildWorkflowExecutionDecisionAttributes |
withTaskStartToCloseTimeout(String taskStartToCloseTimeout)
Specifies the maximum duration of decision tasks for this workflow
execution.
|
StartChildWorkflowExecutionDecisionAttributes |
withWorkflowId(String workflowId)
Required. The
workflowId of the workflow
execution. |
StartChildWorkflowExecutionDecisionAttributes |
withWorkflowType(WorkflowType workflowType)
Required. The type of the workflow execution to be started.
|
public StartChildWorkflowExecutionDecisionAttributes()
public WorkflowType getWorkflowType()
public void setWorkflowType(WorkflowType workflowType)
workflowType
- Required. The type of the workflow execution to be started.public StartChildWorkflowExecutionDecisionAttributes withWorkflowType(WorkflowType workflowType)
Returns a reference to this object so that method calls can be chained together.
workflowType
- Required. The type of the workflow execution to be started.public String getWorkflowId()
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 "arn".
Constraints:
Length: 1 - 256
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 "arn".
public void setWorkflowId(String workflowId)
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 "arn".
Constraints:
Length: 1 - 256
workflowId
- 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 "arn".
public StartChildWorkflowExecutionDecisionAttributes withWorkflowId(String workflowId)
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 "arn".
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
workflowId
- 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 "arn".
public String getControl()
Constraints:
Length: 0 - 32768
public void setControl(String control)
Constraints:
Length: 0 - 32768
control
- 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.public StartChildWorkflowExecutionDecisionAttributes withControl(String control)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 32768
control
- 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.public String getInput()
Constraints:
Length: 0 - 32768
public void setInput(String input)
Constraints:
Length: 0 - 32768
input
- The input to be provided to the workflow execution.public StartChildWorkflowExecutionDecisionAttributes withInput(String input)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 32768
input
- The input to be provided to the workflow execution.public String getExecutionStartToCloseTimeout()
The duration is specified in seconds; an integer
greater than or equal to 0. The value "NONE" can be used to specify
unlimited duration.
Constraints:
Length: 0 - 8
The duration is specified in seconds; an integer
greater than or equal to 0. The value "NONE" can be used to specify
unlimited duration.
public void setExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The duration is specified in seconds; an integer
greater than or equal to 0. The value "NONE" can be used to specify
unlimited duration.
Constraints:
Length: 0 - 8
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.
public StartChildWorkflowExecutionDecisionAttributes withExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The duration is specified in seconds; an integer
greater than or equal to 0. The value "NONE" can be used to specify
unlimited duration.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 8
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.
public TaskList getTaskList()
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 "arn".
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 "arn".
public void setTaskList(TaskList taskList)
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 "arn".
taskList
- The name of the task list to be used for decision tasks of the child
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 "arn".
public StartChildWorkflowExecutionDecisionAttributes withTaskList(TaskList taskList)
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 "arn".
Returns a reference to this object so that method calls can be chained together.
taskList
- The name of the task list to be used for decision tasks of the child
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 "arn".
public String getTaskPriority()
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 Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
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 Simple Workflow Developer Guide.
public void setTaskPriority(String taskPriority)
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 Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
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'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 Simple Workflow Developer Guide.
public StartChildWorkflowExecutionDecisionAttributes withTaskPriority(String taskPriority)
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 Simple Workflow Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 11
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'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 Simple Workflow Developer Guide.
public String getTaskStartToCloseTimeout()
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.
Constraints:
Length: 0 - 8
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.
public void setTaskStartToCloseTimeout(String taskStartToCloseTimeout)
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.
Constraints:
Length: 0 - 8
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.
public StartChildWorkflowExecutionDecisionAttributes withTaskStartToCloseTimeout(String taskStartToCloseTimeout)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 8
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.
public String getChildPolicy()
The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.ChildPolicy
public void setChildPolicy(String childPolicy)
The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
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:
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.ChildPolicy
public StartChildWorkflowExecutionDecisionAttributes withChildPolicy(String childPolicy)
The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
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:
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.ChildPolicy
public void setChildPolicy(ChildPolicy childPolicy)
The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
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:
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.ChildPolicy
public StartChildWorkflowExecutionDecisionAttributes withChildPolicy(ChildPolicy childPolicy)
The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
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:
WorkflowExecutionCancelRequested
event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.ChildPolicy
public List<String> getTagList()
Constraints:
Length: 0 - 5
public void setTagList(Collection<String> tagList)
Constraints:
Length: 0 - 5
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.public StartChildWorkflowExecutionDecisionAttributes withTagList(String... tagList)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 5
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.public StartChildWorkflowExecutionDecisionAttributes withTagList(Collection<String> tagList)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 5
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.public String toString()
toString
in class Object
Object.toString()
Copyright © 2015. All rights reserved.