Package software.amazon.awssdk.services.swf.model

Class WorkflowExecutionConfiguration

java.lang.Object

software.amazon.awssdk.services.swf.model.WorkflowExecutionConfiguration

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>

@Generated("software.amazon.awssdk:codegen")
public class WorkflowExecutionConfiguration
extends Object
implements StructuredPojo, 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkflowExecutionConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static WorkflowExecutionConfiguration.Builder	builder()
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.
boolean	equals(Object obj)
String	executionStartToCloseTimeout()	The total duration for this workflow execution.
int	hashCode()
String	lambdaRole()	The IAM role used by this workflow execution when invoking AWS Lambda functions.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
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()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

taskStartToCloseTimeout

public 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. The value "NONE" can be used 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. The value "NONE" can be used to specify unlimited duration.

executionStartToCloseTimeout

public String executionStartToCloseTimeout()

The total duration for this workflow execution.

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:

The total duration for this workflow execution.

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

taskList

public 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 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) 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:

The priority assigned to decision tasks for this workflow execution. 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.

childPolicy

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

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

lambdaRole

public String lambdaRole()

The IAM role used by this workflow execution when invoking AWS Lambda functions.

Returns:

The IAM role used by this workflow execution when invoking AWS Lambda functions.

toBuilder

public WorkflowExecutionConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>

Returns:

a builder for type T

builder

public static WorkflowExecutionConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends WorkflowExecutionConfiguration.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)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.