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

#include <DetachVolumeRequest.h>

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

Public Member Functions

 DetachVolumeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetVolumeARN () const
 
bool VolumeARNHasBeenSet () const
 
void SetVolumeARN (const Aws::String &value)
 
void SetVolumeARN (Aws::String &&value)
 
void SetVolumeARN (const char *value)
 
DetachVolumeRequestWithVolumeARN (const Aws::String &value)
 
DetachVolumeRequestWithVolumeARN (Aws::String &&value)
 
DetachVolumeRequestWithVolumeARN (const char *value)
 
bool GetForceDetach () const
 
bool ForceDetachHasBeenSet () const
 
void SetForceDetach (bool value)
 
DetachVolumeRequestWithForceDetach (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

AttachVolumeInput

See Also:

AWS API Reference

Definition at line 24 of file DetachVolumeRequest.h.

Constructor & Destructor Documentation

◆ DetachVolumeRequest()

Aws::StorageGateway::Model::DetachVolumeRequest::DetachVolumeRequest ( )

Member Function Documentation

◆ ForceDetachHasBeenSet()

bool Aws::StorageGateway::Model::DetachVolumeRequest::ForceDetachHasBeenSet ( ) const
inline

Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

Valid Values: true | false

Definition at line 97 of file DetachVolumeRequest.h.

◆ GetForceDetach()

bool Aws::StorageGateway::Model::DetachVolumeRequest::GetForceDetach ( ) const
inline

Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

Valid Values: true | false

Definition at line 88 of file DetachVolumeRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DetachVolumeRequest.h.

◆ GetVolumeARN()

const Aws::String& Aws::StorageGateway::Model::DetachVolumeRequest::GetVolumeARN ( ) const
inline

The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Definition at line 43 of file DetachVolumeRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetForceDetach()

void Aws::StorageGateway::Model::DetachVolumeRequest::SetForceDetach ( bool  value)
inline

Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

Valid Values: true | false

Definition at line 106 of file DetachVolumeRequest.h.

◆ SetVolumeARN() [1/3]

void Aws::StorageGateway::Model::DetachVolumeRequest::SetVolumeARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Definition at line 58 of file DetachVolumeRequest.h.

◆ SetVolumeARN() [2/3]

void Aws::StorageGateway::Model::DetachVolumeRequest::SetVolumeARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Definition at line 53 of file DetachVolumeRequest.h.

◆ SetVolumeARN() [3/3]

void Aws::StorageGateway::Model::DetachVolumeRequest::SetVolumeARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Definition at line 63 of file DetachVolumeRequest.h.

◆ VolumeARNHasBeenSet()

bool Aws::StorageGateway::Model::DetachVolumeRequest::VolumeARNHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Definition at line 48 of file DetachVolumeRequest.h.

◆ WithForceDetach()

DetachVolumeRequest& Aws::StorageGateway::Model::DetachVolumeRequest::WithForceDetach ( bool  value)
inline

Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

Valid Values: true | false

Definition at line 115 of file DetachVolumeRequest.h.

◆ WithVolumeARN() [1/3]

DetachVolumeRequest& Aws::StorageGateway::Model::DetachVolumeRequest::WithVolumeARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Definition at line 73 of file DetachVolumeRequest.h.

◆ WithVolumeARN() [2/3]

DetachVolumeRequest& Aws::StorageGateway::Model::DetachVolumeRequest::WithVolumeARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Definition at line 68 of file DetachVolumeRequest.h.

◆ WithVolumeARN() [3/3]

DetachVolumeRequest& Aws::StorageGateway::Model::DetachVolumeRequest::WithVolumeARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Definition at line 78 of file DetachVolumeRequest.h.


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