Struct aws_sdk_storagegateway::operation::describe_cache::DescribeCacheOutput

#[non_exhaustive]
pub struct DescribeCacheOutput {
    pub gateway_arn: Option<String>,
    pub disk_ids: Option<Vec<String>>,
    pub cache_allocated_in_bytes: i64,
    pub cache_used_percentage: f64,
    pub cache_dirty_percentage: f64,
    pub cache_hit_percentage: f64,
    pub cache_miss_percentage: f64,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

gateway_arn: Option<String>

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

disk_ids: Option<Vec<String>>

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.

cache_allocated_in_bytes: i64

The amount of cache in bytes allocated to a gateway.

cache_used_percentage: f64

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.

cache_dirty_percentage: f64

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.

cache_hit_percentage: f64

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.

cache_miss_percentage: f64

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.

Implementations

impl DescribeCacheOutput

pub fn gateway_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

pub fn disk_ids(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .disk_ids.is_none().

pub fn cache_allocated_in_bytes(&self) -> i64

The amount of cache in bytes allocated to a gateway.

pub fn cache_used_percentage(&self) -> f64

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.

pub fn cache_dirty_percentage(&self) -> f64

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.

pub fn cache_hit_percentage(&self) -> f64

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.

pub fn cache_miss_percentage(&self) -> f64

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.

impl DescribeCacheOutput

pub fn builder() -> DescribeCacheOutputBuilder

Creates a new builder-style object to manufacture DescribeCacheOutput.

Trait Implementations

impl Clone for DescribeCacheOutput

fn clone(&self) -> DescribeCacheOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeCacheOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeCacheOutput

fn eq(&self, other: &DescribeCacheOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeCacheOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeCacheOutput