StartChildWorkflowExecutionDecisionAttributes.Builder (AWS SDK for Java

All Superinterfaces:

CopyableBuilder<StartChildWorkflowExecutionDecisionAttributes.Builder,StartChildWorkflowExecutionDecisionAttributes>, SdkBuilder<StartChildWorkflowExecutionDecisionAttributes.Builder,StartChildWorkflowExecutionDecisionAttributes>

Enclosing class:

StartChildWorkflowExecutionDecisionAttributes
```
public static interface StartChildWorkflowExecutionDecisionAttributes.Builder
extends CopyableBuilder<StartChildWorkflowExecutionDecisionAttributes.Builder,StartChildWorkflowExecutionDecisionAttributes>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`childPolicy(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.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`childPolicy(ChildPolicy 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.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`control(String control)`	Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`executionStartToCloseTimeout(String executionStartToCloseTimeout)`	The total duration for this workflow execution.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`input(String input)`	The input to be provided to the workflow execution.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`lambdaRole(String lambdaRole)`	The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`tagList(String... tagList)`	The list of tags to associate with the child workflow execution.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`tagList(Collection<String> tagList)`	The list of tags to associate with the child workflow execution.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`taskList(TaskList taskList)`	The name of the task list to be used for decision tasks of the child workflow execution.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`taskPriority(String taskPriority)`	Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`taskStartToCloseTimeout(String taskStartToCloseTimeout)`	Specifies the maximum duration of decision tasks for this workflow execution.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`workflowId(String workflowId)`	Required. The `workflowId` of the workflow execution.
`StartChildWorkflowExecutionDecisionAttributes.Builder`	`workflowType(WorkflowType workflowType)`	Required. The type of the workflow execution to be started.

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
  - workflowType
```
StartChildWorkflowExecutionDecisionAttributes.Builder workflowType(WorkflowType workflowType)
```
    Required. The type of the workflow execution to be started.
    
    Parameters:
    
    workflowType - Required.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - workflowId
```
StartChildWorkflowExecutionDecisionAttributes.Builder workflowId(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.
    
    Parameters:
    
    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), |
    Returns: Returns a reference to this object so that method calls can be chained together.
  control StartChildWorkflowExecutionDecisionAttributes.Builder control(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. Parameters: control - Optional. Returns: Returns a reference to this object so that method calls can be chained together. input StartChildWorkflowExecutionDecisionAttributes.Builder input(String input) The input to be provided to the workflow execution. Parameters: input - The input to be provided to the workflow execution. Returns: Returns a reference to this object so that method calls can be chained together. executionStartToCloseTimeout StartChildWorkflowExecutionDecisionAttributes.Builder executionStartToCloseTimeout(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. Parameters: 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: Returns a reference to this object so that method calls can be chained together. taskList StartChildWorkflowExecutionDecisionAttributes.Builder taskList(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. Parameters: 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: Returns a reference to this object so that method calls can be chained together. taskPriority StartChildWorkflowExecutionDecisionAttributes.Builder taskPriority(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. Parameters: 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: Returns a reference to this object so that method calls can be chained together. taskStartToCloseTimeout StartChildWorkflowExecutionDecisionAttributes.Builder taskStartToCloseTimeout(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. Parameters: 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: Returns a reference to this object so that method calls can be chained together. childPolicy StartChildWorkflowExecutionDecisionAttributes.Builder childPolicy(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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together. See Also: ChildPolicy childPolicy StartChildWorkflowExecutionDecisionAttributes.Builder childPolicy(ChildPolicy 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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together. See Also: ChildPolicy tagList StartChildWorkflowExecutionDecisionAttributes.Builder tagList(Collection<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. Parameters: 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: Returns a reference to this object so that method calls can be chained together. tagList StartChildWorkflowExecutionDecisionAttributes.Builder tagList(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. 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 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: Returns a reference to this object so that method calls can be chained together. lambdaRole StartChildWorkflowExecutionDecisionAttributes.Builder lambdaRole(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. Parameters: 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: Returns a reference to this object so that method calls can be chained together.

Interface StartChildWorkflowExecutionDecisionAttributes.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

workflowType

workflowId

control

input

executionStartToCloseTimeout

taskList

taskPriority

taskStartToCloseTimeout

childPolicy

childPolicy

tagList

tagList

lambdaRole