Interface WorkflowExecutionStartedEventAttributes.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WorkflowExecutionStartedEventAttributes.Builder,WorkflowExecutionStartedEventAttributes>, SdkBuilder<WorkflowExecutionStartedEventAttributes.Builder,WorkflowExecutionStartedEventAttributes>, SdkPojo
Enclosing class:
WorkflowExecutionStartedEventAttributes
@Mutable @NotThreadSafe public static interface WorkflowExecutionStartedEventAttributes.Builder extends SdkPojo, CopyableBuilder<WorkflowExecutionStartedEventAttributes.Builder,WorkflowExecutionStartedEventAttributes>

  • Method Details

    • input

      WorkflowExecutionStartedEventAttributes.Builder input(String input)

      The input provided to the workflow execution.

      Parameters:
      input - The input provided to the workflow execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionStartToCloseTimeout

      WorkflowExecutionStartedEventAttributes.Builder executionStartToCloseTimeout(String executionStartToCloseTimeout)

      The maximum duration 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:
      executionStartToCloseTimeout - The maximum duration 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.

    • taskStartToCloseTimeout

      WorkflowExecutionStartedEventAttributes.Builder taskStartToCloseTimeout(String taskStartToCloseTimeout)

      The maximum duration of decision tasks for this workflow type.

      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 of decision tasks for this workflow type.

      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.

    • childPolicy

      WorkflowExecutionStartedEventAttributes.Builder childPolicy(String childPolicy)

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

      WorkflowExecutionStartedEventAttributes.Builder childPolicy(ChildPolicy childPolicy)

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

    • taskList

      WorkflowExecutionStartedEventAttributes.Builder taskList(TaskList taskList)

      The name of the task list for scheduling the decision tasks for this workflow execution.

      Parameters:
      taskList - The name of the task list for scheduling the decision tasks for this workflow execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskList

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

      The name of the task list for scheduling the decision tasks for this 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

      WorkflowExecutionStartedEventAttributes.Builder taskPriority(String taskPriority)

      The priority of the decision tasks in the workflow execution.

      Parameters:
      taskPriority - The priority of the decision tasks in the workflow execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowType

      WorkflowExecutionStartedEventAttributes.Builder workflowType(WorkflowType workflowType)

      The workflow type of this execution.

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

    • workflowType

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

      The workflow type of this 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:

    • tagList

      WorkflowExecutionStartedEventAttributes.Builder tagList(Collection<String> tagList)

      The list of tags associated with this workflow execution. An execution can have up to 5 tags.

      Parameters:
      tagList - The list of tags associated with this workflow execution. An execution can have up to 5 tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagList

      WorkflowExecutionStartedEventAttributes.Builder tagList(String... tagList)

      The list of tags associated with this workflow execution. An execution can have up to 5 tags.

      Parameters:
      tagList - The list of tags associated with this workflow execution. An execution can have up to 5 tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • continuedExecutionRunId

      WorkflowExecutionStartedEventAttributes.Builder continuedExecutionRunId(String continuedExecutionRunId)

      If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

      Parameters:
      continuedExecutionRunId - If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parentWorkflowExecution

      WorkflowExecutionStartedEventAttributes.Builder parentWorkflowExecution(WorkflowExecution parentWorkflowExecution)

      The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

      Parameters:
      parentWorkflowExecution - The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parentWorkflowExecution

      default WorkflowExecutionStartedEventAttributes.Builder parentWorkflowExecution(Consumer<WorkflowExecution.Builder> parentWorkflowExecution)

      The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

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

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

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

    • parentInitiatedEventId

      WorkflowExecutionStartedEventAttributes.Builder parentInitiatedEventId(Long parentInitiatedEventId)

      The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

      Parameters:
      parentInitiatedEventId - The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lambdaRole

      WorkflowExecutionStartedEventAttributes.Builder lambdaRole(String lambdaRole)

      The IAM role attached to the workflow execution.

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