Aws::SQS::Model::ListQueuesRequest Class Reference

#include <ListQueuesRequest.h>

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

Public Member Functions

AWS_SQS_API ListQueuesRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_SQS_API Aws::String SerializePayload () const override

 

AWS_SQS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override

 

const Aws::String & GetQueueNamePrefix () const

 

bool QueueNamePrefixHasBeenSet () const

 

template<typename QueueNamePrefixT = Aws::String>

void SetQueueNamePrefix (QueueNamePrefixT &&value)

 

template<typename QueueNamePrefixT = Aws::String>

ListQueuesRequest & WithQueueNamePrefix (QueueNamePrefixT &&value)

 

const Aws::String & GetNextToken () const

 

bool NextTokenHasBeenSet () const

 

template<typename NextTokenT = Aws::String>

void SetNextToken (NextTokenT &&value)

 

template<typename NextTokenT = Aws::String>

ListQueuesRequest & WithNextToken (NextTokenT &&value)

 

int GetMaxResults () const

 

bool MaxResultsHasBeenSet () const

 

void SetMaxResults (int value)

 

ListQueuesRequest & WithMaxResults (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::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

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 HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual bool IsLongPollingOperation () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

RetryContext GetRetryContext () const

 

void SetRetryContext (const RetryContext &context) const

 

virtual Aws::Vector< smithy::AuthSchemeOption > GetRequestSpecificSupportedAuth () const

 

virtual bool ChecksumAlgorithmIsSet () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Additional Inherited Members

Public Types inherited from Aws::SQS::SQSRequest

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

See Also:

AWS API Reference

Definition at line 22 of file ListQueuesRequest.h.

Constructor & Destructor Documentation

ListQueuesRequest()

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

default

Member Function Documentation

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 80 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 60 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 42 of file ListQueuesRequest.h.

GetRequestSpecificHeaders()

AWS_SQS_API Aws::Http::HeaderValueCollection Aws::SQS::Model::ListQueuesRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::SQS::SQSRequest.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 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 81 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 61 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 43 of file ListQueuesRequest.h.

SerializePayload()

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

overridevirtual

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 82 of file ListQueuesRequest.h.

SetNextToken()

template<typename NextTokenT = Aws::String>

void Aws::SQS::Model::ListQueuesRequest::SetNextToken ( NextTokenT &&  value)

inline

Pagination token to request the next set of results.

Definition at line 63 of file ListQueuesRequest.h.

SetQueueNamePrefix()

template<typename QueueNamePrefixT = Aws::String>

void Aws::SQS::Model::ListQueuesRequest::SetQueueNamePrefix ( QueueNamePrefixT &&  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 45 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 86 of file ListQueuesRequest.h.

WithNextToken()

template<typename NextTokenT = Aws::String>

ListQueuesRequest & Aws::SQS::Model::ListQueuesRequest::WithNextToken ( NextTokenT &&  value)

inline

Pagination token to request the next set of results.

Definition at line 68 of file ListQueuesRequest.h.

WithQueueNamePrefix()

template<typename QueueNamePrefixT = Aws::String>

ListQueuesRequest & Aws::SQS::Model::ListQueuesRequest::WithQueueNamePrefix ( QueueNamePrefixT &&  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 50 of file ListQueuesRequest.h.

---

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

• generated/src/aws-cpp-sdk-sqs/include/aws/sqs/model/ListQueuesRequest.h