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 Summary

Modifier and Type	Method and Description
StopPipelineExecutionRequest.Builder	abandon(Boolean abandon) Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
StopPipelineExecutionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StopPipelineExecutionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StopPipelineExecutionRequest.Builder	pipelineExecutionId(String pipelineExecutionId) The ID of the pipeline execution to be stopped in the current stage.
StopPipelineExecutionRequest.Builder	pipelineName(String pipelineName) The name of the pipeline to stop.
StopPipelineExecutionRequest.Builder	reason(String reason) Use this option to enter comments, such as the reason the pipeline was stopped.

Methods inherited from interface software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StopPipelineExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder