Interface WorkflowRun.Builder

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

  • Method Details

    • name

      WorkflowRun.Builder name(String name)

      Name of the workflow that was run.

      Parameters:
      name - Name of the workflow that was run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowRunId

      WorkflowRun.Builder workflowRunId(String workflowRunId)

      The ID of this workflow run.

      Parameters:
      workflowRunId - The ID of this workflow run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • previousRunId

      WorkflowRun.Builder previousRunId(String previousRunId)

      The ID of the previous workflow run.

      Parameters:
      previousRunId - The ID of the previous workflow run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowRunProperties

      WorkflowRun.Builder workflowRunProperties(Map<String,String> workflowRunProperties)

      The workflow run properties which were set during the run.

      Parameters:
      workflowRunProperties - The workflow run properties which were set during the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedOn

      WorkflowRun.Builder startedOn(Instant startedOn)

      The date and time when the workflow run was started.

      Parameters:
      startedOn - The date and time when the workflow run was started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completedOn

      WorkflowRun.Builder completedOn(Instant completedOn)

      The date and time when the workflow run completed.

      Parameters:
      completedOn - The date and time when the workflow run completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      WorkflowRun.Builder status(String status)

      The status of the workflow run.

      Parameters:
      status - The status of the workflow run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      WorkflowRun.Builder status(WorkflowRunStatus status)

      The status of the workflow run.

      Parameters:
      status - The status of the workflow run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • errorMessage

      WorkflowRun.Builder errorMessage(String errorMessage)

      This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."

      Parameters:
      errorMessage - This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is "Concurrent runs exceeded for workflow: foo."
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statistics

      WorkflowRun.Builder statistics(WorkflowRunStatistics statistics)

      The statistics of the run.

      Parameters:
      statistics - The statistics of the run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statistics

      default WorkflowRun.Builder statistics(Consumer<WorkflowRunStatistics.Builder> statistics)

      The statistics of the run.

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

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

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

    • graph

      WorkflowRun.Builder graph(WorkflowGraph graph)

      The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.

      Parameters:
      graph - The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • graph

      default WorkflowRun.Builder graph(Consumer<WorkflowGraph.Builder> graph)

      The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.

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

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

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

    • startingEventBatchCondition

      WorkflowRun.Builder startingEventBatchCondition(StartingEventBatchCondition startingEventBatchCondition)

      The batch condition that started the workflow run.

      Parameters:
      startingEventBatchCondition - The batch condition that started the workflow run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startingEventBatchCondition

      default WorkflowRun.Builder startingEventBatchCondition(Consumer<StartingEventBatchCondition.Builder> startingEventBatchCondition)

      The batch condition that started the workflow run.

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

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

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