Interface WorkflowExecutionConfiguration.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>
,SdkBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>
,SdkPojo
- Enclosing class:
- WorkflowExecutionConfiguration
public static interface WorkflowExecutionConfiguration.Builder extends SdkPojo, CopyableBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description WorkflowExecutionConfiguration.Builder
childPolicy(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.Builder
childPolicy(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.Builder
executionStartToCloseTimeout(String executionStartToCloseTimeout)
The total duration for this workflow execution.WorkflowExecutionConfiguration.Builder
lambdaRole(String lambdaRole)
The IAM role attached to the child workflow execution.default WorkflowExecutionConfiguration.Builder
taskList(Consumer<TaskList.Builder> taskList)
The task list used for the decision tasks generated for this workflow execution.WorkflowExecutionConfiguration.Builder
taskList(TaskList taskList)
The task list used for the decision tasks generated for this workflow execution.WorkflowExecutionConfiguration.Builder
taskPriority(String taskPriority)
The priority assigned to decision tasks for this workflow execution.WorkflowExecutionConfiguration.Builder
taskStartToCloseTimeout(String taskStartToCloseTimeout)
The maximum duration allowed for decision tasks for this workflow execution.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
taskStartToCloseTimeout
WorkflowExecutionConfiguration.Builder taskStartToCloseTimeout(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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
executionStartToCloseTimeout
WorkflowExecutionConfiguration.Builder executionStartToCloseTimeout(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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
taskList
WorkflowExecutionConfiguration.Builder taskList(TaskList taskList)
The task list used for the decision tasks generated for this workflow execution.
- Parameters:
taskList
- The task list used for the decision tasks generated for this workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskList
default WorkflowExecutionConfiguration.Builder taskList(Consumer<TaskList.Builder> taskList)
The task list used for the decision tasks generated for this workflow execution.
This is a convenience method that creates an instance of theTaskList.Builder
avoiding the need to create one manually viaTaskList.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totaskList(TaskList)
.- Parameters:
taskList
- a consumer that will call methods onTaskList.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
taskList(TaskList)
-
taskPriority
WorkflowExecutionConfiguration.Builder taskPriority(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.
- Parameters:
taskPriority
- The priority assigned to decision tasks for this workflow execution. 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 SWF Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
childPolicy
WorkflowExecutionConfiguration.Builder childPolicy(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 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChildPolicy
,ChildPolicy
-
-
childPolicy
WorkflowExecutionConfiguration.Builder childPolicy(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChildPolicy
,ChildPolicy
-
-
lambdaRole
WorkflowExecutionConfiguration.Builder lambdaRole(String lambdaRole)
The IAM role attached to the child workflow execution.
- Parameters:
lambdaRole
- The IAM role attached to the child workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-