Class ServiceSoftwareOptions

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

The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

See Also:

  • Method Details

    • currentVersion

      public final String currentVersion()

      The current service software version present on the domain.

      Returns:
      The current service software version present on the domain.

    • newVersion

      public final String newVersion()

      The new service software version, if one is available.

      Returns:
      The new service software version, if one is available.

    • updateAvailable

      public final Boolean updateAvailable()

      True if you're able to update your service software version. False if you can't update your service software version.

      Returns:
      True if you're able to update your service software version. False if you can't update your service software version.

    • cancellable

      public final Boolean cancellable()

      True if you're able to cancel your service software version update. False if you can't cancel your service software update.

      Returns:
      True if you're able to cancel your service software version update. False if you can't cancel your service software update.

    • updateStatus

      public final DeploymentStatus updateStatus()

      The status of your service software update.

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

      Returns:
      The status of your service software update.
      See Also:

    • updateStatusAsString

      public final String updateStatusAsString()

      The status of your service software update.

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

      Returns:
      The status of your service software update.
      See Also:

    • description

      public final String description()

      A description of the service software update status.

      Returns:
      A description of the service software update status.

    • automatedUpdateDate

      public final Instant automatedUpdateDate()

      The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

      Returns:
      The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

    • optionalDeployment

      public final Boolean optionalDeployment()

      True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

      Returns:
      True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

    • toBuilder

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

    • builder

      public static ServiceSoftwareOptions.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ServiceSoftwareOptions.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.