Interface WorkflowTypeConfiguration.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>,SdkBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>,SdkPojo
- Enclosing class:
- WorkflowTypeConfiguration
public static interface WorkflowTypeConfiguration.Builder extends SdkPojo, CopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description WorkflowTypeConfiguration.BuilderdefaultChildPolicy(String defaultChildPolicy)The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.WorkflowTypeConfiguration.BuilderdefaultChildPolicy(ChildPolicy defaultChildPolicy)The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.WorkflowTypeConfiguration.BuilderdefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)The default maximum duration, specified when registering the workflow type, for executions of this workflow type.WorkflowTypeConfiguration.BuilderdefaultLambdaRole(String defaultLambdaRole)The default IAM role attached to this workflow type.default WorkflowTypeConfiguration.BuilderdefaultTaskList(Consumer<TaskList.Builder> defaultTaskList)The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.WorkflowTypeConfiguration.BuilderdefaultTaskList(TaskList defaultTaskList)The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.WorkflowTypeConfiguration.BuilderdefaultTaskPriority(String defaultTaskPriority)The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type.WorkflowTypeConfiguration.BuilderdefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure.-
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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
defaultTaskStartToCloseTimeout
WorkflowTypeConfiguration.Builder defaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecutionDecision.The duration is specified in seconds, an integer greater than or equal to
0. You can useNONEto specify unlimited duration.- Parameters:
defaultTaskStartToCloseTimeout- The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecutionDecision.The duration is specified in seconds, an integer greater than or equal to
0. You can useNONEto specify unlimited duration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultExecutionStartToCloseTimeout
WorkflowTypeConfiguration.Builder defaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecutionDecision.The duration is specified in seconds, an integer greater than or equal to
0. You can useNONEto specify unlimited duration.- Parameters:
defaultExecutionStartToCloseTimeout- The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecutionDecision.The duration is specified in seconds, an integer greater than or equal to
0. You can useNONEto specify unlimited duration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultTaskList
WorkflowTypeConfiguration.Builder defaultTaskList(TaskList defaultTaskList)
The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecutionDecision.- Parameters:
defaultTaskList- The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecutionDecision.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultTaskList
default WorkflowTypeConfiguration.Builder defaultTaskList(Consumer<TaskList.Builder> defaultTaskList)
The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
This is a convenience method that creates an instance of theStartChildWorkflowExecutionDecision.TaskList.Builderavoiding the need to create one manually viaTaskList.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todefaultTaskList(TaskList).- Parameters:
defaultTaskList- 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:
defaultTaskList(TaskList)
-
defaultTaskPriority
WorkflowTypeConfiguration.Builder defaultTaskPriority(String defaultTaskPriority)
The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecutiondecision.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:
defaultTaskPriority- The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecutiondecision.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:
- Returns a reference to this object so that method calls can be chained together.
-
defaultChildPolicy
WorkflowTypeConfiguration.Builder defaultChildPolicy(String defaultChildPolicy)
The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecutionDecision.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 aWorkflowExecutionCancelRequestedevent 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:
defaultChildPolicy- The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecutionDecision.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 aWorkflowExecutionCancelRequestedevent 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
-
-
defaultChildPolicy
WorkflowTypeConfiguration.Builder defaultChildPolicy(ChildPolicy defaultChildPolicy)
The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecutionDecision.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 aWorkflowExecutionCancelRequestedevent 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:
defaultChildPolicy- The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecutionDecision.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 aWorkflowExecutionCancelRequestedevent 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
-
-
defaultLambdaRole
WorkflowTypeConfiguration.Builder defaultLambdaRole(String defaultLambdaRole)
The default IAM role attached to this workflow type.
Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon .com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
- Parameters:
defaultLambdaRole- The default IAM role attached to this workflow type.Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-