AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
ReceiveMessageRequest.h
1
6#pragma once
7#include <aws/sqs/SQS_EXPORTS.h>
8#include <aws/sqs/SQSRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/sqs/model/MessageSystemAttributeName.h>
12#include <utility>
13
14namespace Aws
15{
16namespace SQS
17{
18namespace Model
19{
20
27 {
28 public:
29 AWS_SQS_API ReceiveMessageRequest();
30
31 // Service request name is the Operation name which will send this request out,
32 // each operation should has unique request name, so that we can get operation's name from this request.
33 // Note: this is not true for response, multiple operations may have the same response name,
34 // so we can not get operation's name from response.
35 inline virtual const char* GetServiceRequestName() const override { return "ReceiveMessage"; }
36
37 AWS_SQS_API Aws::String SerializePayload() const override;
38
40
41
43
47 inline const Aws::String& GetQueueUrl() const{ return m_queueUrl; }
48 inline bool QueueUrlHasBeenSet() const { return m_queueUrlHasBeenSet; }
49 inline void SetQueueUrl(const Aws::String& value) { m_queueUrlHasBeenSet = true; m_queueUrl = value; }
50 inline void SetQueueUrl(Aws::String&& value) { m_queueUrlHasBeenSet = true; m_queueUrl = std::move(value); }
51 inline void SetQueueUrl(const char* value) { m_queueUrlHasBeenSet = true; m_queueUrl.assign(value); }
52 inline ReceiveMessageRequest& WithQueueUrl(const Aws::String& value) { SetQueueUrl(value); return *this;}
53 inline ReceiveMessageRequest& WithQueueUrl(Aws::String&& value) { SetQueueUrl(std::move(value)); return *this;}
54 inline ReceiveMessageRequest& WithQueueUrl(const char* value) { SetQueueUrl(value); return *this;}
56
58
88 inline const Aws::Vector<MessageSystemAttributeName>& GetMessageSystemAttributeNames() const{ return m_messageSystemAttributeNames; }
89 inline bool MessageSystemAttributeNamesHasBeenSet() const { return m_messageSystemAttributeNamesHasBeenSet; }
90 inline void SetMessageSystemAttributeNames(const Aws::Vector<MessageSystemAttributeName>& value) { m_messageSystemAttributeNamesHasBeenSet = true; m_messageSystemAttributeNames = value; }
91 inline void SetMessageSystemAttributeNames(Aws::Vector<MessageSystemAttributeName>&& value) { m_messageSystemAttributeNamesHasBeenSet = true; m_messageSystemAttributeNames = std::move(value); }
94 inline ReceiveMessageRequest& AddMessageSystemAttributeNames(const MessageSystemAttributeName& value) { m_messageSystemAttributeNamesHasBeenSet = true; m_messageSystemAttributeNames.push_back(value); return *this; }
95 inline ReceiveMessageRequest& AddMessageSystemAttributeNames(MessageSystemAttributeName&& value) { m_messageSystemAttributeNamesHasBeenSet = true; m_messageSystemAttributeNames.push_back(std::move(value)); return *this; }
97
99
115 inline const Aws::Vector<Aws::String>& GetMessageAttributeNames() const{ return m_messageAttributeNames; }
116 inline bool MessageAttributeNamesHasBeenSet() const { return m_messageAttributeNamesHasBeenSet; }
117 inline void SetMessageAttributeNames(const Aws::Vector<Aws::String>& value) { m_messageAttributeNamesHasBeenSet = true; m_messageAttributeNames = value; }
118 inline void SetMessageAttributeNames(Aws::Vector<Aws::String>&& value) { m_messageAttributeNamesHasBeenSet = true; m_messageAttributeNames = std::move(value); }
121 inline ReceiveMessageRequest& AddMessageAttributeNames(const Aws::String& value) { m_messageAttributeNamesHasBeenSet = true; m_messageAttributeNames.push_back(value); return *this; }
122 inline ReceiveMessageRequest& AddMessageAttributeNames(Aws::String&& value) { m_messageAttributeNamesHasBeenSet = true; m_messageAttributeNames.push_back(std::move(value)); return *this; }
123 inline ReceiveMessageRequest& AddMessageAttributeNames(const char* value) { m_messageAttributeNamesHasBeenSet = true; m_messageAttributeNames.push_back(value); return *this; }
125
127
132 inline int GetMaxNumberOfMessages() const{ return m_maxNumberOfMessages; }
133 inline bool MaxNumberOfMessagesHasBeenSet() const { return m_maxNumberOfMessagesHasBeenSet; }
134 inline void SetMaxNumberOfMessages(int value) { m_maxNumberOfMessagesHasBeenSet = true; m_maxNumberOfMessages = value; }
135 inline ReceiveMessageRequest& WithMaxNumberOfMessages(int value) { SetMaxNumberOfMessages(value); return *this;}
137
139
144 inline int GetVisibilityTimeout() const{ return m_visibilityTimeout; }
145 inline bool VisibilityTimeoutHasBeenSet() const { return m_visibilityTimeoutHasBeenSet; }
146 inline void SetVisibilityTimeout(int value) { m_visibilityTimeoutHasBeenSet = true; m_visibilityTimeout = value; }
147 inline ReceiveMessageRequest& WithVisibilityTimeout(int value) { SetVisibilityTimeout(value); return *this;}
149
151
165 inline int GetWaitTimeSeconds() const{ return m_waitTimeSeconds; }
166 inline bool WaitTimeSecondsHasBeenSet() const { return m_waitTimeSecondsHasBeenSet; }
167 inline void SetWaitTimeSeconds(int value) { m_waitTimeSecondsHasBeenSet = true; m_waitTimeSeconds = value; }
168 inline ReceiveMessageRequest& WithWaitTimeSeconds(int value) { SetWaitTimeSeconds(value); return *this;}
170
172
217 inline const Aws::String& GetReceiveRequestAttemptId() const{ return m_receiveRequestAttemptId; }
218 inline bool ReceiveRequestAttemptIdHasBeenSet() const { return m_receiveRequestAttemptIdHasBeenSet; }
219 inline void SetReceiveRequestAttemptId(const Aws::String& value) { m_receiveRequestAttemptIdHasBeenSet = true; m_receiveRequestAttemptId = value; }
220 inline void SetReceiveRequestAttemptId(Aws::String&& value) { m_receiveRequestAttemptIdHasBeenSet = true; m_receiveRequestAttemptId = std::move(value); }
221 inline void SetReceiveRequestAttemptId(const char* value) { m_receiveRequestAttemptIdHasBeenSet = true; m_receiveRequestAttemptId.assign(value); }
224 inline ReceiveMessageRequest& WithReceiveRequestAttemptId(const char* value) { SetReceiveRequestAttemptId(value); return *this;}
226 private:
227
228 Aws::String m_queueUrl;
229 bool m_queueUrlHasBeenSet = false;
230
231 Aws::Vector<MessageSystemAttributeName> m_messageSystemAttributeNames;
232 bool m_messageSystemAttributeNamesHasBeenSet = false;
233
234 Aws::Vector<Aws::String> m_messageAttributeNames;
235 bool m_messageAttributeNamesHasBeenSet = false;
236
237 int m_maxNumberOfMessages;
238 bool m_maxNumberOfMessagesHasBeenSet = false;
239
240 int m_visibilityTimeout;
241 bool m_visibilityTimeoutHasBeenSet = false;
242
243 int m_waitTimeSeconds;
244 bool m_waitTimeSecondsHasBeenSet = false;
245
246 Aws::String m_receiveRequestAttemptId;
247 bool m_receiveRequestAttemptIdHasBeenSet = false;
248 };
249
250} // namespace Model
251} // namespace SQS
252} // namespace Aws
ReceiveMessageRequest & AddMessageSystemAttributeNames(MessageSystemAttributeName &&value)
const Aws::Vector< MessageSystemAttributeName > & GetMessageSystemAttributeNames() const
ReceiveMessageRequest & WithQueueUrl(const Aws::String &value)
ReceiveMessageRequest & WithQueueUrl(Aws::String &&value)
void SetMessageAttributeNames(const Aws::Vector< Aws::String > &value)
ReceiveMessageRequest & WithMessageAttributeNames(Aws::Vector< Aws::String > &&value)
AWS_SQS_API Aws::String SerializePayload() const override
ReceiveMessageRequest & WithReceiveRequestAttemptId(const char *value)
void SetQueueUrl(const Aws::String &value)
ReceiveMessageRequest & AddMessageAttributeNames(Aws::String &&value)
ReceiveMessageRequest & WithMessageSystemAttributeNames(const Aws::Vector< MessageSystemAttributeName > &value)
ReceiveMessageRequest & WithQueueUrl(const char *value)
const Aws::String & GetReceiveRequestAttemptId() const
ReceiveMessageRequest & AddMessageAttributeNames(const Aws::String &value)
void SetReceiveRequestAttemptId(Aws::String &&value)
void SetMessageSystemAttributeNames(const Aws::Vector< MessageSystemAttributeName > &value)
ReceiveMessageRequest & AddMessageSystemAttributeNames(const MessageSystemAttributeName &value)
void SetMessageSystemAttributeNames(Aws::Vector< MessageSystemAttributeName > &&value)
ReceiveMessageRequest & WithReceiveRequestAttemptId(const Aws::String &value)
ReceiveMessageRequest & WithReceiveRequestAttemptId(Aws::String &&value)
ReceiveMessageRequest & WithVisibilityTimeout(int value)
const Aws::Vector< Aws::String > & GetMessageAttributeNames() const
ReceiveMessageRequest & WithWaitTimeSeconds(int value)
ReceiveMessageRequest & AddMessageAttributeNames(const char *value)
AWS_SQS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
void SetMessageAttributeNames(Aws::Vector< Aws::String > &&value)
ReceiveMessageRequest & WithMessageSystemAttributeNames(Aws::Vector< MessageSystemAttributeName > &&value)
ReceiveMessageRequest & WithMessageAttributeNames(const Aws::Vector< Aws::String > &value)
void SetReceiveRequestAttemptId(const Aws::String &value)
ReceiveMessageRequest & WithMaxNumberOfMessages(int value)
virtual const char * GetServiceRequestName() const override
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector