Package software.amazon.awssdk.services.opensearch.model

Class UpgradeDomainResponse

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.UpgradeDomainResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpgradeDomainResponse.Builder,UpgradeDomainResponse>
@Generated("software.amazon.awssdk:codegen") public final class UpgradeDomainResponse extends OpenSearchResponse implements ToCopyableBuilder<UpgradeDomainResponse.Builder,UpgradeDomainResponse>

Container for the response returned by UpgradeDomain operation.

  • Method Details

    • upgradeId

      public final String upgradeId()

      The unique identifier of the domain upgrade.

      Returns:
      The unique identifier of the domain upgrade.

    • domainName

      public final String domainName()

      The name of the domain that was upgraded.

      Returns:
      The name of the domain that was upgraded.

    • targetVersion

      public final String targetVersion()

      OpenSearch or Elasticsearch version that the domain was upgraded to.

      Returns:
      OpenSearch or Elasticsearch version that the domain was upgraded to.

    • performCheckOnly

      public final Boolean performCheckOnly()

      When true, indicates that an upgrade eligibility check was performed.

      Returns:
      When true, indicates that an upgrade eligibility check was performed.

    • hasAdvancedOptions

      public final boolean hasAdvancedOptions()
      For responses, this returns true if the service returned a value for the AdvancedOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • advancedOptions

      public final Map<String,String> advancedOptions()

      The advanced options configuration for the domain.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdvancedOptions() method.

      Returns:
      The advanced options configuration for the domain.

    • changeProgressDetails

      public final ChangeProgressDetails changeProgressDetails()

      Container for information about a configuration change happening on a domain.

      Returns:
      Container for information about a configuration change happening on a domain.

    • toBuilder

      public UpgradeDomainResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpgradeDomainResponse.Builder,UpgradeDomainResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static UpgradeDomainResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpgradeDomainResponse.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)
      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 SdkResponse

    • 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