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

Interface StartChildWorkflowExecutionInitiatedEventAttributes.Builder

All Superinterfaces:

CopyableBuilder<StartChildWorkflowExecutionInitiatedEventAttributes.Builder,StartChildWorkflowExecutionInitiatedEventAttributes>, SdkBuilder<StartChildWorkflowExecutionInitiatedEventAttributes.Builder,StartChildWorkflowExecutionInitiatedEventAttributes>

Enclosing class:

StartChildWorkflowExecutionInitiatedEventAttributes

public static interface StartChildWorkflowExecutionInitiatedEventAttributes.Builder
extends CopyableBuilder<StartChildWorkflowExecutionInitiatedEventAttributes.Builder,StartChildWorkflowExecutionInitiatedEventAttributes>

Method Summary

Modifier and Type	Method	Description
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	childPolicy(String childPolicy)	The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	childPolicy(ChildPolicy childPolicy)	The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	control(String control)	Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	decisionTaskCompletedEventId(Long decisionTaskCompletedEventId)	The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	executionStartToCloseTimeout(String executionStartToCloseTimeout)	The maximum duration for the child workflow execution.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	input(String input)	The inputs provided to the child workflow execution (if any).
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	lambdaRole(String lambdaRole)	The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	tagList(String... tagList)	The list of tags to associated with the child workflow execution.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	tagList(Collection<String> tagList)	The list of tags to associated with the child workflow execution.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	taskList(TaskList taskList)	The name of the task list used for the decision tasks of the child workflow execution.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	taskPriority(String taskPriority)	Optional. The priority assigned for the decision tasks for this workflow execution.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	taskStartToCloseTimeout(String taskStartToCloseTimeout)	The maximum duration allowed for the decision tasks for this workflow execution.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	workflowId(String workflowId)	The workflowId of the child workflow execution.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	workflowType(WorkflowType workflowType)	The type of the child workflow execution.

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

workflowId

StartChildWorkflowExecutionInitiatedEventAttributes.Builder workflowId(String workflowId)

The workflowId of the child workflow execution.

Parameters:

workflowId - The workflowId of the child workflow execution.

Returns:

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

workflowType

StartChildWorkflowExecutionInitiatedEventAttributes.Builder workflowType(WorkflowType workflowType)

The type of the child workflow execution.

Parameters:

workflowType - The type of the child workflow execution.

Returns:

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

control

StartChildWorkflowExecutionInitiatedEventAttributes.Builder control(String control)

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

Parameters:

control - Optional.

Returns:

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

input

StartChildWorkflowExecutionInitiatedEventAttributes.Builder input(String input)

The inputs provided to the child workflow execution (if any).

Parameters:

input - The inputs provided to the child workflow execution (if any).

Returns:

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

executionStartToCloseTimeout

StartChildWorkflowExecutionInitiatedEventAttributes.Builder executionStartToCloseTimeout(String executionStartToCloseTimeout)

The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

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:

executionStartToCloseTimeout - The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

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:

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

taskList

StartChildWorkflowExecutionInitiatedEventAttributes.Builder taskList(TaskList taskList)

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

Parameters:

taskList - The name of the task list used for the decision tasks of the child workflow execution.

Returns:

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

taskPriority

StartChildWorkflowExecutionInitiatedEventAttributes.Builder taskPriority(String taskPriority)

Optional. The priority assigned for the 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.

Parameters:

taskPriority - Optional. The priority assigned for the 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:

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

decisionTaskCompletedEventId

StartChildWorkflowExecutionInitiatedEventAttributes.Builder decisionTaskCompletedEventId(Long decisionTaskCompletedEventId)

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

Parameters:

decisionTaskCompletedEventId - The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

Returns:

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

childPolicy

StartChildWorkflowExecutionInitiatedEventAttributes.Builder childPolicy(String childPolicy)

The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action 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.

Parameters:

childPolicy - The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action 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:

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

See Also:

ChildPolicy

childPolicy

StartChildWorkflowExecutionInitiatedEventAttributes.Builder childPolicy(ChildPolicy childPolicy)

The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action 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.

Parameters:

childPolicy - The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action 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:

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

See Also:

ChildPolicy

taskStartToCloseTimeout

StartChildWorkflowExecutionInitiatedEventAttributes.Builder taskStartToCloseTimeout(String taskStartToCloseTimeout)

The maximum duration allowed for the 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.

Parameters:

taskStartToCloseTimeout - The maximum duration allowed for the 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:

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

tagList

StartChildWorkflowExecutionInitiatedEventAttributes.Builder tagList(Collection<String> tagList)

The list of tags to associated with the child workflow execution.

Parameters:

tagList - The list of tags to associated with the child workflow execution.

Returns:

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

tagList

StartChildWorkflowExecutionInitiatedEventAttributes.Builder tagList(String... tagList)

The list of tags to associated with the child workflow execution.

NOTE: This method appends the values to the existing list (if any). Use #setTagList(java.util.Collection) or #withTagList(java.util.Collection) if you want to override the existing values.

Parameters:

tagList - The list of tags to associated with the child workflow execution.

Returns:

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

lambdaRole

StartChildWorkflowExecutionInitiatedEventAttributes.Builder lambdaRole(String lambdaRole)

The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.

Parameters:

lambdaRole - The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.

Returns:

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