Struct RefreshCacheInput 

#[non_exhaustive]
pub struct RefreshCacheInput {
    pub file_share_arn: Option<String>,
    pub folder_list: Option<Vec<String>>,
    pub recursive: Option<bool>,
}

RefreshCacheInput

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.

file_share_arn: Option<String>

The Amazon Resource Name (ARN) of the file share you want to refresh.

folder_list: Option<Vec<String>>

A comma-separated list of the paths of folders to refresh in the cache. The default is \["/"\]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that the file share has access to is refreshed.

Do not include / when specifying folder names. For example, you would specify samplefolder rather than samplefolder/.

recursive: Option<bool>

A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to true, each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is true.

Valid Values: true | false

Implementations

impl RefreshCacheInput

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

The Amazon Resource Name (ARN) of the file share you want to refresh.

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

A comma-separated list of the paths of folders to refresh in the cache. The default is \["/"\]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that the file share has access to is refreshed.

Do not include / when specifying folder names. For example, you would specify samplefolder rather than samplefolder/.

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

pub fn recursive(&self) -> Option<bool>

A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to true, each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is true.

Valid Values: true | false

impl RefreshCacheInput

pub fn builder() -> RefreshCacheInputBuilder

Creates a new builder-style object to manufacture RefreshCacheInput.

Trait Implementations

impl Clone for RefreshCacheInput

fn clone(&self) -> RefreshCacheInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefreshCacheInput

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

Formats the value using the given formatter.

impl PartialEq for RefreshCacheInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for RefreshCacheInput