Interface PipelineExecution.Builder

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

  • Method Details

    • pipelineName

      PipelineExecution.Builder pipelineName(String pipelineName)

      The name of the pipeline with the specified pipeline execution.

      Parameters:
      pipelineName - The name of the pipeline with the specified pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pipelineVersion

      PipelineExecution.Builder pipelineVersion(Integer pipelineVersion)

      The version number of the pipeline with the specified pipeline execution.

      Parameters:
      pipelineVersion - The version number of the pipeline with the specified pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pipelineExecutionId

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

      PipelineExecution.Builder status(String status)

      The status of the pipeline execution.

      • Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

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

      • Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

      • 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

      PipelineExecution.Builder status(PipelineExecutionStatus status)

      The status of the pipeline execution.

      • Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

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

      • Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

      • 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

      PipelineExecution.Builder statusSummary(String statusSummary)

      A summary that contains a description of the pipeline execution status.

      Parameters:
      statusSummary - A summary that contains a description of the pipeline execution status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • artifactRevisions

      PipelineExecution.Builder artifactRevisions(Collection<ArtifactRevision> artifactRevisions)

      A list of ArtifactRevision objects included in a pipeline execution.

      Parameters:
      artifactRevisions - A list of ArtifactRevision objects included in a pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • artifactRevisions

      PipelineExecution.Builder artifactRevisions(ArtifactRevision... artifactRevisions)

      A list of ArtifactRevision objects included in a pipeline execution.

      Parameters:
      artifactRevisions - A list of ArtifactRevision objects included in a pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • artifactRevisions

      PipelineExecution.Builder artifactRevisions(Consumer<ArtifactRevision.Builder>... artifactRevisions)

      A list of ArtifactRevision objects included in a pipeline execution.

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

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

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

    • variables

      PipelineExecution.Builder variables(Collection<ResolvedPipelineVariable> variables)

      A list of pipeline variables used for the pipeline execution.

      Parameters:
      variables - A list of pipeline variables used for the pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • variables

      PipelineExecution.Builder variables(ResolvedPipelineVariable... variables)

      A list of pipeline variables used for the pipeline execution.

      Parameters:
      variables - A list of pipeline variables used for the pipeline execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • variables

      PipelineExecution.Builder variables(Consumer<ResolvedPipelineVariable.Builder>... variables)

      A list of pipeline variables used for the pipeline execution.

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

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

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

    • trigger

      PipelineExecution.Builder trigger(ExecutionTrigger trigger)
      Sets the value of the Trigger property for this object.
      Parameters:
      trigger - The new value for the Trigger property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trigger

      default PipelineExecution.Builder trigger(Consumer<ExecutionTrigger.Builder> trigger)
      Sets the value of the Trigger property for this object. 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:

    • executionMode

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

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

      PipelineExecution.Builder executionType(String executionType)

      The type of the pipeline execution.

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

    • executionType

      PipelineExecution.Builder executionType(ExecutionType executionType)

      The type of the pipeline execution.

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

    • rollbackMetadata

      PipelineExecution.Builder rollbackMetadata(PipelineRollbackMetadata rollbackMetadata)

      The metadata about the execution pertaining to stage rollback.

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

    • rollbackMetadata

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

      The metadata about the execution pertaining to stage rollback.

      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: