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

Interface StartChildWorkflowExecutionDecisionAttributes.Builder

All Superinterfaces:
Buildable, CopyableBuilder<StartChildWorkflowExecutionDecisionAttributes.Builder,StartChildWorkflowExecutionDecisionAttributes>, SdkBuilder<StartChildWorkflowExecutionDecisionAttributes.Builder,StartChildWorkflowExecutionDecisionAttributes>, SdkPojo
Enclosing class:
StartChildWorkflowExecutionDecisionAttributes
public static interface StartChildWorkflowExecutionDecisionAttributes.Builder extends SdkPojo, CopyableBuilder<StartChildWorkflowExecutionDecisionAttributes.Builder,StartChildWorkflowExecutionDecisionAttributes>

  • Method Details

    • workflowType

      StartChildWorkflowExecutionDecisionAttributes.Builder workflowType(WorkflowType workflowType)

      The type of the workflow execution to be started.

      Parameters:
      workflowType - The type of the workflow execution to be started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowType

      default StartChildWorkflowExecutionDecisionAttributes.Builder workflowType(Consumer<WorkflowType.Builder> workflowType)

      The type of the workflow execution to be started.

      This is a convenience method that creates an instance of the WorkflowType.Builder avoiding the need to create one manually via WorkflowType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to workflowType(WorkflowType).

      Parameters:
      workflowType - a consumer that will call methods on WorkflowType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workflowId

      StartChildWorkflowExecutionDecisionAttributes.Builder workflowId(String workflowId)

      The workflowId of the workflow execution.

      The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

      Parameters:
      workflowId - The workflowId of the workflow execution.

      The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

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

    • control

      StartChildWorkflowExecutionDecisionAttributes.Builder control(String control)

      The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.

      Parameters:
      control - The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.
      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. You can use NONE 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 is 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. You can use NONE 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 is 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 is 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 be the literal string arn.

      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 is 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 be the literal string arn.

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

    • taskList

      default StartChildWorkflowExecutionDecisionAttributes.Builder taskList(Consumer<TaskList.Builder> 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 is 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 be the literal string arn.

      This is a convenience method that creates an instance of the TaskList.Builder avoiding the need to create one manually via TaskList.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taskList(TaskList).

      Parameters:
      taskList - a consumer that will call methods on TaskList.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • taskPriority

      StartChildWorkflowExecutionDecisionAttributes.Builder taskPriority(String taskPriority)

      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 SWF Developer Guide.

      Parameters:
      taskPriority - 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 SWF 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. You can use NONE 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 is 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. You can use NONE 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 is returned.

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

    • childPolicy

      StartChildWorkflowExecutionDecisionAttributes.Builder childPolicy(String childPolicy)

      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 are terminated.

      • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions 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 is returned.

      Parameters:
      childPolicy - 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 are terminated.

      • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions 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 is returned.

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

    • childPolicy

      StartChildWorkflowExecutionDecisionAttributes.Builder childPolicy(ChildPolicy childPolicy)

      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 are terminated.

      • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions 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 is returned.

      Parameters:
      childPolicy - 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 are terminated.

      • REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions 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 is returned.

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

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

      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 IAM role attached to the child workflow execution.

      Parameters:
      lambdaRole - The IAM role attached to the child workflow execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.