#include <ReceiveMessageRequest.h>

Inheritance diagram for Aws::SQS::Model::ReceiveMessageRequest:

Public Member Functions
	ReceiveMessageRequest ()

Aws::String	SerializePayload () const override

const Aws::String &	GetQueueUrl () const

void	SetQueueUrl (const Aws::String &value)

void	SetQueueUrl (Aws::String &&value)

void	SetQueueUrl (const char *value)

ReceiveMessageRequest &	WithQueueUrl (const Aws::String &value)

ReceiveMessageRequest &	WithQueueUrl (Aws::String &&value)

ReceiveMessageRequest &	WithQueueUrl (const char *value)

const Aws::Vector< QueueAttributeName > &	GetAttributeNames () const

void	SetAttributeNames (const Aws::Vector< QueueAttributeName > &value)

void	SetAttributeNames (Aws::Vector< QueueAttributeName > &&value)

ReceiveMessageRequest &	WithAttributeNames (const Aws::Vector< QueueAttributeName > &value)

ReceiveMessageRequest &	WithAttributeNames (Aws::Vector< QueueAttributeName > &&value)

ReceiveMessageRequest &	AddAttributeNames (const QueueAttributeName &value)

ReceiveMessageRequest &	AddAttributeNames (QueueAttributeName &&value)

const Aws::Vector< Aws::String > &	GetMessageAttributeNames () const

void	SetMessageAttributeNames (const Aws::Vector< Aws::String > &value)

void	SetMessageAttributeNames (Aws::Vector< Aws::String > &&value)

ReceiveMessageRequest &	WithMessageAttributeNames (const Aws::Vector< Aws::String > &value)

ReceiveMessageRequest &	WithMessageAttributeNames (Aws::Vector< Aws::String > &&value)

ReceiveMessageRequest &	AddMessageAttributeNames (const Aws::String &value)

ReceiveMessageRequest &	AddMessageAttributeNames (Aws::String &&value)

ReceiveMessageRequest &	AddMessageAttributeNames (const char *value)

int	GetMaxNumberOfMessages () const

void	SetMaxNumberOfMessages (int value)

ReceiveMessageRequest &	WithMaxNumberOfMessages (int value)

int	GetVisibilityTimeout () const

void	SetVisibilityTimeout (int value)

ReceiveMessageRequest &	WithVisibilityTimeout (int value)

int	GetWaitTimeSeconds () const

void	SetWaitTimeSeconds (int value)

ReceiveMessageRequest &	WithWaitTimeSeconds (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 void	AddQueryStringParameters (Aws::Http::URI &uri) const

const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () 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 ReceiveMessageRequest.h.

Constructor & Destructor Documentation

Aws::SQS::Model::ReceiveMessageRequest::ReceiveMessageRequest ( )

Member Function Documentation

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::AddAttributeNames ( const QueueAttributeName & value )

inline

A list of attributes that need to be returned along with each message. These attributes include:

All - returns all values.
ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, DelaySeconds, LastModifiedTimestamp, MaximumMessageSize, MessageRetentionPeriod, Policy, QueueArn, ReceiveMessageWaitTimeSeconds, RedrivePolicy, and VisibilityTimeout) will be ignored.

Definition at line 216 of file ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::AddAttributeNames ( QueueAttributeName && value )

inline

A list of attributes that need to be returned along with each message. These attributes include:

All - returns all values.
ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, DelaySeconds, LastModifiedTimestamp, MaximumMessageSize, MessageRetentionPeriod, Policy, QueueArn, ReceiveMessageWaitTimeSeconds, RedrivePolicy, and VisibilityTimeout) will be ignored.

Definition at line 239 of file ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::AddMessageAttributeNames ( const Aws::String & value )

inline

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "bar.*" to return all message attributes starting with the "bar" prefix.

Definition at line 329 of file ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::AddMessageAttributeNames ( Aws::String && value )

inline

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "bar.*" to return all message attributes starting with the "bar" prefix.

Definition at line 344 of file ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::AddMessageAttributeNames ( const char * value )

inline

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "bar.*" to return all message attributes starting with the "bar" prefix.

Definition at line 359 of file ReceiveMessageRequest.h.

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

inline

A list of attributes that need to be returned along with each message. These attributes include:

All - returns all values.
ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, DelaySeconds, LastModifiedTimestamp, MaximumMessageSize, MessageRetentionPeriod, Policy, QueueArn, ReceiveMessageWaitTimeSeconds, RedrivePolicy, and VisibilityTimeout) will be ignored.

Definition at line 101 of file ReceiveMessageRequest.h.

int Aws::SQS::Model::ReceiveMessageRequest::GetMaxNumberOfMessages ( ) const

inline

The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

Definition at line 366 of file ReceiveMessageRequest.h.

const Aws::Vector<Aws::String>& Aws::SQS::Model::ReceiveMessageRequest::GetMessageAttributeNames ( ) const

inline

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "bar.*" to return all message attributes starting with the "bar" prefix.

Definition at line 254 of file ReceiveMessageRequest.h.

const Aws::String& Aws::SQS::Model::ReceiveMessageRequest::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 ReceiveMessageRequest.h.

int Aws::SQS::Model::ReceiveMessageRequest::GetVisibilityTimeout ( ) const

inline

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

Definition at line 387 of file ReceiveMessageRequest.h.

int Aws::SQS::Model::ReceiveMessageRequest::GetWaitTimeSeconds ( ) const

inline

The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

Definition at line 408 of file ReceiveMessageRequest.h.

Aws::String Aws::SQS::Model::ReceiveMessageRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::SQS::SQSRequest.

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

inline

A list of attributes that need to be returned along with each message. These attributes include:

All - returns all values.
ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, DelaySeconds, LastModifiedTimestamp, MaximumMessageSize, MessageRetentionPeriod, Policy, QueueArn, ReceiveMessageWaitTimeSeconds, RedrivePolicy, and VisibilityTimeout) will be ignored.

Definition at line 124 of file ReceiveMessageRequest.h.

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

inline

A list of attributes that need to be returned along with each message. These attributes include:

All - returns all values.
ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, DelaySeconds, LastModifiedTimestamp, MaximumMessageSize, MessageRetentionPeriod, Policy, QueueArn, ReceiveMessageWaitTimeSeconds, RedrivePolicy, and VisibilityTimeout) will be ignored.

Definition at line 147 of file ReceiveMessageRequest.h.

void Aws::SQS::Model::ReceiveMessageRequest::SetMaxNumberOfMessages ( int value )

inline

The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

Definition at line 373 of file ReceiveMessageRequest.h.

void Aws::SQS::Model::ReceiveMessageRequest::SetMessageAttributeNames ( const Aws::Vector< Aws::String > & value )

inline

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "bar.*" to return all message attributes starting with the "bar" prefix.

Definition at line 269 of file ReceiveMessageRequest.h.

void Aws::SQS::Model::ReceiveMessageRequest::SetMessageAttributeNames ( Aws::Vector< Aws::String > && value )

inline

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "bar.*" to return all message attributes starting with the "bar" prefix.

Definition at line 284 of file ReceiveMessageRequest.h.

void Aws::SQS::Model::ReceiveMessageRequest::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 ReceiveMessageRequest.h.

void Aws::SQS::Model::ReceiveMessageRequest::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 ReceiveMessageRequest.h.

void Aws::SQS::Model::ReceiveMessageRequest::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 ReceiveMessageRequest.h.

void Aws::SQS::Model::ReceiveMessageRequest::SetVisibilityTimeout ( int value )

inline

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

Definition at line 394 of file ReceiveMessageRequest.h.

void Aws::SQS::Model::ReceiveMessageRequest::SetWaitTimeSeconds ( int value )

inline

The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

Definition at line 415 of file ReceiveMessageRequest.h.

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

inline

A list of attributes that need to be returned along with each message. These attributes include:

All - returns all values.
ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, DelaySeconds, LastModifiedTimestamp, MaximumMessageSize, MessageRetentionPeriod, Policy, QueueArn, ReceiveMessageWaitTimeSeconds, RedrivePolicy, and VisibilityTimeout) will be ignored.

Definition at line 170 of file ReceiveMessageRequest.h.

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

inline

A list of attributes that need to be returned along with each message. These attributes include:

All - returns all values.
ApproximateFirstReceiveTimestamp - returns the time when the message was first received from the queue (epoch time in milliseconds).
ApproximateReceiveCount - returns the number of times a message has been received from the queue but not deleted.
SenderId - returns the AWS account number (or the IP address, if anonymous access is allowed) of the sender.
SentTimestamp - returns the time when the message was sent to the queue (epoch time in milliseconds).

Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, DelaySeconds, LastModifiedTimestamp, MaximumMessageSize, MessageRetentionPeriod, Policy, QueueArn, ReceiveMessageWaitTimeSeconds, RedrivePolicy, and VisibilityTimeout) will be ignored.

Definition at line 193 of file ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::WithMaxNumberOfMessages ( int value )

inline

The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

Definition at line 380 of file ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::WithMessageAttributeNames ( const Aws::Vector< Aws::String > & value )

inline

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "bar.*" to return all message attributes starting with the "bar" prefix.

Definition at line 299 of file ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::WithMessageAttributeNames ( Aws::Vector< Aws::String > && value )

inline

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name cannot start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "bar.*" to return all message attributes starting with the "bar" prefix.

Definition at line 314 of file ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::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 ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::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 ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::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 ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::WithVisibilityTimeout ( int value )

inline

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

Definition at line 401 of file ReceiveMessageRequest.h.

ReceiveMessageRequest& Aws::SQS::Model::ReceiveMessageRequest::WithWaitTimeSeconds ( int value )

inline

The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

Definition at line 422 of file ReceiveMessageRequest.h.

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

aws-cpp-sdk-sqs/include/aws/sqs/model/ReceiveMessageRequest.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation