AWS SDK for C++  0.12.9
AWS SDK for C++
Public Member Functions | List of all members
Aws::SQS::Model::GetQueueAttributesRequest Class Reference

#include <GetQueueAttributesRequest.h>

Inheritance diagram for Aws::SQS::Model::GetQueueAttributesRequest:
Aws::SQS::SQSRequest Aws::AmazonSerializableWebServiceRequest Aws::AmazonWebServiceRequest

Public Member Functions

 GetQueueAttributesRequest ()
 
Aws::String SerializePayload () const override
 
const Aws::StringGetQueueUrl () const
 
void SetQueueUrl (const Aws::String &value)
 
void SetQueueUrl (Aws::String &&value)
 
void SetQueueUrl (const char *value)
 
GetQueueAttributesRequestWithQueueUrl (const Aws::String &value)
 
GetQueueAttributesRequestWithQueueUrl (Aws::String &&value)
 
GetQueueAttributesRequestWithQueueUrl (const char *value)
 
const Aws::Vector< QueueAttributeName > & GetAttributeNames () const
 
void SetAttributeNames (const Aws::Vector< QueueAttributeName > &value)
 
void SetAttributeNames (Aws::Vector< QueueAttributeName > &&value)
 
GetQueueAttributesRequestWithAttributeNames (const Aws::Vector< QueueAttributeName > &value)
 
GetQueueAttributesRequestWithAttributeNames (Aws::Vector< QueueAttributeName > &&value)
 
GetQueueAttributesRequestAddAttributeNames (const QueueAttributeName &value)
 
GetQueueAttributesRequestAddAttributeNames (QueueAttributeName &&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
 
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 SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::SQS::SQSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 32 of file GetQueueAttributesRequest.h.

Constructor & Destructor Documentation

Aws::SQS::Model::GetQueueAttributesRequest::GetQueueAttributesRequest ( )

Member Function Documentation

GetQueueAttributesRequest& Aws::SQS::Model::GetQueueAttributesRequest::AddAttributeNames ( const QueueAttributeName value)
inline

A list of attributes to retrieve information for. The following attributes are supported:

  • All - returns all values.

  • ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

  • CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).

  • LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).

  • Policy - returns the queue's policy.

  • MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

  • MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.

  • QueueArn - returns the queue's Amazon resource name (ARN).

  • ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.

  • DelaySeconds - returns the default delay on the queue in seconds.

  • ReceiveMessageWaitTimeSeconds

    • returns the time for which a ReceiveMessage call will wait for a message to arrive.

  • RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

<note>

Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

</note>

Definition at line 330 of file GetQueueAttributesRequest.h.

GetQueueAttributesRequest& Aws::SQS::Model::GetQueueAttributesRequest::AddAttributeNames ( QueueAttributeName &&  value)
inline

A list of attributes to retrieve information for. The following attributes are supported:

  • All - returns all values.

  • ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

  • CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).

  • LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).

  • Policy - returns the queue's policy.

  • MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

  • MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.

  • QueueArn - returns the queue's Amazon resource name (ARN).

  • ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.

  • DelaySeconds - returns the default delay on the queue in seconds.

  • ReceiveMessageWaitTimeSeconds

    • returns the time for which a ReceiveMessage call will wait for a message to arrive.

  • RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

<note>

Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

</note>

Definition at line 372 of file GetQueueAttributesRequest.h.

const Aws::Vector<QueueAttributeName>& Aws::SQS::Model::GetQueueAttributesRequest::GetAttributeNames ( ) const
inline

A list of attributes to retrieve information for. The following attributes are supported:

  • All - returns all values.

  • ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

  • CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).

  • LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).

  • Policy - returns the queue's policy.

  • MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

  • MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.

  • QueueArn - returns the queue's Amazon resource name (ARN).

  • ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.

  • DelaySeconds - returns the default delay on the queue in seconds.

  • ReceiveMessageWaitTimeSeconds

    • returns the time for which a ReceiveMessage call will wait for a message to arrive.

  • RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

<note>

Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

</note>

Definition at line 120 of file GetQueueAttributesRequest.h.

const Aws::String& Aws::SQS::Model::GetQueueAttributesRequest::GetQueueUrl ( ) const
inline

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Definition at line 42 of file GetQueueAttributesRequest.h.

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

Convert payload into String.

Implements Aws::SQS::SQSRequest.

void Aws::SQS::Model::GetQueueAttributesRequest::SetAttributeNames ( const Aws::Vector< QueueAttributeName > &  value)
inline

A list of attributes to retrieve information for. The following attributes are supported:

  • All - returns all values.

  • ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

  • CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).

  • LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).

  • Policy - returns the queue's policy.

  • MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

  • MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.

  • QueueArn - returns the queue's Amazon resource name (ARN).

  • ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.

  • DelaySeconds - returns the default delay on the queue in seconds.

  • ReceiveMessageWaitTimeSeconds

    • returns the time for which a ReceiveMessage call will wait for a message to arrive.

  • RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

<note>

Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

</note>

Definition at line 162 of file GetQueueAttributesRequest.h.

void Aws::SQS::Model::GetQueueAttributesRequest::SetAttributeNames ( Aws::Vector< QueueAttributeName > &&  value)
inline

A list of attributes to retrieve information for. The following attributes are supported:

  • All - returns all values.

  • ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

  • CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).

  • LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).

  • Policy - returns the queue's policy.

  • MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

  • MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.

  • QueueArn - returns the queue's Amazon resource name (ARN).

  • ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.

  • DelaySeconds - returns the default delay on the queue in seconds.

  • ReceiveMessageWaitTimeSeconds

    • returns the time for which a ReceiveMessage call will wait for a message to arrive.

  • RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

<note>

Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

</note>

Definition at line 204 of file GetQueueAttributesRequest.h.

void Aws::SQS::Model::GetQueueAttributesRequest::SetQueueUrl ( const Aws::String value)
inline

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Definition at line 48 of file GetQueueAttributesRequest.h.

void Aws::SQS::Model::GetQueueAttributesRequest::SetQueueUrl ( Aws::String &&  value)
inline

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Definition at line 54 of file GetQueueAttributesRequest.h.

void Aws::SQS::Model::GetQueueAttributesRequest::SetQueueUrl ( const char *  value)
inline

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Definition at line 60 of file GetQueueAttributesRequest.h.

GetQueueAttributesRequest& Aws::SQS::Model::GetQueueAttributesRequest::WithAttributeNames ( const Aws::Vector< QueueAttributeName > &  value)
inline

A list of attributes to retrieve information for. The following attributes are supported:

  • All - returns all values.

  • ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

  • CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).

  • LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).

  • Policy - returns the queue's policy.

  • MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

  • MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.

  • QueueArn - returns the queue's Amazon resource name (ARN).

  • ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.

  • DelaySeconds - returns the default delay on the queue in seconds.

  • ReceiveMessageWaitTimeSeconds

    • returns the time for which a ReceiveMessage call will wait for a message to arrive.

  • RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

<note>

Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

</note>

Definition at line 246 of file GetQueueAttributesRequest.h.

GetQueueAttributesRequest& Aws::SQS::Model::GetQueueAttributesRequest::WithAttributeNames ( Aws::Vector< QueueAttributeName > &&  value)
inline

A list of attributes to retrieve information for. The following attributes are supported:

  • All - returns all values.

  • ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

  • CreatedTimestamp - returns the time when the queue was created (epoch time in seconds).

  • LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds).

  • Policy - returns the queue's policy.

  • MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

  • MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message.

  • QueueArn - returns the queue's Amazon resource name (ARN).

  • ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue.

  • DelaySeconds - returns the default delay on the queue in seconds.

  • ReceiveMessageWaitTimeSeconds

    • returns the time for which a ReceiveMessage call will wait for a message to arrive.

  • RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

<note>

Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

</note>

Definition at line 288 of file GetQueueAttributesRequest.h.

GetQueueAttributesRequest& Aws::SQS::Model::GetQueueAttributesRequest::WithQueueUrl ( const Aws::String value)
inline

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Definition at line 66 of file GetQueueAttributesRequest.h.

GetQueueAttributesRequest& Aws::SQS::Model::GetQueueAttributesRequest::WithQueueUrl ( Aws::String &&  value)
inline

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Definition at line 72 of file GetQueueAttributesRequest.h.

GetQueueAttributesRequest& Aws::SQS::Model::GetQueueAttributesRequest::WithQueueUrl ( const char *  value)
inline

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Definition at line 78 of file GetQueueAttributesRequest.h.


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