AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::SQS::Model::ListQueuesRequest Class Reference

#include <ListQueuesRequest.h>

+ Inheritance diagram for Aws::SQS::Model::ListQueuesRequest:

Public Member Functions

 ListQueuesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetQueueNamePrefix () const
 
bool QueueNamePrefixHasBeenSet () const
 
void SetQueueNamePrefix (const Aws::String &value)
 
void SetQueueNamePrefix (Aws::String &&value)
 
void SetQueueNamePrefix (const char *value)
 
ListQueuesRequestWithQueueNamePrefix (const Aws::String &value)
 
ListQueuesRequestWithQueueNamePrefix (Aws::String &&value)
 
ListQueuesRequestWithQueueNamePrefix (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)
 
ListQueuesRequestWithNextToken (const Aws::String &value)
 
ListQueuesRequestWithNextToken (Aws::String &&value)
 
ListQueuesRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListQueuesRequestWithMaxResults (int value)
 
- Public Member Functions inherited from Aws::SQS::SQSRequest
virtual ~SQSRequest ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::SQS::SQSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 24 of file ListQueuesRequest.h.

Constructor & Destructor Documentation

◆ ListQueuesRequest()

Aws::SQS::Model::ListQueuesRequest::ListQueuesRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::SQS::Model::ListQueuesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetMaxResults()

int Aws::SQS::Model::ListQueuesRequest::GetMaxResults ( ) const
inline

Maximum number of results to include in the response. Value range is 1 to

  1. You must set MaxResults to receive a value for NextToken in the response.

Definition at line 145 of file ListQueuesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::SQS::Model::ListQueuesRequest::GetNextToken ( ) const
inline

Pagination token to request the next set of results.

Definition at line 102 of file ListQueuesRequest.h.

◆ GetQueueNamePrefix()

const Aws::String& Aws::SQS::Model::ListQueuesRequest::GetQueueNamePrefix ( ) const
inline

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Definition at line 47 of file ListQueuesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SQS::Model::ListQueuesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file ListQueuesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::SQS::Model::ListQueuesRequest::MaxResultsHasBeenSet ( ) const
inline

Maximum number of results to include in the response. Value range is 1 to

  1. You must set MaxResults to receive a value for NextToken in the response.

Definition at line 152 of file ListQueuesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::SQS::Model::ListQueuesRequest::NextTokenHasBeenSet ( ) const
inline

Pagination token to request the next set of results.

Definition at line 107 of file ListQueuesRequest.h.

◆ QueueNamePrefixHasBeenSet()

bool Aws::SQS::Model::ListQueuesRequest::QueueNamePrefixHasBeenSet ( ) const
inline

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Definition at line 54 of file ListQueuesRequest.h.

◆ SerializePayload()

Aws::String Aws::SQS::Model::ListQueuesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxResults()

void Aws::SQS::Model::ListQueuesRequest::SetMaxResults ( int  value)
inline

Maximum number of results to include in the response. Value range is 1 to

  1. You must set MaxResults to receive a value for NextToken in the response.

Definition at line 159 of file ListQueuesRequest.h.

◆ SetNextToken() [1/3]

void Aws::SQS::Model::ListQueuesRequest::SetNextToken ( const Aws::String value)
inline

Pagination token to request the next set of results.

Definition at line 112 of file ListQueuesRequest.h.

◆ SetNextToken() [2/3]

void Aws::SQS::Model::ListQueuesRequest::SetNextToken ( Aws::String &&  value)
inline

Pagination token to request the next set of results.

Definition at line 117 of file ListQueuesRequest.h.

◆ SetNextToken() [3/3]

void Aws::SQS::Model::ListQueuesRequest::SetNextToken ( const char *  value)
inline

Pagination token to request the next set of results.

Definition at line 122 of file ListQueuesRequest.h.

◆ SetQueueNamePrefix() [1/3]

void Aws::SQS::Model::ListQueuesRequest::SetQueueNamePrefix ( const Aws::String value)
inline

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Definition at line 61 of file ListQueuesRequest.h.

◆ SetQueueNamePrefix() [2/3]

void Aws::SQS::Model::ListQueuesRequest::SetQueueNamePrefix ( Aws::String &&  value)
inline

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Definition at line 68 of file ListQueuesRequest.h.

◆ SetQueueNamePrefix() [3/3]

void Aws::SQS::Model::ListQueuesRequest::SetQueueNamePrefix ( const char *  value)
inline

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Definition at line 75 of file ListQueuesRequest.h.

◆ WithMaxResults()

ListQueuesRequest& Aws::SQS::Model::ListQueuesRequest::WithMaxResults ( int  value)
inline

Maximum number of results to include in the response. Value range is 1 to

  1. You must set MaxResults to receive a value for NextToken in the response.

Definition at line 166 of file ListQueuesRequest.h.

◆ WithNextToken() [1/3]

ListQueuesRequest& Aws::SQS::Model::ListQueuesRequest::WithNextToken ( const Aws::String value)
inline

Pagination token to request the next set of results.

Definition at line 127 of file ListQueuesRequest.h.

◆ WithNextToken() [2/3]

ListQueuesRequest& Aws::SQS::Model::ListQueuesRequest::WithNextToken ( Aws::String &&  value)
inline

Pagination token to request the next set of results.

Definition at line 132 of file ListQueuesRequest.h.

◆ WithNextToken() [3/3]

ListQueuesRequest& Aws::SQS::Model::ListQueuesRequest::WithNextToken ( const char *  value)
inline

Pagination token to request the next set of results.

Definition at line 137 of file ListQueuesRequest.h.

◆ WithQueueNamePrefix() [1/3]

ListQueuesRequest& Aws::SQS::Model::ListQueuesRequest::WithQueueNamePrefix ( const Aws::String value)
inline

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Definition at line 82 of file ListQueuesRequest.h.

◆ WithQueueNamePrefix() [2/3]

ListQueuesRequest& Aws::SQS::Model::ListQueuesRequest::WithQueueNamePrefix ( Aws::String &&  value)
inline

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Definition at line 89 of file ListQueuesRequest.h.

◆ WithQueueNamePrefix() [3/3]

ListQueuesRequest& Aws::SQS::Model::ListQueuesRequest::WithQueueNamePrefix ( const char *  value)
inline

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue URLs and names are case-sensitive.

Definition at line 96 of file ListQueuesRequest.h.


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