Package software.amazon.awssdk.services.elasticache.model

Class DescribeUpdateActionsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest
software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeUpdateActionsRequest.Builder,DescribeUpdateActionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeUpdateActionsRequest extends ElastiCacheRequest implements ToCopyableBuilder<DescribeUpdateActionsRequest.Builder,DescribeUpdateActionsRequest>

  • Method Details

    • serviceUpdateName

      public final String serviceUpdateName()

      The unique ID of the service update

      Returns:
      The unique ID of the service update

    • hasReplicationGroupIds

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

    • replicationGroupIds

      public final List<String> replicationGroupIds()

      The replication group IDs

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

      Returns:
      The replication group IDs

    • hasCacheClusterIds

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

    • cacheClusterIds

      public final List<String> cacheClusterIds()

      The cache cluster IDs

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

      Returns:
      The cache cluster IDs

    • engine

      public final String engine()

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

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

    • serviceUpdateStatus

      public final List<ServiceUpdateStatus> serviceUpdateStatus()

      The status of the service update

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

      Returns:
      The status of the service update

    • hasServiceUpdateStatus

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

    • serviceUpdateStatusAsStrings

      public final List<String> serviceUpdateStatusAsStrings()

      The status of the service update

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

      Returns:
      The status of the service update

    • serviceUpdateTimeRange

      public final TimeRangeFilter serviceUpdateTimeRange()

      The range of time specified to search for service updates that are in available status

      Returns:
      The range of time specified to search for service updates that are in available status

    • updateActionStatus

      public final List<UpdateActionStatus> updateActionStatus()

      The status of the update action.

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

      Returns:
      The status of the update action.

    • hasUpdateActionStatus

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

    • updateActionStatusAsStrings

      public final List<String> updateActionStatusAsStrings()

      The status of the update action.

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

      Returns:
      The status of the update action.

    • showNodeLevelUpdateStatus

      public final Boolean showNodeLevelUpdateStatus()

      Dictates whether to include node level update status in the response

      Returns:
      Dictates whether to include node level update status in the response

    • maxRecords

      public final Integer maxRecords()

      The maximum number of records to include in the response

      Returns:
      The maximum number of records to include in the response

    • marker

      public final String marker()

      An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      Returns:
      An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • toBuilder

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

    • builder

      public static DescribeUpdateActionsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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