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
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
abandon()
Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
The ID of the pipeline execution to be stopped in the current stage.final String
The name of the pipeline to stop.final String
reason()
Use this option to enter comments, such as the reason the pipeline was stopped.static Class
<? extends StopPipelineExecutionRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
pipelineName
The name of the pipeline to stop.
- Returns:
- The name of the pipeline to stop.
-
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StopPipelineExecutionRequest.Builder,
StopPipelineExecutionRequest> - Specified by:
toBuilder
in classCodePipelineRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-