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

#include <CreateSnapshotRequest.h>

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

Public Member Functions

 CreateSnapshotRequest ()
 
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)
 
CreateSnapshotRequestWithVolumeARN (const Aws::String &value)
 
CreateSnapshotRequestWithVolumeARN (Aws::String &&value)
 
CreateSnapshotRequestWithVolumeARN (const char *value)
 
const Aws::StringGetSnapshotDescription () const
 
bool SnapshotDescriptionHasBeenSet () const
 
void SetSnapshotDescription (const Aws::String &value)
 
void SetSnapshotDescription (Aws::String &&value)
 
void SetSnapshotDescription (const char *value)
 
CreateSnapshotRequestWithSnapshotDescription (const Aws::String &value)
 
CreateSnapshotRequestWithSnapshotDescription (Aws::String &&value)
 
CreateSnapshotRequestWithSnapshotDescription (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateSnapshotRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateSnapshotRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateSnapshotRequestAddTags (const Tag &value)
 
CreateSnapshotRequestAddTags (Tag &&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

A JSON object containing one or more of the following fields:

See Also:

AWS API Reference

Definition at line 28 of file CreateSnapshotRequest.h.

Constructor & Destructor Documentation

◆ CreateSnapshotRequest()

Aws::StorageGateway::Model::CreateSnapshotRequest::CreateSnapshotRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateSnapshotRequest& Aws::StorageGateway::Model::CreateSnapshotRequest::AddTags ( const Tag value)
inline

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 211 of file CreateSnapshotRequest.h.

◆ AddTags() [2/2]

CreateSnapshotRequest& Aws::StorageGateway::Model::CreateSnapshotRequest::AddTags ( Tag &&  value)
inline

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 220 of file CreateSnapshotRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file CreateSnapshotRequest.h.

◆ GetSnapshotDescription()

const Aws::String& Aws::StorageGateway::Model::CreateSnapshotRequest::GetSnapshotDescription ( ) const
inline

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Definition at line 98 of file CreateSnapshotRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::StorageGateway::Model::CreateSnapshotRequest::GetTags ( ) const
inline

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 157 of file CreateSnapshotRequest.h.

◆ GetVolumeARN()

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

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Definition at line 48 of file CreateSnapshotRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetSnapshotDescription() [1/3]

void Aws::StorageGateway::Model::CreateSnapshotRequest::SetSnapshotDescription ( const Aws::String value)
inline

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Definition at line 112 of file CreateSnapshotRequest.h.

◆ SetSnapshotDescription() [2/3]

void Aws::StorageGateway::Model::CreateSnapshotRequest::SetSnapshotDescription ( Aws::String &&  value)
inline

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Definition at line 119 of file CreateSnapshotRequest.h.

◆ SetSnapshotDescription() [3/3]

void Aws::StorageGateway::Model::CreateSnapshotRequest::SetSnapshotDescription ( const char *  value)
inline

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Definition at line 126 of file CreateSnapshotRequest.h.

◆ SetTags() [1/2]

void Aws::StorageGateway::Model::CreateSnapshotRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 175 of file CreateSnapshotRequest.h.

◆ SetTags() [2/2]

void Aws::StorageGateway::Model::CreateSnapshotRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 184 of file CreateSnapshotRequest.h.

◆ SetVolumeARN() [1/3]

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

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Definition at line 60 of file CreateSnapshotRequest.h.

◆ SetVolumeARN() [2/3]

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

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Definition at line 66 of file CreateSnapshotRequest.h.

◆ SetVolumeARN() [3/3]

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

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Definition at line 72 of file CreateSnapshotRequest.h.

◆ SnapshotDescriptionHasBeenSet()

bool Aws::StorageGateway::Model::CreateSnapshotRequest::SnapshotDescriptionHasBeenSet ( ) const
inline

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Definition at line 105 of file CreateSnapshotRequest.h.

◆ TagsHasBeenSet()

bool Aws::StorageGateway::Model::CreateSnapshotRequest::TagsHasBeenSet ( ) const
inline

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 166 of file CreateSnapshotRequest.h.

◆ VolumeARNHasBeenSet()

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

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Definition at line 54 of file CreateSnapshotRequest.h.

◆ WithSnapshotDescription() [1/3]

CreateSnapshotRequest& Aws::StorageGateway::Model::CreateSnapshotRequest::WithSnapshotDescription ( const Aws::String value)
inline

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Definition at line 133 of file CreateSnapshotRequest.h.

◆ WithSnapshotDescription() [2/3]

CreateSnapshotRequest& Aws::StorageGateway::Model::CreateSnapshotRequest::WithSnapshotDescription ( Aws::String &&  value)
inline

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Definition at line 140 of file CreateSnapshotRequest.h.

◆ WithSnapshotDescription() [3/3]

CreateSnapshotRequest& Aws::StorageGateway::Model::CreateSnapshotRequest::WithSnapshotDescription ( const char *  value)
inline

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Definition at line 147 of file CreateSnapshotRequest.h.

◆ WithTags() [1/2]

CreateSnapshotRequest& Aws::StorageGateway::Model::CreateSnapshotRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 193 of file CreateSnapshotRequest.h.

◆ WithTags() [2/2]

CreateSnapshotRequest& Aws::StorageGateway::Model::CreateSnapshotRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 202 of file CreateSnapshotRequest.h.

◆ WithVolumeARN() [1/3]

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

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Definition at line 78 of file CreateSnapshotRequest.h.

◆ WithVolumeARN() [2/3]

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

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Definition at line 84 of file CreateSnapshotRequest.h.

◆ WithVolumeARN() [3/3]

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

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Definition at line 90 of file CreateSnapshotRequest.h.


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