@Generated(value="software.amazon.awssdk:codegen") public final class WorkflowExecutionConfiguration extends Object implements StructuredPojo, ToCopyableBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
WorkflowExecutionConfiguration.Builder |
Modifier and Type | Method and Description |
---|---|
static WorkflowExecutionConfiguration.Builder |
builder() |
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.
|
String |
childPolicyAsString()
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.
|
boolean |
equals(Object obj) |
String |
executionStartToCloseTimeout()
The total duration for this workflow execution.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
lambdaRole()
The IAM role attached to the child workflow execution.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
static Class<? extends WorkflowExecutionConfiguration.Builder> |
serializableBuilderClass() |
TaskList |
taskList()
The task list used for the decision tasks generated for this workflow execution.
|
String |
taskPriority()
The priority assigned to decision tasks for this workflow execution.
|
String |
taskStartToCloseTimeout()
The maximum duration allowed for decision tasks for this workflow execution.
|
WorkflowExecutionConfiguration.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public 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.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use
NONE
to specify unlimited duration.
public 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.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use
NONE
to specify unlimited duration.
public TaskList taskList()
The task list used for the decision tasks generated for this workflow execution.
public 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.
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 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.
If the service returns an enum value that is not available in the current SDK version, childPolicy
will
return ChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
childPolicyAsString()
.
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 childPolicyAsString()
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.
If the service returns an enum value that is not available in the current SDK version, childPolicy
will
return ChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
childPolicyAsString()
.
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 lambdaRole()
The IAM role attached to the child workflow execution.
public WorkflowExecutionConfiguration.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>
public static WorkflowExecutionConfiguration.Builder builder()
public static Class<? extends WorkflowExecutionConfiguration.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.