AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::SWF::Model::ListDomainsRequest Class Reference

#include <ListDomainsRequest.h>

+ Inheritance diagram for Aws::SWF::Model::ListDomainsRequest:

Public Member Functions

 ListDomainsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetNextPageToken () const
 
bool NextPageTokenHasBeenSet () const
 
void SetNextPageToken (const Aws::String &value)
 
void SetNextPageToken (Aws::String &&value)
 
void SetNextPageToken (const char *value)
 
ListDomainsRequestWithNextPageToken (const Aws::String &value)
 
ListDomainsRequestWithNextPageToken (Aws::String &&value)
 
ListDomainsRequestWithNextPageToken (const char *value)
 
const RegistrationStatusGetRegistrationStatus () const
 
bool RegistrationStatusHasBeenSet () const
 
void SetRegistrationStatus (const RegistrationStatus &value)
 
void SetRegistrationStatus (RegistrationStatus &&value)
 
ListDomainsRequestWithRegistrationStatus (const RegistrationStatus &value)
 
ListDomainsRequestWithRegistrationStatus (RegistrationStatus &&value)
 
int GetMaximumPageSize () const
 
bool MaximumPageSizeHasBeenSet () const
 
void SetMaximumPageSize (int value)
 
ListDomainsRequestWithMaximumPageSize (int value)
 
bool GetReverseOrder () const
 
bool ReverseOrderHasBeenSet () const
 
void SetReverseOrder (bool value)
 
ListDomainsRequestWithReverseOrder (bool value)
 
- Public Member Functions inherited from Aws::SWF::SWFRequest
virtual ~SWFRequest ()
 
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

Definition at line 22 of file ListDomainsRequest.h.

Constructor & Destructor Documentation

◆ ListDomainsRequest()

Aws::SWF::Model::ListDomainsRequest::ListDomainsRequest ( )

Member Function Documentation

◆ GetMaximumPageSize()

int Aws::SWF::Model::ListDomainsRequest::GetMaximumPageSize ( ) const
inline

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Definition at line 170 of file ListDomainsRequest.h.

◆ GetNextPageToken()

const Aws::String& Aws::SWF::Model::ListDomainsRequest::GetNextPageToken ( ) const
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 48 of file ListDomainsRequest.h.

◆ GetRegistrationStatus()

const RegistrationStatus& Aws::SWF::Model::ListDomainsRequest::GetRegistrationStatus ( ) const
inline

Specifies the registration status of the domains to list.

Definition at line 138 of file ListDomainsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SWF::Model::ListDomainsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SWF::SWFRequest.

◆ GetReverseOrder()

bool Aws::SWF::Model::ListDomainsRequest::GetReverseOrder ( ) const
inline

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

Definition at line 196 of file ListDomainsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SWF::Model::ListDomainsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListDomainsRequest.h.

◆ MaximumPageSizeHasBeenSet()

bool Aws::SWF::Model::ListDomainsRequest::MaximumPageSizeHasBeenSet ( ) const
inline

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Definition at line 176 of file ListDomainsRequest.h.

◆ NextPageTokenHasBeenSet()

bool Aws::SWF::Model::ListDomainsRequest::NextPageTokenHasBeenSet ( ) const
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 60 of file ListDomainsRequest.h.

◆ RegistrationStatusHasBeenSet()

bool Aws::SWF::Model::ListDomainsRequest::RegistrationStatusHasBeenSet ( ) const
inline

Specifies the registration status of the domains to list.

Definition at line 143 of file ListDomainsRequest.h.

◆ ReverseOrderHasBeenSet()

bool Aws::SWF::Model::ListDomainsRequest::ReverseOrderHasBeenSet ( ) const
inline

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

Definition at line 203 of file ListDomainsRequest.h.

◆ SerializePayload()

Aws::String Aws::SWF::Model::ListDomainsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaximumPageSize()

void Aws::SWF::Model::ListDomainsRequest::SetMaximumPageSize ( int  value)
inline

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Definition at line 182 of file ListDomainsRequest.h.

◆ SetNextPageToken() [1/3]

void Aws::SWF::Model::ListDomainsRequest::SetNextPageToken ( const Aws::String value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 72 of file ListDomainsRequest.h.

◆ SetNextPageToken() [2/3]

void Aws::SWF::Model::ListDomainsRequest::SetNextPageToken ( Aws::String &&  value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 84 of file ListDomainsRequest.h.

◆ SetNextPageToken() [3/3]

void Aws::SWF::Model::ListDomainsRequest::SetNextPageToken ( const char *  value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 96 of file ListDomainsRequest.h.

◆ SetRegistrationStatus() [1/2]

void Aws::SWF::Model::ListDomainsRequest::SetRegistrationStatus ( const RegistrationStatus value)
inline

Specifies the registration status of the domains to list.

Definition at line 148 of file ListDomainsRequest.h.

◆ SetRegistrationStatus() [2/2]

void Aws::SWF::Model::ListDomainsRequest::SetRegistrationStatus ( RegistrationStatus &&  value)
inline

Specifies the registration status of the domains to list.

Definition at line 153 of file ListDomainsRequest.h.

◆ SetReverseOrder()

void Aws::SWF::Model::ListDomainsRequest::SetReverseOrder ( bool  value)
inline

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

Definition at line 210 of file ListDomainsRequest.h.

◆ WithMaximumPageSize()

ListDomainsRequest& Aws::SWF::Model::ListDomainsRequest::WithMaximumPageSize ( int  value)
inline

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Definition at line 188 of file ListDomainsRequest.h.

◆ WithNextPageToken() [1/3]

ListDomainsRequest& Aws::SWF::Model::ListDomainsRequest::WithNextPageToken ( const Aws::String value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 108 of file ListDomainsRequest.h.

◆ WithNextPageToken() [2/3]

ListDomainsRequest& Aws::SWF::Model::ListDomainsRequest::WithNextPageToken ( Aws::String &&  value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 120 of file ListDomainsRequest.h.

◆ WithNextPageToken() [3/3]

ListDomainsRequest& Aws::SWF::Model::ListDomainsRequest::WithNextPageToken ( const char *  value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 132 of file ListDomainsRequest.h.

◆ WithRegistrationStatus() [1/2]

ListDomainsRequest& Aws::SWF::Model::ListDomainsRequest::WithRegistrationStatus ( const RegistrationStatus value)
inline

Specifies the registration status of the domains to list.

Definition at line 158 of file ListDomainsRequest.h.

◆ WithRegistrationStatus() [2/2]

ListDomainsRequest& Aws::SWF::Model::ListDomainsRequest::WithRegistrationStatus ( RegistrationStatus &&  value)
inline

Specifies the registration status of the domains to list.

Definition at line 163 of file ListDomainsRequest.h.

◆ WithReverseOrder()

ListDomainsRequest& Aws::SWF::Model::ListDomainsRequest::WithReverseOrder ( bool  value)
inline

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

Definition at line 217 of file ListDomainsRequest.h.


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