/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace SQS { namespace Model { /** *

*/ class ReceiveMessageRequest : public SQSRequest { public: AWS_SQS_API ReceiveMessageRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ReceiveMessage"; } AWS_SQS_API Aws::String SerializePayload() const override; protected: AWS_SQS_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The URL of the Amazon SQS queue from which messages are received.

Queue URLs and names are case-sensitive.

*/ inline const Aws::String& GetQueueUrl() const{ return m_queueUrl; } /** *

The URL of the Amazon SQS queue from which messages are received.

Queue URLs and names are case-sensitive.

*/ inline bool QueueUrlHasBeenSet() const { return m_queueUrlHasBeenSet; } /** *

The URL of the Amazon SQS queue from which messages are received.

Queue URLs and names are case-sensitive.

*/ inline void SetQueueUrl(const Aws::String& value) { m_queueUrlHasBeenSet = true; m_queueUrl = value; } /** *

The URL of the Amazon SQS queue from which messages are received.

Queue URLs and names are case-sensitive.

*/ inline void SetQueueUrl(Aws::String&& value) { m_queueUrlHasBeenSet = true; m_queueUrl = std::move(value); } /** *

The URL of the Amazon SQS queue from which messages are received.

Queue URLs and names are case-sensitive.

*/ inline void SetQueueUrl(const char* value) { m_queueUrlHasBeenSet = true; m_queueUrl.assign(value); } /** *

The URL of the Amazon SQS queue from which messages are received.

Queue URLs and names are case-sensitive.

*/ inline ReceiveMessageRequest& WithQueueUrl(const Aws::String& value) { SetQueueUrl(value); return *this;} /** *

The URL of the Amazon SQS queue from which messages are received.

Queue URLs and names are case-sensitive.

*/ inline ReceiveMessageRequest& WithQueueUrl(Aws::String&& value) { SetQueueUrl(std::move(value)); return *this;} /** *

The URL of the Amazon SQS queue from which messages are received.

Queue URLs and names are case-sensitive.

*/ inline ReceiveMessageRequest& WithQueueUrl(const char* value) { SetQueueUrl(value); return *this;} /** *

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

All – Returns all values.
*
ApproximateFirstReceiveTimestamp – Returns the time * the message was first received from the queue (epoch time in * milliseconds).
ApproximateReceiveCount – Returns * the number of times a message has been received across all queues but not * deleted.
AWSTraceHeader – Returns the X-Ray * trace header string.
SenderId
- *
  For a user, returns the user ID, for example * ABCDEFGHI1JKLMNOPQ23R.
- For an IAM role, returns * the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
  *
SentTimestamp – Returns the time the * message was sent to the queue (epoch time in * milliseconds).
SqsManagedSseEnabled – Enables * server-side queue encryption using SQS owned encryption keys. Only one * server-side encryption option is supported per queue (for example, SSE-KMS * or SSE-SQS).
*
MessageDeduplicationId – Returns the value provided * by the producer that calls the SendMessage action.
*
MessageGroupId – Returns the value provided by the * producer that calls the SendMessage action. Messages with * the same MessageGroupId are returned in sequence.
*
SequenceNumber – Returns the value provided by Amazon SQS.
*

*/ inline const Aws::Vector& GetAttributeNames() const{ return m_attributeNames; } /** *

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

All – Returns all values.
*
ApproximateFirstReceiveTimestamp – Returns the time * the message was first received from the queue (epoch time in * milliseconds).
ApproximateReceiveCount – Returns * the number of times a message has been received across all queues but not * deleted.
AWSTraceHeader – Returns the X-Ray * trace header string.
SenderId
- *
  For a user, returns the user ID, for example * ABCDEFGHI1JKLMNOPQ23R.
- For an IAM role, returns * the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
  *
SentTimestamp – Returns the time the * message was sent to the queue (epoch time in * milliseconds).
SqsManagedSseEnabled – Enables * server-side queue encryption using SQS owned encryption keys. Only one * server-side encryption option is supported per queue (for example, SSE-KMS * or SSE-SQS).
*
MessageDeduplicationId – Returns the value provided * by the producer that calls the SendMessage action.
*
MessageGroupId – Returns the value provided by the * producer that calls the SendMessage action. Messages with * the same MessageGroupId are returned in sequence.
*
SequenceNumber – Returns the value provided by Amazon SQS.
*

*/ inline bool AttributeNamesHasBeenSet() const { return m_attributeNamesHasBeenSet; } /** *

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

All – Returns all values.
*
ApproximateFirstReceiveTimestamp – Returns the time * the message was first received from the queue (epoch time in * milliseconds).
ApproximateReceiveCount – Returns * the number of times a message has been received across all queues but not * deleted.
AWSTraceHeader – Returns the X-Ray * trace header string.
SenderId
- *
  For a user, returns the user ID, for example * ABCDEFGHI1JKLMNOPQ23R.
- For an IAM role, returns * the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
  *
SentTimestamp – Returns the time the * message was sent to the queue (epoch time in * milliseconds).
SqsManagedSseEnabled – Enables * server-side queue encryption using SQS owned encryption keys. Only one * server-side encryption option is supported per queue (for example, SSE-KMS * or SSE-SQS).
*
MessageDeduplicationId – Returns the value provided * by the producer that calls the SendMessage action.
*
MessageGroupId – Returns the value provided by the * producer that calls the SendMessage action. Messages with * the same MessageGroupId are returned in sequence.
*
SequenceNumber – Returns the value provided by Amazon SQS.
*

*/ inline void SetAttributeNames(const Aws::Vector& value) { m_attributeNamesHasBeenSet = true; m_attributeNames = value; } /** *

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

All – Returns all values.
*
ApproximateFirstReceiveTimestamp – Returns the time * the message was first received from the queue (epoch time in * milliseconds).
ApproximateReceiveCount – Returns * the number of times a message has been received across all queues but not * deleted.
AWSTraceHeader – Returns the X-Ray * trace header string.
SenderId
- *
  For a user, returns the user ID, for example * ABCDEFGHI1JKLMNOPQ23R.
- For an IAM role, returns * the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
  *
SentTimestamp – Returns the time the * message was sent to the queue (epoch time in * milliseconds).
SqsManagedSseEnabled – Enables * server-side queue encryption using SQS owned encryption keys. Only one * server-side encryption option is supported per queue (for example, SSE-KMS * or SSE-SQS).
*
MessageDeduplicationId – Returns the value provided * by the producer that calls the SendMessage action.
*
MessageGroupId – Returns the value provided by the * producer that calls the SendMessage action. Messages with * the same MessageGroupId are returned in sequence.
*
SequenceNumber – Returns the value provided by Amazon SQS.
*

*/ inline void SetAttributeNames(Aws::Vector&& value) { m_attributeNamesHasBeenSet = true; m_attributeNames = std::move(value); } /** *

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

All – Returns all values.
*
ApproximateFirstReceiveTimestamp – Returns the time * the message was first received from the queue (epoch time in * milliseconds).
ApproximateReceiveCount – Returns * the number of times a message has been received across all queues but not * deleted.
AWSTraceHeader – Returns the X-Ray * trace header string.
SenderId
- *
  For a user, returns the user ID, for example * ABCDEFGHI1JKLMNOPQ23R.
- For an IAM role, returns * the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
  *
SentTimestamp – Returns the time the * message was sent to the queue (epoch time in * milliseconds).
SqsManagedSseEnabled – Enables * server-side queue encryption using SQS owned encryption keys. Only one * server-side encryption option is supported per queue (for example, SSE-KMS * or SSE-SQS).
*
MessageDeduplicationId – Returns the value provided * by the producer that calls the SendMessage action.
*
MessageGroupId – Returns the value provided by the * producer that calls the SendMessage action. Messages with * the same MessageGroupId are returned in sequence.
*
SequenceNumber – Returns the value provided by Amazon SQS.
*

*/ inline ReceiveMessageRequest& WithAttributeNames(const Aws::Vector& value) { SetAttributeNames(value); return *this;} /** *

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

All – Returns all values.
*
ApproximateFirstReceiveTimestamp – Returns the time * the message was first received from the queue (epoch time in * milliseconds).
ApproximateReceiveCount – Returns * the number of times a message has been received across all queues but not * deleted.
AWSTraceHeader – Returns the X-Ray * trace header string.
SenderId
- *
  For a user, returns the user ID, for example * ABCDEFGHI1JKLMNOPQ23R.
- For an IAM role, returns * the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
  *
SentTimestamp – Returns the time the * message was sent to the queue (epoch time in * milliseconds).
SqsManagedSseEnabled – Enables * server-side queue encryption using SQS owned encryption keys. Only one * server-side encryption option is supported per queue (for example, SSE-KMS * or SSE-SQS).
*
MessageDeduplicationId – Returns the value provided * by the producer that calls the SendMessage action.
*
MessageGroupId – Returns the value provided by the * producer that calls the SendMessage action. Messages with * the same MessageGroupId are returned in sequence.
*
SequenceNumber – Returns the value provided by Amazon SQS.
*

*/ inline ReceiveMessageRequest& WithAttributeNames(Aws::Vector&& value) { SetAttributeNames(std::move(value)); return *this;} /** *

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

All – Returns all values.
*
ApproximateFirstReceiveTimestamp – Returns the time * the message was first received from the queue (epoch time in * milliseconds).
ApproximateReceiveCount – Returns * the number of times a message has been received across all queues but not * deleted.
AWSTraceHeader – Returns the X-Ray * trace header string.
SenderId
- *
  For a user, returns the user ID, for example * ABCDEFGHI1JKLMNOPQ23R.
- For an IAM role, returns * the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
  *
SentTimestamp – Returns the time the * message was sent to the queue (epoch time in * milliseconds).
SqsManagedSseEnabled – Enables * server-side queue encryption using SQS owned encryption keys. Only one * server-side encryption option is supported per queue (for example, SSE-KMS * or SSE-SQS).
*
MessageDeduplicationId – Returns the value provided * by the producer that calls the SendMessage action.
*
MessageGroupId – Returns the value provided by the * producer that calls the SendMessage action. Messages with * the same MessageGroupId are returned in sequence.
*
SequenceNumber – Returns the value provided by Amazon SQS.
*

*/ inline ReceiveMessageRequest& AddAttributeNames(const QueueAttributeName& value) { m_attributeNamesHasBeenSet = true; m_attributeNames.push_back(value); return *this; } /** *

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

All – Returns all values.
*
ApproximateFirstReceiveTimestamp – Returns the time * the message was first received from the queue (epoch time in * milliseconds).
ApproximateReceiveCount – Returns * the number of times a message has been received across all queues but not * deleted.
AWSTraceHeader – Returns the X-Ray * trace header string.
SenderId
- *
  For a user, returns the user ID, for example * ABCDEFGHI1JKLMNOPQ23R.
- For an IAM role, returns * the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
  *
SentTimestamp – Returns the time the * message was sent to the queue (epoch time in * milliseconds).
SqsManagedSseEnabled – Enables * server-side queue encryption using SQS owned encryption keys. Only one * server-side encryption option is supported per queue (for example, SSE-KMS * or SSE-SQS).
*
MessageDeduplicationId – Returns the value provided * by the producer that calls the SendMessage action.
*
MessageGroupId – Returns the value provided by the * producer that calls the SendMessage action. Messages with * the same MessageGroupId are returned in sequence.
*
SequenceNumber – Returns the value provided by Amazon SQS.
*

*/ inline ReceiveMessageRequest& AddAttributeNames(QueueAttributeName&& value) { m_attributeNamesHasBeenSet = true; m_attributeNames.push_back(std::move(value)); return *this; } /** *