software.amazon.awssdk.services.swf.model

Class WorkflowTypeConfiguration

java.lang.Object

software.amazon.awssdk.services.swf.model.WorkflowTypeConfiguration

All Implemented Interfaces:

StructuredPojo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public class WorkflowTypeConfiguration
extends Object
implements StructuredPojo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>

The configuration settings of a workflow type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkflowTypeConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static WorkflowTypeConfiguration.Builder	builder()
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.
String	defaultExecutionStartToCloseTimeout() Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type.
String	defaultLambdaRole() The default IAM role to use when a workflow execution invokes a AWS Lambda function.
TaskList	defaultTaskList() Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.
String	defaultTaskPriority() Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type.
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.
boolean	equals(Object obj)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
static Class<? extends WorkflowTypeConfiguration.Builder>	serializableBuilderClass()
WorkflowTypeConfiguration.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

defaultTaskStartToCloseTimeout

public 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.

Returns:

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.

defaultExecutionStartToCloseTimeout

public 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.

Returns:

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.

defaultTaskList

public 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.

Returns:

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

defaultTaskPriority

public 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.

Returns:

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

defaultChildPolicy

public 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.

Returns:

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.

See Also:

ChildPolicy

defaultLambdaRole

public String defaultLambdaRole()

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

Returns:

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

toBuilder

public WorkflowTypeConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>

builder

public static WorkflowTypeConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends WorkflowTypeConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo