Class UpdateAction

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

The status of the service update for a specific replication group

See Also:

  • Method Details

    • replicationGroupId

      public final String replicationGroupId()

      The ID of the replication group

      Returns:
      The ID of the replication group

    • cacheClusterId

      public final String cacheClusterId()

      The ID of the cache cluster

      Returns:
      The ID of the cache cluster

    • serviceUpdateName

      public final String serviceUpdateName()

      The unique ID of the service update

      Returns:
      The unique ID of the service update

    • serviceUpdateReleaseDate

      public final Instant serviceUpdateReleaseDate()

      The date the update is first available

      Returns:
      The date the update is first available

    • serviceUpdateSeverity

      public final ServiceUpdateSeverity serviceUpdateSeverity()

      The severity of the service update

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

      Returns:
      The severity of the service update
      See Also:

    • serviceUpdateSeverityAsString

      public final String serviceUpdateSeverityAsString()

      The severity of the service update

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

      Returns:
      The severity of the service update
      See Also:

    • serviceUpdateStatus

      public final ServiceUpdateStatus serviceUpdateStatus()

      The status of the service update

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

      Returns:
      The status of the service update
      See Also:

    • serviceUpdateStatusAsString

      public final String serviceUpdateStatusAsString()

      The status of the service update

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

      Returns:
      The status of the service update
      See Also:

    • serviceUpdateRecommendedApplyByDate

      public final Instant serviceUpdateRecommendedApplyByDate()

      The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

      Returns:
      The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

    • serviceUpdateType

      public final ServiceUpdateType serviceUpdateType()

      Reflects the nature of the service update

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

      Returns:
      Reflects the nature of the service update
      See Also:

    • serviceUpdateTypeAsString

      public final String serviceUpdateTypeAsString()

      Reflects the nature of the service update

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

      Returns:
      Reflects the nature of the service update
      See Also:

    • updateActionAvailableDate

      public final Instant updateActionAvailableDate()

      The date that the service update is available to a replication group

      Returns:
      The date that the service update is available to a replication group

    • updateActionStatus

      public final UpdateActionStatus updateActionStatus()

      The status of the update action

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

      Returns:
      The status of the update action
      See Also:

    • updateActionStatusAsString

      public final String updateActionStatusAsString()

      The status of the update action

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

      Returns:
      The status of the update action
      See Also:

    • nodesUpdated

      public final String nodesUpdated()

      The progress of the service update on the replication group

      Returns:
      The progress of the service update on the replication group

    • updateActionStatusModifiedDate

      public final Instant updateActionStatusModifiedDate()

      The date when the UpdateActionStatus was last modified

      Returns:
      The date when the UpdateActionStatus was last modified

    • slaMet

      public final SlaMet slaMet()

      If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.

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

      Returns:
      If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.
      See Also:

    • slaMetAsString

      public final String slaMetAsString()

      If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.

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

      Returns:
      If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.
      See Also:

    • hasNodeGroupUpdateStatus

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

    • nodeGroupUpdateStatus

      public final List<NodeGroupUpdateStatus> nodeGroupUpdateStatus()

      The status of the service update on the node group

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

      Returns:
      The status of the service update on the node group

    • hasCacheNodeUpdateStatus

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

    • cacheNodeUpdateStatus

      public final List<CacheNodeUpdateStatus> cacheNodeUpdateStatus()

      The status of the service update on the cache node

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

      Returns:
      The status of the service update on the cache node

    • estimatedUpdateTime

      public final String estimatedUpdateTime()

      The estimated length of time for the update to complete

      Returns:
      The estimated length of time for the update to complete

    • engine

      public final String engine()

      The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

      Returns:
      The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

    • toBuilder

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

    • builder

      public static UpdateAction.Builder builder()

    • serializableBuilderClass

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