@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class WorkflowExecutionConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
WorkflowExecutionConfiguration() |
Modifier and Type | Method and Description |
---|---|
WorkflowExecutionConfiguration |
clone() |
boolean |
equals(Object obj) |
String |
getChildPolicy()
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.
|
String |
getExecutionStartToCloseTimeout()
The total duration for this workflow execution.
|
String |
getLambdaRole()
The IAM role attached to the child workflow execution.
|
TaskList |
getTaskList()
The task list used for the decision tasks generated for this workflow execution.
|
String |
getTaskPriority()
The priority assigned to decision tasks for this workflow execution.
|
String |
getTaskStartToCloseTimeout()
The maximum duration allowed for decision tasks for this workflow execution.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setChildPolicy(ChildPolicy childPolicy)
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.
|
void |
setChildPolicy(String childPolicy)
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.
|
void |
setExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The total duration for this workflow execution.
|
void |
setLambdaRole(String lambdaRole)
The IAM role attached to the child workflow execution.
|
void |
setTaskList(TaskList taskList)
The task list used for the decision tasks generated for this workflow execution.
|
void |
setTaskPriority(String taskPriority)
The priority assigned to decision tasks for this workflow execution.
|
void |
setTaskStartToCloseTimeout(String taskStartToCloseTimeout)
The maximum duration allowed for decision tasks for this workflow execution.
|
String |
toString()
Returns a string representation of this object.
|
WorkflowExecutionConfiguration |
withChildPolicy(ChildPolicy childPolicy)
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.
|
WorkflowExecutionConfiguration |
withChildPolicy(String childPolicy)
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.
|
WorkflowExecutionConfiguration |
withExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The total duration for this workflow execution.
|
WorkflowExecutionConfiguration |
withLambdaRole(String lambdaRole)
The IAM role attached to the child workflow execution.
|
WorkflowExecutionConfiguration |
withTaskList(TaskList taskList)
The task list used for the decision tasks generated for this workflow execution.
|
WorkflowExecutionConfiguration |
withTaskPriority(String taskPriority)
The priority assigned to decision tasks for this workflow execution.
|
WorkflowExecutionConfiguration |
withTaskStartToCloseTimeout(String taskStartToCloseTimeout)
The maximum duration allowed for decision tasks for this workflow execution.
|
public void setTaskStartToCloseTimeout(String taskStartToCloseTimeout)
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.
taskStartToCloseTimeout
- 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.
public String getTaskStartToCloseTimeout()
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.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use
NONE
to specify unlimited duration.
public WorkflowExecutionConfiguration withTaskStartToCloseTimeout(String taskStartToCloseTimeout)
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.
taskStartToCloseTimeout
- 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.
public void setExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
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.
executionStartToCloseTimeout
- 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.
public String getExecutionStartToCloseTimeout()
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.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use
NONE
to specify unlimited duration.
public WorkflowExecutionConfiguration withExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
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.
executionStartToCloseTimeout
- 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.
public void setTaskList(TaskList taskList)
The task list used for the decision tasks generated for this workflow execution.
taskList
- The task list used for the decision tasks generated for this workflow execution.public TaskList getTaskList()
The task list used for the decision tasks generated for this workflow execution.
public WorkflowExecutionConfiguration withTaskList(TaskList taskList)
The task list used for the decision tasks generated for this workflow execution.
taskList
- The task list used for the decision tasks generated for this workflow execution.public void setTaskPriority(String taskPriority)
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.
taskPriority
- 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.
public String getTaskPriority()
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.
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.
public WorkflowExecutionConfiguration withTaskPriority(String taskPriority)
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.
taskPriority
- 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.
public void setChildPolicy(String childPolicy)
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.
childPolicy
- 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.
ChildPolicy
public String getChildPolicy()
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.
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.
ChildPolicy
public WorkflowExecutionConfiguration withChildPolicy(String childPolicy)
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.
childPolicy
- 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.
ChildPolicy
public void setChildPolicy(ChildPolicy childPolicy)
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.
childPolicy
- 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.
ChildPolicy
public WorkflowExecutionConfiguration withChildPolicy(ChildPolicy childPolicy)
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.
childPolicy
- 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.
ChildPolicy
public void setLambdaRole(String lambdaRole)
The IAM role attached to the child workflow execution.
lambdaRole
- The IAM role attached to the child workflow execution.public String getLambdaRole()
The IAM role attached to the child workflow execution.
public WorkflowExecutionConfiguration withLambdaRole(String lambdaRole)
The IAM role attached to the child workflow execution.
lambdaRole
- The IAM role attached to the child workflow execution.public String toString()
toString
in class Object
Object.toString()
public WorkflowExecutionConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.