AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::DirectoryService::Model::DescribeSnapshotsRequest Class Reference

#include <DescribeSnapshotsRequest.h>

+ Inheritance diagram for Aws::DirectoryService::Model::DescribeSnapshotsRequest:

Public Member Functions

 DescribeSnapshotsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDirectoryId () const
 
bool DirectoryIdHasBeenSet () const
 
void SetDirectoryId (const Aws::String &value)
 
void SetDirectoryId (Aws::String &&value)
 
void SetDirectoryId (const char *value)
 
DescribeSnapshotsRequestWithDirectoryId (const Aws::String &value)
 
DescribeSnapshotsRequestWithDirectoryId (Aws::String &&value)
 
DescribeSnapshotsRequestWithDirectoryId (const char *value)
 
const Aws::Vector< Aws::String > & GetSnapshotIds () const
 
bool SnapshotIdsHasBeenSet () const
 
void SetSnapshotIds (const Aws::Vector< Aws::String > &value)
 
void SetSnapshotIds (Aws::Vector< Aws::String > &&value)
 
DescribeSnapshotsRequestWithSnapshotIds (const Aws::Vector< Aws::String > &value)
 
DescribeSnapshotsRequestWithSnapshotIds (Aws::Vector< Aws::String > &&value)
 
DescribeSnapshotsRequestAddSnapshotIds (const Aws::String &value)
 
DescribeSnapshotsRequestAddSnapshotIds (Aws::String &&value)
 
DescribeSnapshotsRequestAddSnapshotIds (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeSnapshotsRequestWithNextToken (const Aws::String &value)
 
DescribeSnapshotsRequestWithNextToken (Aws::String &&value)
 
DescribeSnapshotsRequestWithNextToken (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeSnapshotsRequestWithLimit (int value)
 
- Public Member Functions inherited from Aws::DirectoryService::DirectoryServiceRequest
virtual ~DirectoryServiceRequest ()
 
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

Contains the inputs for the DescribeSnapshots operation.

See Also:

AWS API Reference

Definition at line 26 of file DescribeSnapshotsRequest.h.

Constructor & Destructor Documentation

◆ DescribeSnapshotsRequest()

Aws::DirectoryService::Model::DescribeSnapshotsRequest::DescribeSnapshotsRequest ( )

Member Function Documentation

◆ AddSnapshotIds() [1/3]

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::AddSnapshotIds ( const Aws::String value)
inline

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

Definition at line 138 of file DescribeSnapshotsRequest.h.

◆ AddSnapshotIds() [2/3]

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::AddSnapshotIds ( Aws::String &&  value)
inline

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

Definition at line 145 of file DescribeSnapshotsRequest.h.

◆ AddSnapshotIds() [3/3]

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::AddSnapshotIds ( const char *  value)
inline

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

Definition at line 152 of file DescribeSnapshotsRequest.h.

◆ DirectoryIdHasBeenSet()

bool Aws::DirectoryService::Model::DescribeSnapshotsRequest::DirectoryIdHasBeenSet ( ) const
inline

The identifier of the directory for which to retrieve snapshot information.

Definition at line 52 of file DescribeSnapshotsRequest.h.

◆ GetDirectoryId()

const Aws::String& Aws::DirectoryService::Model::DescribeSnapshotsRequest::GetDirectoryId ( ) const
inline

The identifier of the directory for which to retrieve snapshot information.

Definition at line 46 of file DescribeSnapshotsRequest.h.

◆ GetLimit()

int Aws::DirectoryService::Model::DescribeSnapshotsRequest::GetLimit ( ) const
inline

The maximum number of objects to return.

Definition at line 207 of file DescribeSnapshotsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::DirectoryService::Model::DescribeSnapshotsRequest::GetNextToken ( ) const
inline

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Definition at line 159 of file DescribeSnapshotsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DirectoryService::Model::DescribeSnapshotsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::DirectoryService::Model::DescribeSnapshotsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeSnapshotsRequest.h.

◆ GetSnapshotIds()

const Aws::Vector<Aws::String>& Aws::DirectoryService::Model::DescribeSnapshotsRequest::GetSnapshotIds ( ) const
inline

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

Definition at line 96 of file DescribeSnapshotsRequest.h.

◆ LimitHasBeenSet()

bool Aws::DirectoryService::Model::DescribeSnapshotsRequest::LimitHasBeenSet ( ) const
inline

The maximum number of objects to return.

Definition at line 212 of file DescribeSnapshotsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::DirectoryService::Model::DescribeSnapshotsRequest::NextTokenHasBeenSet ( ) const
inline

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Definition at line 165 of file DescribeSnapshotsRequest.h.

◆ SerializePayload()

Aws::String Aws::DirectoryService::Model::DescribeSnapshotsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDirectoryId() [1/3]

void Aws::DirectoryService::Model::DescribeSnapshotsRequest::SetDirectoryId ( const Aws::String value)
inline

The identifier of the directory for which to retrieve snapshot information.

Definition at line 58 of file DescribeSnapshotsRequest.h.

◆ SetDirectoryId() [2/3]

void Aws::DirectoryService::Model::DescribeSnapshotsRequest::SetDirectoryId ( Aws::String &&  value)
inline

The identifier of the directory for which to retrieve snapshot information.

Definition at line 64 of file DescribeSnapshotsRequest.h.

◆ SetDirectoryId() [3/3]

void Aws::DirectoryService::Model::DescribeSnapshotsRequest::SetDirectoryId ( const char *  value)
inline

The identifier of the directory for which to retrieve snapshot information.

Definition at line 70 of file DescribeSnapshotsRequest.h.

◆ SetLimit()

void Aws::DirectoryService::Model::DescribeSnapshotsRequest::SetLimit ( int  value)
inline

The maximum number of objects to return.

Definition at line 217 of file DescribeSnapshotsRequest.h.

◆ SetNextToken() [1/3]

void Aws::DirectoryService::Model::DescribeSnapshotsRequest::SetNextToken ( const Aws::String value)
inline

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Definition at line 171 of file DescribeSnapshotsRequest.h.

◆ SetNextToken() [2/3]

void Aws::DirectoryService::Model::DescribeSnapshotsRequest::SetNextToken ( Aws::String &&  value)
inline

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Definition at line 177 of file DescribeSnapshotsRequest.h.

◆ SetNextToken() [3/3]

void Aws::DirectoryService::Model::DescribeSnapshotsRequest::SetNextToken ( const char *  value)
inline

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Definition at line 183 of file DescribeSnapshotsRequest.h.

◆ SetSnapshotIds() [1/2]

void Aws::DirectoryService::Model::DescribeSnapshotsRequest::SetSnapshotIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

Definition at line 110 of file DescribeSnapshotsRequest.h.

◆ SetSnapshotIds() [2/2]

void Aws::DirectoryService::Model::DescribeSnapshotsRequest::SetSnapshotIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

Definition at line 117 of file DescribeSnapshotsRequest.h.

◆ SnapshotIdsHasBeenSet()

bool Aws::DirectoryService::Model::DescribeSnapshotsRequest::SnapshotIdsHasBeenSet ( ) const
inline

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

Definition at line 103 of file DescribeSnapshotsRequest.h.

◆ WithDirectoryId() [1/3]

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::WithDirectoryId ( const Aws::String value)
inline

The identifier of the directory for which to retrieve snapshot information.

Definition at line 76 of file DescribeSnapshotsRequest.h.

◆ WithDirectoryId() [2/3]

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::WithDirectoryId ( Aws::String &&  value)
inline

The identifier of the directory for which to retrieve snapshot information.

Definition at line 82 of file DescribeSnapshotsRequest.h.

◆ WithDirectoryId() [3/3]

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::WithDirectoryId ( const char *  value)
inline

The identifier of the directory for which to retrieve snapshot information.

Definition at line 88 of file DescribeSnapshotsRequest.h.

◆ WithLimit()

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::WithLimit ( int  value)
inline

The maximum number of objects to return.

Definition at line 222 of file DescribeSnapshotsRequest.h.

◆ WithNextToken() [1/3]

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::WithNextToken ( const Aws::String value)
inline

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Definition at line 189 of file DescribeSnapshotsRequest.h.

◆ WithNextToken() [2/3]

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::WithNextToken ( Aws::String &&  value)
inline

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Definition at line 195 of file DescribeSnapshotsRequest.h.

◆ WithNextToken() [3/3]

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::WithNextToken ( const char *  value)
inline

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

Definition at line 201 of file DescribeSnapshotsRequest.h.

◆ WithSnapshotIds() [1/2]

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::WithSnapshotIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

Definition at line 124 of file DescribeSnapshotsRequest.h.

◆ WithSnapshotIds() [2/2]

DescribeSnapshotsRequest& Aws::DirectoryService::Model::DescribeSnapshotsRequest::WithSnapshotIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

Definition at line 131 of file DescribeSnapshotsRequest.h.


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