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

Interface StartChildWorkflowExecutionInitiatedEventAttributes.Builder

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

  • Method Details

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

    • workflowType

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

      The type of the child workflow execution.

      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:

    • control

      StartChildWorkflowExecutionInitiatedEventAttributes.Builder control(String control)

      Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

      Parameters:
      control - Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.
      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.

      Parameters:
      input - The inputs provided to the child workflow execution.
      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 isn't closed within this duration, it is timed out and force-terminated.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

      Parameters:
      executionStartToCloseTimeout - The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE 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.

    • taskList

      default StartChildWorkflowExecutionInitiatedEventAttributes.Builder taskList(Consumer<TaskList.Builder> taskList)

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

      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

      StartChildWorkflowExecutionInitiatedEventAttributes.Builder taskPriority(String taskPriority)

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

      Parameters:
      taskPriority - 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 SWF 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 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.

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

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

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

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

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

    • 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. You can use NONE 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. You can use NONE 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.

      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 to attach to the child workflow execution.

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