Package software.amazon.awssdk.services.storagegateway.model

Interface RefreshCacheRequest.Builder

    • Method Detail

      • fileShareARN

        RefreshCacheRequest.Builder fileShareARN​(String fileShareARN)

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

        Parameters:
        fileShareARN - The Amazon Resource Name (ARN) of the file share you want to refresh.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • folderList

        RefreshCacheRequest.Builder folderList​(Collection<String> folderList)

        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/.

        Parameters:
        folderList - 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/.

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

      • folderList

        RefreshCacheRequest.Builder folderList​(String... folderList)

        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/.

        Parameters:
        folderList - 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/.

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

      • recursive

        RefreshCacheRequest.Builder recursive​(Boolean recursive)

        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

        Parameters:
        recursive - 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

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