com.amazonaws.services.storagegateway.model
Class DescribeCacheResult

java.lang.Object
  com.amazonaws.services.storagegateway.model.DescribeCacheResult

All Implemented Interfaces:

Serializable

public class DescribeCacheResult
extends Object
implements Serializable

A JSON object containing the following fields:

• DescribeCacheOutput$CacheAllocatedInBytes
• DescribeCacheOutput$CacheDirtyPercentage
• DescribeCacheOutput$CacheHitPercentage
• DescribeCacheOutput$CacheMissPercentage
• DescribeCacheOutput$CacheUsedPercentage
• DescribeCacheOutput$DiskIds
• DescribeCacheOutput$GatewayARN

See Also:

Serialized Form

Constructor Summary

DescribeCacheResult()

Method Summary

boolean	equals(Object obj)
Long	getCacheAllocatedInBytes() The size allocated, in bytes, for the cache.
Double	getCacheDirtyPercentage() The percentage of the cache that contains data that has not yet been persisted to Amazon S3.
Double	getCacheHitPercentage() The percentage (0 to 100) of data read from the storage volume that was read from cache.
Double	getCacheMissPercentage() TThe percentage (0 to 100) of data read from the storage volume that was not read from the cache, but was read from Amazon S3.
Double	getCacheUsedPercentage() The percentage (0 to 100) of the cache storage in use.
List<String>	getDiskIds() An array of the gateway's local disk IDs that are configured as cache.
String	getGatewayARN() In response, AWS Storage Gateway returns the ARN of the activated gateway.
int	hashCode()
void	setCacheAllocatedInBytes(Long cacheAllocatedInBytes) The size allocated, in bytes, for the cache.
void	setCacheDirtyPercentage(Double cacheDirtyPercentage) The percentage of the cache that contains data that has not yet been persisted to Amazon S3.
void	setCacheHitPercentage(Double cacheHitPercentage) The percentage (0 to 100) of data read from the storage volume that was read from cache.
void	setCacheMissPercentage(Double cacheMissPercentage) TThe percentage (0 to 100) of data read from the storage volume that was not read from the cache, but was read from Amazon S3.
void	setCacheUsedPercentage(Double cacheUsedPercentage) The percentage (0 to 100) of the cache storage in use.
void	setDiskIds(Collection<String> diskIds) An array of the gateway's local disk IDs that are configured as cache.
void	setGatewayARN(String gatewayARN) In response, AWS Storage Gateway returns the ARN of the activated gateway.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeCacheResult	withCacheAllocatedInBytes(Long cacheAllocatedInBytes) The size allocated, in bytes, for the cache.
DescribeCacheResult	withCacheDirtyPercentage(Double cacheDirtyPercentage) The percentage of the cache that contains data that has not yet been persisted to Amazon S3.
DescribeCacheResult	withCacheHitPercentage(Double cacheHitPercentage) The percentage (0 to 100) of data read from the storage volume that was read from cache.
DescribeCacheResult	withCacheMissPercentage(Double cacheMissPercentage) TThe percentage (0 to 100) of data read from the storage volume that was not read from the cache, but was read from Amazon S3.
DescribeCacheResult	withCacheUsedPercentage(Double cacheUsedPercentage) The percentage (0 to 100) of the cache storage in use.
DescribeCacheResult	withDiskIds(Collection<String> diskIds) An array of the gateway's local disk IDs that are configured as cache.
DescribeCacheResult	withDiskIds(String... diskIds) An array of the gateway's local disk IDs that are configured as cache.
DescribeCacheResult	withGatewayARN(String gatewayARN) In response, AWS Storage Gateway returns the ARN of the activated gateway.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeCacheResult

public DescribeCacheResult()

Method Detail

getGatewayARN

public String getGatewayARN()

In response, AWS Storage Gateway returns the ARN of the activated gateway. If you don't remember the ARN of a gateway, you can use the List Gateways operations to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Returns:

In response, AWS Storage Gateway returns the ARN of the activated gateway. If you don't remember the ARN of a gateway, you can use the List Gateways operations to return a list of gateways for your account and region.

setGatewayARN

public void setGatewayARN(String gatewayARN)

In response, AWS Storage Gateway returns the ARN of the activated gateway. If you don't remember the ARN of a gateway, you can use the List Gateways operations to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Parameters:

gatewayARN - In response, AWS Storage Gateway returns the ARN of the activated gateway. If you don't remember the ARN of a gateway, you can use the List Gateways operations to return a list of gateways for your account and region.

withGatewayARN

public DescribeCacheResult withGatewayARN(String gatewayARN)

In response, AWS Storage Gateway returns the ARN of the activated gateway. If you don't remember the ARN of a gateway, you can use the List Gateways operations to return a list of gateways for your account and region.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 50 - 500

Parameters:

gatewayARN - In response, AWS Storage Gateway returns the ARN of the activated gateway. If you don't remember the ARN of a gateway, you can use the List Gateways operations to return a list of gateways for your account and region.

Returns:

A reference to this updated object so that method calls can be chained together.

getDiskIds

public List<String> getDiskIds()

An array of the gateway's local disk IDs that are configured as cache. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as cache, then the DiskIds array is empty.

Returns:

An array of the gateway's local disk IDs that are configured as cache. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as cache, then the DiskIds array is empty.

setDiskIds

public void setDiskIds(Collection<String> diskIds)

An array of the gateway's local disk IDs that are configured as cache. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as cache, then the DiskIds array is empty.

Parameters:

diskIds - An array of the gateway's local disk IDs that are configured as cache. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as cache, then the DiskIds array is empty.

withDiskIds

public DescribeCacheResult withDiskIds(String... diskIds)

An array of the gateway's local disk IDs that are configured as cache. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as cache, then the DiskIds array is empty.

Returns a reference to this object so that method calls can be chained together.

Parameters:

diskIds - An array of the gateway's local disk IDs that are configured as cache. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as cache, then the DiskIds array is empty.

Returns:

A reference to this updated object so that method calls can be chained together.

withDiskIds

public DescribeCacheResult withDiskIds(Collection<String> diskIds)

An array of the gateway's local disk IDs that are configured as cache. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as cache, then the DiskIds array is empty.

Returns a reference to this object so that method calls can be chained together.

Parameters:

diskIds - An array of the gateway's local disk IDs that are configured as cache. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as cache, then the DiskIds array is empty.

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheAllocatedInBytes

public Long getCacheAllocatedInBytes()

The size allocated, in bytes, for the cache. If no cache is defined for the gateway, this field returns 0.

Returns:

The size allocated, in bytes, for the cache. If no cache is defined for the gateway, this field returns 0.

setCacheAllocatedInBytes

public void setCacheAllocatedInBytes(Long cacheAllocatedInBytes)

The size allocated, in bytes, for the cache. If no cache is defined for the gateway, this field returns 0.

Parameters:

cacheAllocatedInBytes - The size allocated, in bytes, for the cache. If no cache is defined for the gateway, this field returns 0.

withCacheAllocatedInBytes

public DescribeCacheResult withCacheAllocatedInBytes(Long cacheAllocatedInBytes)

The size allocated, in bytes, for the cache. If no cache is defined for the gateway, this field returns 0.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheAllocatedInBytes - The size allocated, in bytes, for the cache. If no cache is defined for the gateway, this field returns 0.

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheUsedPercentage

public Double getCacheUsedPercentage()

The percentage (0 to 100) of the cache storage in use. If no cached is defined for the gateway, this field returns 0.

Returns:

The percentage (0 to 100) of the cache storage in use. If no cached is defined for the gateway, this field returns 0.

setCacheUsedPercentage

public void setCacheUsedPercentage(Double cacheUsedPercentage)

The percentage (0 to 100) of the cache storage in use. If no cached is defined for the gateway, this field returns 0.

Parameters:

cacheUsedPercentage - The percentage (0 to 100) of the cache storage in use. If no cached is defined for the gateway, this field returns 0.

withCacheUsedPercentage

public DescribeCacheResult withCacheUsedPercentage(Double cacheUsedPercentage)

The percentage (0 to 100) of the cache storage in use. If no cached is defined for the gateway, this field returns 0.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheUsedPercentage - The percentage (0 to 100) of the cache storage in use. If no cached is defined for the gateway, this field returns 0.

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheDirtyPercentage

public Double getCacheDirtyPercentage()

The percentage of the cache that contains data that has not yet been persisted to Amazon S3. If no cached is defined for the gateway, this field returns 0.

Returns:

The percentage of the cache that contains data that has not yet been persisted to Amazon S3. If no cached is defined for the gateway, this field returns 0.

setCacheDirtyPercentage

public void setCacheDirtyPercentage(Double cacheDirtyPercentage)

The percentage of the cache that contains data that has not yet been persisted to Amazon S3. If no cached is defined for the gateway, this field returns 0.

Parameters:

cacheDirtyPercentage - The percentage of the cache that contains data that has not yet been persisted to Amazon S3. If no cached is defined for the gateway, this field returns 0.

withCacheDirtyPercentage

public DescribeCacheResult withCacheDirtyPercentage(Double cacheDirtyPercentage)

The percentage of the cache that contains data that has not yet been persisted to Amazon S3. If no cached is defined for the gateway, this field returns 0.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheDirtyPercentage - The percentage of the cache that contains data that has not yet been persisted to Amazon S3. If no cached is defined for the gateway, this field returns 0.

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheHitPercentage

public Double getCacheHitPercentage()

The percentage (0 to 100) of data read from the storage volume that was read from cache. If no cached is defined for the gateway, this field returns 0.

Returns:

The percentage (0 to 100) of data read from the storage volume that was read from cache. If no cached is defined for the gateway, this field returns 0.

setCacheHitPercentage

public void setCacheHitPercentage(Double cacheHitPercentage)

The percentage (0 to 100) of data read from the storage volume that was read from cache. If no cached is defined for the gateway, this field returns 0.

Parameters:

cacheHitPercentage - The percentage (0 to 100) of data read from the storage volume that was read from cache. If no cached is defined for the gateway, this field returns 0.

withCacheHitPercentage

public DescribeCacheResult withCacheHitPercentage(Double cacheHitPercentage)

The percentage (0 to 100) of data read from the storage volume that was read from cache. If no cached is defined for the gateway, this field returns 0.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheHitPercentage - The percentage (0 to 100) of data read from the storage volume that was read from cache. If no cached is defined for the gateway, this field returns 0.

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheMissPercentage

public Double getCacheMissPercentage()

TThe percentage (0 to 100) of data read from the storage volume that was not read from the cache, but was read from Amazon S3. If no cached is defined for the gateway, this field returns 0.

Returns:

TThe percentage (0 to 100) of data read from the storage volume that was not read from the cache, but was read from Amazon S3. If no cached is defined for the gateway, this field returns 0.

setCacheMissPercentage

public void setCacheMissPercentage(Double cacheMissPercentage)

TThe percentage (0 to 100) of data read from the storage volume that was not read from the cache, but was read from Amazon S3. If no cached is defined for the gateway, this field returns 0.

Parameters:

cacheMissPercentage - TThe percentage (0 to 100) of data read from the storage volume that was not read from the cache, but was read from Amazon S3. If no cached is defined for the gateway, this field returns 0.

withCacheMissPercentage

public DescribeCacheResult withCacheMissPercentage(Double cacheMissPercentage)

TThe percentage (0 to 100) of data read from the storage volume that was not read from the cache, but was read from Amazon S3. If no cached is defined for the gateway, this field returns 0.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheMissPercentage - TThe percentage (0 to 100) of data read from the storage volume that was not read from the cache, but was read from Amazon S3. If no cached is defined for the gateway, this field returns 0.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object