software.amazon.awssdk.services.storagegateway.model

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(value="software.amazon.awssdk:codegen")
public final class DescribeCacheResponse
extends StorageGatewayResponse
implements ToCopyableBuilder<DescribeCacheResponse.Builder,DescribeCacheResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeCacheResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeCacheResponse.Builder	builder()
Long	cacheAllocatedInBytes() The amount of cache in bytes allocated to a gateway.
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.
Double	cacheHitPercentage() Percent of application read operations from the file shares that are served from cache.
Double	cacheMissPercentage() Percent of application read operations from the file shares that are not served from cache.
Double	cacheUsedPercentage() Percent use of the gateway's cache storage.
List<String>	diskIds() An array of strings that identify disks that are to be configured as working storage.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gatewayARN() Returns the value of the GatewayARN property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDiskIds() For responses, this returns true if the service returned a value for the DiskIds property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCacheResponse.Builder>	serializableBuilderClass()
DescribeCacheResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCacheResponse.Builder,DescribeCacheResponse>

Overrides:

toBuilder in class AwsResponse

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo