Package software.amazon.awssdk.services.elasticsearch.model

Class UpgradeStepItem

java.lang.Object
software.amazon.awssdk.services.elasticsearch.model.UpgradeStepItem
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UpgradeStepItem.Builder,UpgradeStepItem>
@Generated("software.amazon.awssdk:codegen") public final class UpgradeStepItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UpgradeStepItem.Builder,UpgradeStepItem>

Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.

See Also:

  • Method Details

    • upgradeStep

      public final UpgradeStep upgradeStep()

      Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

      • PreUpgradeCheck
      • Snapshot
      • Upgrade

      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:
      Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
      • PreUpgradeCheck
      • Snapshot
      • Upgrade
      See Also:

    • upgradeStepAsString

      public final String upgradeStepAsString()

      Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

      • PreUpgradeCheck
      • Snapshot
      • Upgrade

      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:
      Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
      • PreUpgradeCheck
      • Snapshot
      • Upgrade
      See Also:

    • upgradeStepStatus

      public final UpgradeStatus upgradeStepStatus()

      The status of a particular step during an upgrade. The status can take one of the following values:

      • In Progress
      • Succeeded
      • Succeeded with Issues
      • Failed

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

      Returns:
      The status of a particular step during an upgrade. The status can take one of the following values:
      • In Progress
      • Succeeded
      • Succeeded with Issues
      • Failed
      See Also:

    • upgradeStepStatusAsString

      public final String upgradeStepStatusAsString()

      The status of a particular step during an upgrade. The status can take one of the following values:

      • In Progress
      • Succeeded
      • Succeeded with Issues
      • Failed

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

      Returns:
      The status of a particular step during an upgrade. The status can take one of the following values:
      • In Progress
      • Succeeded
      • Succeeded with Issues
      • Failed
      See Also:

    • hasIssues

      public final boolean hasIssues()
      For responses, this returns true if the service returned a value for the Issues 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.

    • issues

      public final List<String> issues()

      A list of strings containing detailed information about the errors encountered in a particular step.

      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 hasIssues() method.

      Returns:
      A list of strings containing detailed information about the errors encountered in a particular step.

    • progressPercent

      public final Double progressPercent()

      The Floating point value representing progress percentage of a particular step.

      Returns:
      The Floating point value representing progress percentage of a particular step.

    • toBuilder

      public UpgradeStepItem.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<UpgradeStepItem.Builder,UpgradeStepItem>
      Returns:
      a builder for type T

    • builder

      public static UpgradeStepItem.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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