Struct aws_sdk_storagegateway::operation::refresh_cache::builders::RefreshCacheFluentBuilder
source · pub struct RefreshCacheFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to RefreshCache
.
Refreshes the cached inventory of objects for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation does not import files into the S3 File Gateway cache storage. It only updates the cached inventory to reflect changes in the inventory of the objects in the S3 bucket. This operation is only supported in the S3 File Gateway types.
You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache
operation completes. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through a CloudWatch event when your RefreshCache
operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.
-
Wait at least 60 seconds between consecutive RefreshCache API requests.
-
If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an
InvalidGatewayRequestException
error because too many requests were sent to the server.
The S3 bucket name does not need to be included when entering the list of folders in the FolderList parameter.
For more information, see Getting notified about file operations in the Amazon S3 File Gateway User Guide.
Implementations§
source§impl RefreshCacheFluentBuilder
impl RefreshCacheFluentBuilder
sourcepub fn as_input(&self) -> &RefreshCacheInputBuilder
pub fn as_input(&self) -> &RefreshCacheInputBuilder
Access the RefreshCache as a reference.
sourcepub async fn send(
self
) -> Result<RefreshCacheOutput, SdkError<RefreshCacheError, HttpResponse>>
pub async fn send( self ) -> Result<RefreshCacheOutput, SdkError<RefreshCacheError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<RefreshCacheOutput, RefreshCacheError, Self>
pub fn customize( self ) -> CustomizableOperation<RefreshCacheOutput, RefreshCacheError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
The Amazon Resource Name (ARN) of the file share you want to refresh.
The Amazon Resource Name (ARN) of the file share you want to refresh.
The Amazon Resource Name (ARN) of the file share you want to refresh.
sourcepub fn folder_list(self, input: impl Into<String>) -> Self
pub fn folder_list(self, input: impl Into<String>) -> Self
Appends an item to FolderList
.
To override the contents of this collection use set_folder_list
.
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.
sourcepub fn set_folder_list(self, input: Option<Vec<String>>) -> Self
pub fn set_folder_list(self, input: Option<Vec<String>>) -> Self
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.
sourcepub fn get_folder_list(&self) -> &Option<Vec<String>>
pub fn get_folder_list(&self) -> &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.
sourcepub fn recursive(self, input: bool) -> Self
pub fn recursive(self, input: bool) -> Self
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
sourcepub fn set_recursive(self, input: Option<bool>) -> Self
pub fn set_recursive(self, input: Option<bool>) -> Self
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
sourcepub fn get_recursive(&self) -> &Option<bool>
pub fn get_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
Trait Implementations§
source§impl Clone for RefreshCacheFluentBuilder
impl Clone for RefreshCacheFluentBuilder
source§fn clone(&self) -> RefreshCacheFluentBuilder
fn clone(&self) -> RefreshCacheFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for RefreshCacheFluentBuilder
impl !RefUnwindSafe for RefreshCacheFluentBuilder
impl Send for RefreshCacheFluentBuilder
impl Sync for RefreshCacheFluentBuilder
impl Unpin for RefreshCacheFluentBuilder
impl !UnwindSafe for RefreshCacheFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more