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

Class StartChildWorkflowExecutionDecisionAttributes

java.lang.Object

software.amazon.awssdk.services.swf.model.StartChildWorkflowExecutionDecisionAttributes

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<StartChildWorkflowExecutionDecisionAttributes.Builder,StartChildWorkflowExecutionDecisionAttributes>

@Generated("software.amazon.awssdk:codegen")
public class StartChildWorkflowExecutionDecisionAttributes
extends Object
implements StructuredPojo, ToCopyableBuilder<StartChildWorkflowExecutionDecisionAttributes.Builder,StartChildWorkflowExecutionDecisionAttributes>

Provides details of the StartChildWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• Constrain the following parameters by using a Condition element with the appropriate keys.
  • tagList.member.N: The key is "swf:tagList.N" where N is the tag number from 0 to 4, inclusive.
  • taskList: String constraint. The key is swf:taskList.name.
  • workflowType.name: String constraint. The key is swf:workflowType.name.
  • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartChildWorkflowExecutionDecisionAttributes.Builder

Method Summary

Modifier and Type	Method	Description
static StartChildWorkflowExecutionDecisionAttributes.Builder	builder()
String	childPolicy()	Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
String	control()	Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
boolean	equals(Object obj)
String	executionStartToCloseTimeout()	The total duration for this workflow execution.
int	hashCode()
String	input()	The input to be provided to the workflow execution.
String	lambdaRole()	The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends StartChildWorkflowExecutionDecisionAttributes.Builder>	serializableBuilderClass()
List<String>	tagList()	The list of tags to associate with the child workflow execution.
TaskList	taskList()	The name of the task list to be used for decision tasks of the child workflow execution.
String	taskPriority()	Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution.
String	taskStartToCloseTimeout()	Specifies the maximum duration of decision tasks for this workflow execution.
StartChildWorkflowExecutionDecisionAttributes.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	workflowId()	Required. The workflowId of the workflow execution.
WorkflowType	workflowType()	Required. The type of the workflow execution to be started.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

workflowType

public WorkflowType workflowType()

Required. The type of the workflow execution to be started.

Returns:

Required.

workflowId

public String workflowId()

Required. The workflowId of the workflow execution.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

Returns:

Required. The workflowId of the workflow execution.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), |

control

public String control()

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.

Returns:

Optional.

input

public String input()

The input to be provided to the workflow execution.

Returns:

The input to be provided to the workflow execution.

executionStartToCloseTimeout

public String executionStartToCloseTimeout()

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

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

An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.

Returns:

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

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

An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.

taskList

public TaskList taskList()

The name of the task list to be used for decision tasks of the child workflow execution.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

Returns:

The name of the task list to be used for decision tasks of the child workflow execution.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

taskPriority

public String taskPriority()

Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. 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. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. 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

taskStartToCloseTimeout

public String taskStartToCloseTimeout()

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

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

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.

Returns:

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

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

A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.

childPolicy

public String childPolicy()

Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

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.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.

Returns:

Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

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

tagList

public List<String> tagList()

The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

Returns:

The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

lambdaRole

public String lambdaRole()

The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.

In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.

Returns:

The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.

In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.

toBuilder

public StartChildWorkflowExecutionDecisionAttributes.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<StartChildWorkflowExecutionDecisionAttributes.Builder,StartChildWorkflowExecutionDecisionAttributes>

Returns:

a builder for type T

builder

public static StartChildWorkflowExecutionDecisionAttributes.Builder builder()

serializableBuilderClass

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