software.amazon.awssdk.services.codepipeline.model

Class RetryStageExecutionRequest

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.RetryStageExecutionRequest

All Implemented Interfaces:

ToCopyableBuilder<RetryStageExecutionRequest.Builder,RetryStageExecutionRequest>

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

Represents the input of a RetryStageExecution action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RetryStageExecutionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RetryStageExecutionRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	pipelineExecutionId() The ID of the pipeline execution in the failed stage to be retried.
String	pipelineName() The name of the pipeline that contains the failed stage.
StageRetryMode	retryMode() The scope of the retry attempt.
String	retryModeAsString() The scope of the retry attempt.
static Class<? extends RetryStageExecutionRequest.Builder>	serializableBuilderClass()
String	stageName() The name of the failed stage to be retried.
RetryStageExecutionRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

pipelineName

public String pipelineName()

The name of the pipeline that contains the failed stage.

Returns:

The name of the pipeline that contains the failed stage.

stageName

public String stageName()

The name of the failed stage to be retried.

Returns:

The name of the failed stage to be retried.

pipelineExecutionId

public String pipelineExecutionId()

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

Returns:

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

retryMode

public StageRetryMode retryMode()

The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.

If the service returns an enum value that is not available in the current SDK version, retryMode will return StageRetryMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from retryModeAsString().

Returns:

The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.

See Also:

StageRetryMode

retryModeAsString

public String retryModeAsString()

The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.

If the service returns an enum value that is not available in the current SDK version, retryMode will return StageRetryMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from retryModeAsString().

Returns:

The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.

See Also:

StageRetryMode

toBuilder

public RetryStageExecutionRequest.Builder 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 interface ToCopyableBuilder<RetryStageExecutionRequest.Builder,RetryStageExecutionRequest>

Specified by:

toBuilder in class CodePipelineRequest

Returns:

a builder for type T

builder

public static RetryStageExecutionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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