Package 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:
SdkPojo, ToCopyableBuilder<RetryStageExecutionRequest.Builder,RetryStageExecutionRequest>
@Generated("software.amazon.awssdk:codegen") public final class RetryStageExecutionRequest extends CodePipelineRequest implements ToCopyableBuilder<RetryStageExecutionRequest.Builder,RetryStageExecutionRequest>

Represents the input of a RetryStageExecution action.

  • Method Details

    • pipelineName

      public final 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 final String stageName()

      The name of the failed stage to be retried.

      Returns:
      The name of the failed stage to be retried.

    • pipelineExecutionId

      public final 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 final StageRetryMode retryMode()

      The scope of the retry attempt.

      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.
      See Also:

    • retryModeAsString

      public final String retryModeAsString()

      The scope of the retry attempt.

      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.
      See Also:

    • 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 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.