software.amazon.awssdk.services.swf.model

Interface WorkflowTypeConfiguration.Builder

All Superinterfaces:

software.amazon.awssdk.utils.builder.CopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>, software.amazon.awssdk.utils.builder.SdkBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>

Enclosing class:

WorkflowTypeConfiguration

public static interface WorkflowTypeConfiguration.Builder
extends software.amazon.awssdk.utils.builder.CopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>

Method Summary

Modifier and Type	Method and Description
WorkflowTypeConfiguration.Builder	defaultChildPolicy(ChildPolicy defaultChildPolicy) Optional. 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.Builder	defaultChildPolicy(String defaultChildPolicy) Optional. 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.Builder	defaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout) Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type.
WorkflowTypeConfiguration.Builder	defaultLambdaRole(String defaultLambdaRole) The default IAM role to use when a workflow execution invokes a AWS Lambda function.
WorkflowTypeConfiguration.Builder	defaultTaskList(TaskList defaultTaskList) Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.
WorkflowTypeConfiguration.Builder	defaultTaskPriority(String defaultTaskPriority) Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type.
WorkflowTypeConfiguration.Builder	defaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout) Optional. 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

apply, build

Method Detail

defaultTaskStartToCloseTimeout

WorkflowTypeConfiguration.Builder defaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)

Optional. 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 does not 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 StartChildWorkflowExecution decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

Parameters:

defaultTaskStartToCloseTimeout - Optional. 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 does not 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 StartChildWorkflowExecution decision.

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultExecutionStartToCloseTimeout

WorkflowTypeConfiguration.Builder defaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)

Optional. 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 StartChildWorkflowExecution decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

Parameters:

defaultExecutionStartToCloseTimeout - Optional. 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 StartChildWorkflowExecution decision.

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultTaskList

WorkflowTypeConfiguration.Builder defaultTaskList(TaskList defaultTaskList)

Optional. 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 StartChildWorkflowExecution decision.

Parameters:

defaultTaskList - Optional. 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 StartChildWorkflowExecution

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultTaskPriority

WorkflowTypeConfiguration.Builder defaultTaskPriority(String defaultTaskPriority)

Optional. 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 StartChildWorkflowExecution decision.

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 Simple Workflow Developer Guide.

Parameters:

defaultTaskPriority - Optional. 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 StartChildWorkflowExecution decision.

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 Simple Workflow Developer Guide

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultChildPolicy

WorkflowTypeConfiguration.Builder defaultChildPolicy(String defaultChildPolicy)

Optional. 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 StartChildWorkflowExecution decision.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.

Parameters:

defaultChildPolicy - Optional. 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 StartChildWorkflowExecution decision.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChildPolicy

defaultChildPolicy

WorkflowTypeConfiguration.Builder defaultChildPolicy(ChildPolicy defaultChildPolicy)

Optional. 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 StartChildWorkflowExecution decision.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.

Parameters:

defaultChildPolicy - Optional. 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 StartChildWorkflowExecution decision.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChildPolicy

defaultLambdaRole

WorkflowTypeConfiguration.Builder defaultLambdaRole(String defaultLambdaRole)

The default IAM role to use when a workflow execution invokes a AWS Lambda function.

Parameters:

defaultLambdaRole - The default IAM role to use when a workflow execution invokes a AWS Lambda function.

Returns:

Returns a reference to this object so that method calls can be chained together.