Package software.amazon.awssdk.services.codepipeline.model

Interface StopPipelineExecutionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CodePipelineRequest.Builder, CopyableBuilder<StopPipelineExecutionRequest.Builder,StopPipelineExecutionRequest>, SdkBuilder<StopPipelineExecutionRequest.Builder,StopPipelineExecutionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StopPipelineExecutionRequest
public static interface StopPipelineExecutionRequest.Builder extends CodePipelineRequest.Builder, SdkPojo, CopyableBuilder<StopPipelineExecutionRequest.Builder,StopPipelineExecutionRequest>

  • Method Details

    • pipelineName

      StopPipelineExecutionRequest.Builder pipelineName(String pipelineName)

      The name of the pipeline to stop.

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

    • pipelineExecutionId

      StopPipelineExecutionRequest.Builder pipelineExecutionId(String pipelineExecutionId)

      The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

      Parameters:
      pipelineExecutionId - The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • abandon

      StopPipelineExecutionRequest.Builder abandon(Boolean abandon)

      Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

      This option can lead to failed or out-of-sequence tasks.

      Parameters:
      abandon - Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

      This option can lead to failed or out-of-sequence tasks.

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

    • reason

      StopPipelineExecutionRequest.Builder reason(String reason)

      Use this option to enter comments, such as the reason the pipeline was stopped.

      Parameters:
      reason - Use this option to enter comments, such as the reason the pipeline was stopped.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StopPipelineExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StopPipelineExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.