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

#include <DescribeDirectoriesRequest.h>

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

Public Member Functions

 DescribeDirectoriesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Aws::String > & GetDirectoryIds () const
 
bool DirectoryIdsHasBeenSet () const
 
void SetDirectoryIds (const Aws::Vector< Aws::String > &value)
 
void SetDirectoryIds (Aws::Vector< Aws::String > &&value)
 
DescribeDirectoriesRequestWithDirectoryIds (const Aws::Vector< Aws::String > &value)
 
DescribeDirectoriesRequestWithDirectoryIds (Aws::Vector< Aws::String > &&value)
 
DescribeDirectoriesRequestAddDirectoryIds (const Aws::String &value)
 
DescribeDirectoriesRequestAddDirectoryIds (Aws::String &&value)
 
DescribeDirectoriesRequestAddDirectoryIds (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)
 
DescribeDirectoriesRequestWithNextToken (const Aws::String &value)
 
DescribeDirectoriesRequestWithNextToken (Aws::String &&value)
 
DescribeDirectoriesRequestWithNextToken (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeDirectoriesRequestWithLimit (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 DescribeDirectories operation.

See Also:

AWS API Reference

Definition at line 26 of file DescribeDirectoriesRequest.h.

Constructor & Destructor Documentation

◆ DescribeDirectoriesRequest()

Aws::DirectoryService::Model::DescribeDirectoriesRequest::DescribeDirectoriesRequest ( )

Member Function Documentation

◆ AddDirectoryIds() [1/3]

DescribeDirectoriesRequest& Aws::DirectoryService::Model::DescribeDirectoriesRequest::AddDirectoryIds ( const Aws::String value)
inline

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Definition at line 96 of file DescribeDirectoriesRequest.h.

◆ AddDirectoryIds() [2/3]

DescribeDirectoriesRequest& Aws::DirectoryService::Model::DescribeDirectoriesRequest::AddDirectoryIds ( Aws::String &&  value)
inline

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Definition at line 104 of file DescribeDirectoriesRequest.h.

◆ AddDirectoryIds() [3/3]

DescribeDirectoriesRequest& Aws::DirectoryService::Model::DescribeDirectoriesRequest::AddDirectoryIds ( const char *  value)
inline

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Definition at line 112 of file DescribeDirectoriesRequest.h.

◆ DirectoryIdsHasBeenSet()

bool Aws::DirectoryService::Model::DescribeDirectoriesRequest::DirectoryIdsHasBeenSet ( ) const
inline

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Definition at line 56 of file DescribeDirectoriesRequest.h.

◆ GetDirectoryIds()

const Aws::Vector<Aws::String>& Aws::DirectoryService::Model::DescribeDirectoriesRequest::GetDirectoryIds ( ) const
inline

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Definition at line 48 of file DescribeDirectoriesRequest.h.

◆ GetLimit()

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

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Definition at line 168 of file DescribeDirectoriesRequest.h.

◆ GetNextToken()

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

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

Definition at line 119 of file DescribeDirectoriesRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeDirectoriesRequest.h.

◆ LimitHasBeenSet()

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

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Definition at line 174 of file DescribeDirectoriesRequest.h.

◆ NextTokenHasBeenSet()

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

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

Definition at line 125 of file DescribeDirectoriesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDirectoryIds() [1/2]

void Aws::DirectoryService::Model::DescribeDirectoriesRequest::SetDirectoryIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Definition at line 64 of file DescribeDirectoriesRequest.h.

◆ SetDirectoryIds() [2/2]

void Aws::DirectoryService::Model::DescribeDirectoriesRequest::SetDirectoryIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Definition at line 72 of file DescribeDirectoriesRequest.h.

◆ SetLimit()

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

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Definition at line 180 of file DescribeDirectoriesRequest.h.

◆ SetNextToken() [1/3]

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

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

Definition at line 131 of file DescribeDirectoriesRequest.h.

◆ SetNextToken() [2/3]

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

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

Definition at line 137 of file DescribeDirectoriesRequest.h.

◆ SetNextToken() [3/3]

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

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

Definition at line 143 of file DescribeDirectoriesRequest.h.

◆ WithDirectoryIds() [1/2]

DescribeDirectoriesRequest& Aws::DirectoryService::Model::DescribeDirectoriesRequest::WithDirectoryIds ( const Aws::Vector< Aws::String > &  value)
inline

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Definition at line 80 of file DescribeDirectoriesRequest.h.

◆ WithDirectoryIds() [2/2]

DescribeDirectoriesRequest& Aws::DirectoryService::Model::DescribeDirectoriesRequest::WithDirectoryIds ( Aws::Vector< Aws::String > &&  value)
inline

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

Definition at line 88 of file DescribeDirectoriesRequest.h.

◆ WithLimit()

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

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Definition at line 186 of file DescribeDirectoriesRequest.h.

◆ WithNextToken() [1/3]

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

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

Definition at line 149 of file DescribeDirectoriesRequest.h.

◆ WithNextToken() [2/3]

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

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

Definition at line 155 of file DescribeDirectoriesRequest.h.

◆ WithNextToken() [3/3]

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

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

Definition at line 161 of file DescribeDirectoriesRequest.h.


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