AWS SDK for C++  1.9.107
AWS SDK for C++
Public Member Functions | List of all members
Aws::StorageGateway::Model::RefreshCacheRequest Class Reference

#include <RefreshCacheRequest.h>

+ Inheritance diagram for Aws::StorageGateway::Model::RefreshCacheRequest:

Public Member Functions

 RefreshCacheRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetFileShareARN () const
 
bool FileShareARNHasBeenSet () const
 
void SetFileShareARN (const Aws::String &value)
 
void SetFileShareARN (Aws::String &&value)
 
void SetFileShareARN (const char *value)
 
RefreshCacheRequestWithFileShareARN (const Aws::String &value)
 
RefreshCacheRequestWithFileShareARN (Aws::String &&value)
 
RefreshCacheRequestWithFileShareARN (const char *value)
 
const Aws::Vector< Aws::String > & GetFolderList () const
 
bool FolderListHasBeenSet () const
 
void SetFolderList (const Aws::Vector< Aws::String > &value)
 
void SetFolderList (Aws::Vector< Aws::String > &&value)
 
RefreshCacheRequestWithFolderList (const Aws::Vector< Aws::String > &value)
 
RefreshCacheRequestWithFolderList (Aws::Vector< Aws::String > &&value)
 
RefreshCacheRequestAddFolderList (const Aws::String &value)
 
RefreshCacheRequestAddFolderList (Aws::String &&value)
 
RefreshCacheRequestAddFolderList (const char *value)
 
bool GetRecursive () const
 
bool RecursiveHasBeenSet () const
 
void SetRecursive (bool value)
 
RefreshCacheRequestWithRecursive (bool value)
 
- Public Member Functions inherited from Aws::StorageGateway::StorageGatewayRequest
virtual ~StorageGatewayRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

RefreshCacheInput

See Also:

AWS API Reference

Definition at line 25 of file RefreshCacheRequest.h.

Constructor & Destructor Documentation

◆ RefreshCacheRequest()

Aws::StorageGateway::Model::RefreshCacheRequest::RefreshCacheRequest ( )

Member Function Documentation

◆ AddFolderList() [1/3]

RefreshCacheRequest& Aws::StorageGateway::Model::RefreshCacheRequest::AddFolderList ( Aws::String &&  value)
inline

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.

Definition at line 152 of file RefreshCacheRequest.h.

◆ AddFolderList() [2/3]

RefreshCacheRequest& Aws::StorageGateway::Model::RefreshCacheRequest::AddFolderList ( const Aws::String value)
inline

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.

Definition at line 143 of file RefreshCacheRequest.h.

◆ AddFolderList() [3/3]

RefreshCacheRequest& Aws::StorageGateway::Model::RefreshCacheRequest::AddFolderList ( const char *  value)
inline

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.

Definition at line 161 of file RefreshCacheRequest.h.

◆ FileShareARNHasBeenSet()

bool Aws::StorageGateway::Model::RefreshCacheRequest::FileShareARNHasBeenSet ( ) const
inline

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

Definition at line 49 of file RefreshCacheRequest.h.

◆ FolderListHasBeenSet()

bool Aws::StorageGateway::Model::RefreshCacheRequest::FolderListHasBeenSet ( ) const
inline

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.

Definition at line 98 of file RefreshCacheRequest.h.

◆ GetFileShareARN()

const Aws::String& Aws::StorageGateway::Model::RefreshCacheRequest::GetFileShareARN ( ) const
inline

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

Definition at line 44 of file RefreshCacheRequest.h.

◆ GetFolderList()

const Aws::Vector<Aws::String>& Aws::StorageGateway::Model::RefreshCacheRequest::GetFolderList ( ) const
inline

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.

Definition at line 89 of file RefreshCacheRequest.h.

◆ GetRecursive()

bool Aws::StorageGateway::Model::RefreshCacheRequest::GetRecursive ( ) const
inline

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

Definition at line 174 of file RefreshCacheRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::StorageGateway::Model::RefreshCacheRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::StorageGateway::Model::RefreshCacheRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file RefreshCacheRequest.h.

◆ RecursiveHasBeenSet()

bool Aws::StorageGateway::Model::RefreshCacheRequest::RecursiveHasBeenSet ( ) const
inline

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

Definition at line 186 of file RefreshCacheRequest.h.

◆ SerializePayload()

Aws::String Aws::StorageGateway::Model::RefreshCacheRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFileShareARN() [1/3]

void Aws::StorageGateway::Model::RefreshCacheRequest::SetFileShareARN ( Aws::String &&  value)
inline

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

Definition at line 59 of file RefreshCacheRequest.h.

◆ SetFileShareARN() [2/3]

void Aws::StorageGateway::Model::RefreshCacheRequest::SetFileShareARN ( const Aws::String value)
inline

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

Definition at line 54 of file RefreshCacheRequest.h.

◆ SetFileShareARN() [3/3]

void Aws::StorageGateway::Model::RefreshCacheRequest::SetFileShareARN ( const char *  value)
inline

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

Definition at line 64 of file RefreshCacheRequest.h.

◆ SetFolderList() [1/2]

void Aws::StorageGateway::Model::RefreshCacheRequest::SetFolderList ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 116 of file RefreshCacheRequest.h.

◆ SetFolderList() [2/2]

void Aws::StorageGateway::Model::RefreshCacheRequest::SetFolderList ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 107 of file RefreshCacheRequest.h.

◆ SetRecursive()

void Aws::StorageGateway::Model::RefreshCacheRequest::SetRecursive ( bool  value)
inline

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

Definition at line 198 of file RefreshCacheRequest.h.

◆ WithFileShareARN() [1/3]

RefreshCacheRequest& Aws::StorageGateway::Model::RefreshCacheRequest::WithFileShareARN ( Aws::String &&  value)
inline

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

Definition at line 74 of file RefreshCacheRequest.h.

◆ WithFileShareARN() [2/3]

RefreshCacheRequest& Aws::StorageGateway::Model::RefreshCacheRequest::WithFileShareARN ( const Aws::String value)
inline

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

Definition at line 69 of file RefreshCacheRequest.h.

◆ WithFileShareARN() [3/3]

RefreshCacheRequest& Aws::StorageGateway::Model::RefreshCacheRequest::WithFileShareARN ( const char *  value)
inline

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

Definition at line 79 of file RefreshCacheRequest.h.

◆ WithFolderList() [1/2]

RefreshCacheRequest& Aws::StorageGateway::Model::RefreshCacheRequest::WithFolderList ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 134 of file RefreshCacheRequest.h.

◆ WithFolderList() [2/2]

RefreshCacheRequest& Aws::StorageGateway::Model::RefreshCacheRequest::WithFolderList ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 125 of file RefreshCacheRequest.h.

◆ WithRecursive()

RefreshCacheRequest& Aws::StorageGateway::Model::RefreshCacheRequest::WithRecursive ( bool  value)
inline

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

Definition at line 210 of file RefreshCacheRequest.h.


The documentation for this class was generated from the following file: