Interface PipelineExecutionSummary.Builder

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

  • Method Details

    • pipelineExecutionId

      PipelineExecutionSummary.Builder pipelineExecutionId(String pipelineExecutionId)

      The ID of the pipeline execution.

      Parameters:
      pipelineExecutionId - The ID of the pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      PipelineExecutionSummary.Builder status(String status)

      The status of the pipeline execution.

      • InProgress: The pipeline execution is currently running.

      • Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

      • Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

      • Succeeded: The pipeline execution was completed successfully.

      • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

      • Failed: The pipeline execution was not completed successfully.

      Parameters:
      status - The status of the pipeline execution.

      • InProgress: The pipeline execution is currently running.

      • Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

      • Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

      • Succeeded: The pipeline execution was completed successfully.

      • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

      • Failed: The pipeline execution was not completed successfully.

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

    • status

      PipelineExecutionSummary.Builder status(PipelineExecutionStatus status)

      The status of the pipeline execution.

      • InProgress: The pipeline execution is currently running.

      • Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

      • Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

      • Succeeded: The pipeline execution was completed successfully.

      • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

      • Failed: The pipeline execution was not completed successfully.

      Parameters:
      status - The status of the pipeline execution.

      • InProgress: The pipeline execution is currently running.

      • Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

      • Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

      • Succeeded: The pipeline execution was completed successfully.

      • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

      • Failed: The pipeline execution was not completed successfully.

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

    • statusSummary

      PipelineExecutionSummary.Builder statusSummary(String statusSummary)

      Status summary for the pipeline.

      Parameters:
      statusSummary - Status summary for the pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      PipelineExecutionSummary.Builder startTime(Instant startTime)

      The date and time when the pipeline execution began, in timestamp format.

      Parameters:
      startTime - The date and time when the pipeline execution began, in timestamp format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdateTime

      PipelineExecutionSummary.Builder lastUpdateTime(Instant lastUpdateTime)

      The date and time of the last change to the pipeline execution, in timestamp format.

      Parameters:
      lastUpdateTime - The date and time of the last change to the pipeline execution, in timestamp format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceRevisions

      PipelineExecutionSummary.Builder sourceRevisions(Collection<SourceRevision> sourceRevisions)

      A list of the source artifact revisions that initiated a pipeline execution.

      Parameters:
      sourceRevisions - A list of the source artifact revisions that initiated a pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceRevisions

      PipelineExecutionSummary.Builder sourceRevisions(SourceRevision... sourceRevisions)

      A list of the source artifact revisions that initiated a pipeline execution.

      Parameters:
      sourceRevisions - A list of the source artifact revisions that initiated a pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceRevisions

      PipelineExecutionSummary.Builder sourceRevisions(Consumer<SourceRevision.Builder>... sourceRevisions)

      A list of the source artifact revisions that initiated a pipeline execution.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceRevisions(List<SourceRevision>).

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

    • trigger

      PipelineExecutionSummary.Builder trigger(ExecutionTrigger trigger)

      The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.

      Parameters:
      trigger - The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trigger

      default PipelineExecutionSummary.Builder trigger(Consumer<ExecutionTrigger.Builder> trigger)

      The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.

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

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

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

    • stopTrigger

      PipelineExecutionSummary.Builder stopTrigger(StopExecutionTrigger stopTrigger)

      The interaction that stopped a pipeline execution.

      Parameters:
      stopTrigger - The interaction that stopped a pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stopTrigger

      default PipelineExecutionSummary.Builder stopTrigger(Consumer<StopExecutionTrigger.Builder> stopTrigger)

      The interaction that stopped a pipeline execution.

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

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

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

    • executionMode

      PipelineExecutionSummary.Builder executionMode(String executionMode)

      The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

      Parameters:
      executionMode - The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionMode

      PipelineExecutionSummary.Builder executionMode(ExecutionMode executionMode)

      The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

      Parameters:
      executionMode - The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionType

      PipelineExecutionSummary.Builder executionType(String executionType)

      Type of the pipeline execution.

      Parameters:
      executionType - Type of the pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionType

      PipelineExecutionSummary.Builder executionType(ExecutionType executionType)

      Type of the pipeline execution.

      Parameters:
      executionType - Type of the pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rollbackMetadata

      PipelineExecutionSummary.Builder rollbackMetadata(PipelineRollbackMetadata rollbackMetadata)

      The metadata for the stage execution to be rolled back.

      Parameters:
      rollbackMetadata - The metadata for the stage execution to be rolled back.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rollbackMetadata

      default PipelineExecutionSummary.Builder rollbackMetadata(Consumer<PipelineRollbackMetadata.Builder> rollbackMetadata)

      The metadata for the stage execution to be rolled back.

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

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

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