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 Summary
Modifier and TypeMethodDescriptionUse this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.pipelineExecutionId
(String pipelineExecutionId) The ID of the pipeline execution to be stopped in the current stage.pipelineName
(String pipelineName) The name of the pipeline to stop.Use this option to enter comments, such as the reason the pipeline was stopped.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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 theGetPipelineState
action to retrieve the current pipelineExecutionId.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-