Class GetUpgradeStatusResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.opensearch.model.OpenSearchResponse
software.amazon.awssdk.services.opensearch.model.GetUpgradeStatusResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetUpgradeStatusResponse.Builder,GetUpgradeStatusResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetUpgradeStatusResponse extends OpenSearchResponse implements ToCopyableBuilder<GetUpgradeStatusResponse.Builder,GetUpgradeStatusResponse>

Container for the response returned by the GetUpgradeStatus operation.

  • Method Details

    • upgradeStep

      public final UpgradeStep upgradeStep()

      One of three steps that an upgrade or upgrade eligibility check goes through.

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

      Returns:
      One of three steps that an upgrade or upgrade eligibility check goes through.
      See Also:

    • upgradeStepAsString

      public final String upgradeStepAsString()

      One of three steps that an upgrade or upgrade eligibility check goes through.

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

      Returns:
      One of three steps that an upgrade or upgrade eligibility check goes through.
      See Also:

    • stepStatus

      public final UpgradeStatus stepStatus()

      The status of the current step that an upgrade is on.

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

      Returns:
      The status of the current step that an upgrade is on.
      See Also:

    • stepStatusAsString

      public final String stepStatusAsString()

      The status of the current step that an upgrade is on.

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

      Returns:
      The status of the current step that an upgrade is on.
      See Also:

    • upgradeName

      public final String upgradeName()

      A string that describes the update.

      Returns:
      A string that describes the update.

    • toBuilder

      public GetUpgradeStatusResponse.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<GetUpgradeStatusResponse.Builder,GetUpgradeStatusResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetUpgradeStatusResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

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