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

#include <DeleteFileShareRequest.h>

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

Public Member Functions

 DeleteFileShareRequest ()
 
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)
 
DeleteFileShareRequestWithFileShareARN (const Aws::String &value)
 
DeleteFileShareRequestWithFileShareARN (Aws::String &&value)
 
DeleteFileShareRequestWithFileShareARN (const char *value)
 
bool GetForceDelete () const
 
bool ForceDeleteHasBeenSet () const
 
void SetForceDelete (bool value)
 
DeleteFileShareRequestWithForceDelete (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

DeleteFileShareInput

See Also:

AWS API Reference

Definition at line 24 of file DeleteFileShareRequest.h.

Constructor & Destructor Documentation

◆ DeleteFileShareRequest()

Aws::StorageGateway::Model::DeleteFileShareRequest::DeleteFileShareRequest ( )

Member Function Documentation

◆ FileShareARNHasBeenSet()

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

The Amazon Resource Name (ARN) of the file share to be deleted.

Definition at line 48 of file DeleteFileShareRequest.h.

◆ ForceDeleteHasBeenSet()

bool Aws::StorageGateway::Model::DeleteFileShareRequest::ForceDeleteHasBeenSet ( ) const
inline

If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share is not deleted until all data is uploaded to Amazon Web Services. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

Valid Values: true | false

Definition at line 99 of file DeleteFileShareRequest.h.

◆ GetFileShareARN()

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

The Amazon Resource Name (ARN) of the file share to be deleted.

Definition at line 43 of file DeleteFileShareRequest.h.

◆ GetForceDelete()

bool Aws::StorageGateway::Model::DeleteFileShareRequest::GetForceDelete ( ) const
inline

If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share is not deleted until all data is uploaded to Amazon Web Services. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

Valid Values: true | false

Definition at line 89 of file DeleteFileShareRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DeleteFileShareRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFileShareARN() [1/3]

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

The Amazon Resource Name (ARN) of the file share to be deleted.

Definition at line 58 of file DeleteFileShareRequest.h.

◆ SetFileShareARN() [2/3]

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

The Amazon Resource Name (ARN) of the file share to be deleted.

Definition at line 53 of file DeleteFileShareRequest.h.

◆ SetFileShareARN() [3/3]

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

The Amazon Resource Name (ARN) of the file share to be deleted.

Definition at line 63 of file DeleteFileShareRequest.h.

◆ SetForceDelete()

void Aws::StorageGateway::Model::DeleteFileShareRequest::SetForceDelete ( bool  value)
inline

If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share is not deleted until all data is uploaded to Amazon Web Services. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

Valid Values: true | false

Definition at line 109 of file DeleteFileShareRequest.h.

◆ WithFileShareARN() [1/3]

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

The Amazon Resource Name (ARN) of the file share to be deleted.

Definition at line 73 of file DeleteFileShareRequest.h.

◆ WithFileShareARN() [2/3]

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

The Amazon Resource Name (ARN) of the file share to be deleted.

Definition at line 68 of file DeleteFileShareRequest.h.

◆ WithFileShareARN() [3/3]

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

The Amazon Resource Name (ARN) of the file share to be deleted.

Definition at line 78 of file DeleteFileShareRequest.h.

◆ WithForceDelete()

DeleteFileShareRequest& Aws::StorageGateway::Model::DeleteFileShareRequest::WithForceDelete ( bool  value)
inline

If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share is not deleted until all data is uploaded to Amazon Web Services. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

Valid Values: true | false

Definition at line 119 of file DeleteFileShareRequest.h.


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