Class WorkflowExecutionConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.swf.model.WorkflowExecutionConfiguration
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class WorkflowExecutionConfiguration extends Object implements SdkPojo, Serializable, 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.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
WorkflowExecutionConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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)
boolean
equalsBySdkFields(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.List<SdkField<?>>
sdkFields()
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()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
taskStartToCloseTimeout
public final 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 useNONE
to specify unlimited duration.- Returns:
- 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 useNONE
to specify unlimited duration.
-
executionStartToCloseTimeout
public final 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 useNONE
to specify unlimited duration.- Returns:
- The total duration for this workflow execution.
The duration is specified in seconds, an integer greater than or equal to
0
. You can useNONE
to specify unlimited duration.
-
taskList
public final TaskList taskList()
The task list used for the decision tasks generated for this workflow execution.
- Returns:
- The task list used for the decision tasks generated for this workflow execution.
-
taskPriority
public final 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) toInteger.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.
- Returns:
- The priority assigned to decision tasks for this workflow execution. 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 SWF Developer Guide.
-
childPolicy
public final 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 aWorkflowExecutionCancelRequested
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 returnChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchildPolicyAsString()
.- Returns:
- 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 aWorkflowExecutionCancelRequested
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.
-
- See Also:
ChildPolicy
-
-
childPolicyAsString
public final 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 aWorkflowExecutionCancelRequested
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 returnChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchildPolicyAsString()
.- Returns:
- 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 aWorkflowExecutionCancelRequested
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.
-
- See Also:
ChildPolicy
-
-
lambdaRole
public final String lambdaRole()
The IAM role attached to the child workflow execution.
- Returns:
- The IAM role attached to the child workflow execution.
-
toBuilder
public WorkflowExecutionConfiguration.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>
-
builder
public static WorkflowExecutionConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends WorkflowExecutionConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-