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

#include <DescribeTapesRequest.h>

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

Public Member Functions

 DescribeTapesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetGatewayARN () const
 
bool GatewayARNHasBeenSet () const
 
void SetGatewayARN (const Aws::String &value)
 
void SetGatewayARN (Aws::String &&value)
 
void SetGatewayARN (const char *value)
 
DescribeTapesRequestWithGatewayARN (const Aws::String &value)
 
DescribeTapesRequestWithGatewayARN (Aws::String &&value)
 
DescribeTapesRequestWithGatewayARN (const char *value)
 
const Aws::Vector< Aws::String > & GetTapeARNs () const
 
bool TapeARNsHasBeenSet () const
 
void SetTapeARNs (const Aws::Vector< Aws::String > &value)
 
void SetTapeARNs (Aws::Vector< Aws::String > &&value)
 
DescribeTapesRequestWithTapeARNs (const Aws::Vector< Aws::String > &value)
 
DescribeTapesRequestWithTapeARNs (Aws::Vector< Aws::String > &&value)
 
DescribeTapesRequestAddTapeARNs (const Aws::String &value)
 
DescribeTapesRequestAddTapeARNs (Aws::String &&value)
 
DescribeTapesRequestAddTapeARNs (const char *value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
DescribeTapesRequestWithMarker (const Aws::String &value)
 
DescribeTapesRequestWithMarker (Aws::String &&value)
 
DescribeTapesRequestWithMarker (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeTapesRequestWithLimit (int 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

DescribeTapesInput

See Also:

AWS API Reference

Definition at line 25 of file DescribeTapesRequest.h.

Constructor & Destructor Documentation

◆ DescribeTapesRequest()

Aws::StorageGateway::Model::DescribeTapesRequest::DescribeTapesRequest ( )

Member Function Documentation

◆ AddTapeARNs() [1/3]

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::AddTapeARNs ( Aws::String &&  value)
inline

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Definition at line 128 of file DescribeTapesRequest.h.

◆ AddTapeARNs() [2/3]

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::AddTapeARNs ( const Aws::String value)
inline

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Definition at line 120 of file DescribeTapesRequest.h.

◆ AddTapeARNs() [3/3]

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::AddTapeARNs ( const char *  value)
inline

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Definition at line 136 of file DescribeTapesRequest.h.

◆ GatewayARNHasBeenSet()

bool Aws::StorageGateway::Model::DescribeTapesRequest::GatewayARNHasBeenSet ( ) const
inline

Definition at line 45 of file DescribeTapesRequest.h.

◆ GetGatewayARN()

const Aws::String& Aws::StorageGateway::Model::DescribeTapesRequest::GetGatewayARN ( ) const
inline

Definition at line 42 of file DescribeTapesRequest.h.

◆ GetLimit()

int Aws::StorageGateway::Model::DescribeTapesRequest::GetLimit ( ) const
inline

Specifies that the number of virtual tapes described be limited to the specified number.

Amazon Web Services may impose its own limit, if this field is not set.

Definition at line 201 of file DescribeTapesRequest.h.

◆ GetMarker()

const Aws::String& Aws::StorageGateway::Model::DescribeTapesRequest::GetMarker ( ) const
inline

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

Definition at line 144 of file DescribeTapesRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeTapesRequest.h.

◆ GetTapeARNs()

const Aws::Vector<Aws::String>& Aws::StorageGateway::Model::DescribeTapesRequest::GetTapeARNs ( ) const
inline

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Definition at line 72 of file DescribeTapesRequest.h.

◆ LimitHasBeenSet()

bool Aws::StorageGateway::Model::DescribeTapesRequest::LimitHasBeenSet ( ) const
inline

Specifies that the number of virtual tapes described be limited to the specified number.

Amazon Web Services may impose its own limit, if this field is not set.

Definition at line 208 of file DescribeTapesRequest.h.

◆ MarkerHasBeenSet()

bool Aws::StorageGateway::Model::DescribeTapesRequest::MarkerHasBeenSet ( ) const
inline

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

Definition at line 151 of file DescribeTapesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetGatewayARN() [1/3]

void Aws::StorageGateway::Model::DescribeTapesRequest::SetGatewayARN ( Aws::String &&  value)
inline

Definition at line 51 of file DescribeTapesRequest.h.

◆ SetGatewayARN() [2/3]

void Aws::StorageGateway::Model::DescribeTapesRequest::SetGatewayARN ( const Aws::String value)
inline

Definition at line 48 of file DescribeTapesRequest.h.

◆ SetGatewayARN() [3/3]

void Aws::StorageGateway::Model::DescribeTapesRequest::SetGatewayARN ( const char *  value)
inline

Definition at line 54 of file DescribeTapesRequest.h.

◆ SetLimit()

void Aws::StorageGateway::Model::DescribeTapesRequest::SetLimit ( int  value)
inline

Specifies that the number of virtual tapes described be limited to the specified number.

Amazon Web Services may impose its own limit, if this field is not set.

Definition at line 215 of file DescribeTapesRequest.h.

◆ SetMarker() [1/3]

void Aws::StorageGateway::Model::DescribeTapesRequest::SetMarker ( Aws::String &&  value)
inline

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

Definition at line 165 of file DescribeTapesRequest.h.

◆ SetMarker() [2/3]

void Aws::StorageGateway::Model::DescribeTapesRequest::SetMarker ( const Aws::String value)
inline

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

Definition at line 158 of file DescribeTapesRequest.h.

◆ SetMarker() [3/3]

void Aws::StorageGateway::Model::DescribeTapesRequest::SetMarker ( const char *  value)
inline

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

Definition at line 172 of file DescribeTapesRequest.h.

◆ SetTapeARNs() [1/2]

void Aws::StorageGateway::Model::DescribeTapesRequest::SetTapeARNs ( Aws::Vector< Aws::String > &&  value)
inline

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Definition at line 96 of file DescribeTapesRequest.h.

◆ SetTapeARNs() [2/2]

void Aws::StorageGateway::Model::DescribeTapesRequest::SetTapeARNs ( const Aws::Vector< Aws::String > &  value)
inline

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Definition at line 88 of file DescribeTapesRequest.h.

◆ TapeARNsHasBeenSet()

bool Aws::StorageGateway::Model::DescribeTapesRequest::TapeARNsHasBeenSet ( ) const
inline

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Definition at line 80 of file DescribeTapesRequest.h.

◆ WithGatewayARN() [1/3]

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::WithGatewayARN ( Aws::String &&  value)
inline

Definition at line 60 of file DescribeTapesRequest.h.

◆ WithGatewayARN() [2/3]

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::WithGatewayARN ( const Aws::String value)
inline

Definition at line 57 of file DescribeTapesRequest.h.

◆ WithGatewayARN() [3/3]

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::WithGatewayARN ( const char *  value)
inline

Definition at line 63 of file DescribeTapesRequest.h.

◆ WithLimit()

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::WithLimit ( int  value)
inline

Specifies that the number of virtual tapes described be limited to the specified number.

Amazon Web Services may impose its own limit, if this field is not set.

Definition at line 222 of file DescribeTapesRequest.h.

◆ WithMarker() [1/3]

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::WithMarker ( Aws::String &&  value)
inline

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

Definition at line 186 of file DescribeTapesRequest.h.

◆ WithMarker() [2/3]

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::WithMarker ( const Aws::String value)
inline

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

Definition at line 179 of file DescribeTapesRequest.h.

◆ WithMarker() [3/3]

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::WithMarker ( const char *  value)
inline

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

Definition at line 193 of file DescribeTapesRequest.h.

◆ WithTapeARNs() [1/2]

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::WithTapeARNs ( Aws::Vector< Aws::String > &&  value)
inline

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Definition at line 112 of file DescribeTapesRequest.h.

◆ WithTapeARNs() [2/2]

DescribeTapesRequest& Aws::StorageGateway::Model::DescribeTapesRequest::WithTapeARNs ( const Aws::Vector< Aws::String > &  value)
inline

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Definition at line 104 of file DescribeTapesRequest.h.


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