Class DescribeCacheResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse
software.amazon.awssdk.services.storagegateway.model.DescribeCacheResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeCacheResponse.Builder,DescribeCacheResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeCacheResponse extends StorageGatewayResponse implements ToCopyableBuilder<DescribeCacheResponse.Builder,DescribeCacheResponse>

  • Method Details

    • gatewayARN

      public final String gatewayARN()
      Returns the value of the GatewayARN property for this object.
      Returns:
      The value of the GatewayARN property for this object.

    • hasDiskIds

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

    • diskIds

      public final List<String> diskIds()

      An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

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

      Returns:
      An array of strings that identify disks that are to be configured as working storage. Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

    • cacheAllocatedInBytes

      public final Long cacheAllocatedInBytes()

      The amount of cache in bytes allocated to a gateway.

      Returns:
      The amount of cache in bytes allocated to a gateway.

    • cacheUsedPercentage

      public final Double cacheUsedPercentage()

      Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.

      Returns:
      Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.

    • cacheDirtyPercentage

      public final Double cacheDirtyPercentage()

      The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to Amazon Web Services. The sample is taken at the end of the reporting period.

      Returns:
      The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to Amazon Web Services. The sample is taken at the end of the reporting period.

    • cacheHitPercentage

      public final Double cacheHitPercentage()

      Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.

      Returns:
      Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.

    • cacheMissPercentage

      public final Double cacheMissPercentage()

      Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.

      Returns:
      Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.

    • toBuilder

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

    • builder

      public static DescribeCacheResponse.Builder builder()

    • serializableBuilderClass

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