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

Class StopPipelineExecutionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest

software.amazon.awssdk.services.codepipeline.model.StopPipelineExecutionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StopPipelineExecutionRequest.Builder,StopPipelineExecutionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StopPipelineExecutionRequest
extends CodePipelineRequest
implements ToCopyableBuilder<StopPipelineExecutionRequest.Builder,StopPipelineExecutionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StopPipelineExecutionRequest.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	abandon()	Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
static StopPipelineExecutionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	pipelineExecutionId()	The ID of the pipeline execution to be stopped in the current stage.
String	pipelineName()	The name of the pipeline to stop.
String	reason()	Use this option to enter comments, such as the reason the pipeline was stopped.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StopPipelineExecutionRequest.Builder>	serializableBuilderClass()
StopPipelineExecutionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

pipelineName

public final String pipelineName()

The name of the pipeline to stop.

Returns:

The name of the pipeline to stop.

pipelineExecutionId

public final String pipelineExecutionId()

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

Returns:

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

abandon

public final 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.

Returns:

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.

reason

public final String reason()

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

Returns:

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

toBuilder

public StopPipelineExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StopPipelineExecutionRequest.Builder,StopPipelineExecutionRequest>

Specified by:

toBuilder in class CodePipelineRequest

builder

public static StopPipelineExecutionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StopPipelineExecutionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo