AWS SDK for C++  1.8.186
AWS SDK for C++
ReceiveMessageRequest.h
Go to the documentation of this file.
1 
6 #pragma once
7 #include <aws/sqs/SQS_EXPORTS.h>
8 #include <aws/sqs/SQSRequest.h>
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace SQS
17 {
18 namespace Model
19 {
20 
27  {
28  public:
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::String SerializePayload() const override;
38 
39  protected:
40  void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
41 
42  public:
43 
48  inline const Aws::String& GetQueueUrl() const{ return m_queueUrl; }
49 
54  inline bool QueueUrlHasBeenSet() const { return m_queueUrlHasBeenSet; }
55 
60  inline void SetQueueUrl(const Aws::String& value) { m_queueUrlHasBeenSet = true; m_queueUrl = value; }
61 
66  inline void SetQueueUrl(Aws::String&& value) { m_queueUrlHasBeenSet = true; m_queueUrl = std::move(value); }
67 
72  inline void SetQueueUrl(const char* value) { m_queueUrlHasBeenSet = true; m_queueUrl.assign(value); }
73 
78  inline ReceiveMessageRequest& WithQueueUrl(const Aws::String& value) { SetQueueUrl(value); return *this;}
79 
84  inline ReceiveMessageRequest& WithQueueUrl(Aws::String&& value) { SetQueueUrl(std::move(value)); return *this;}
85 
90  inline ReceiveMessageRequest& WithQueueUrl(const char* value) { SetQueueUrl(value); return *this;}
91 
92 
117  inline const Aws::Vector<QueueAttributeName>& GetAttributeNames() const{ return m_attributeNames; }
118 
143  inline bool AttributeNamesHasBeenSet() const { return m_attributeNamesHasBeenSet; }
144 
169  inline void SetAttributeNames(const Aws::Vector<QueueAttributeName>& value) { m_attributeNamesHasBeenSet = true; m_attributeNames = value; }
170 
195  inline void SetAttributeNames(Aws::Vector<QueueAttributeName>&& value) { m_attributeNamesHasBeenSet = true; m_attributeNames = std::move(value); }
196 
221  inline ReceiveMessageRequest& WithAttributeNames(const Aws::Vector<QueueAttributeName>& value) { SetAttributeNames(value); return *this;}
222 
247  inline ReceiveMessageRequest& WithAttributeNames(Aws::Vector<QueueAttributeName>&& value) { SetAttributeNames(std::move(value)); return *this;}
248 
273  inline ReceiveMessageRequest& AddAttributeNames(const QueueAttributeName& value) { m_attributeNamesHasBeenSet = true; m_attributeNames.push_back(value); return *this; }
274 
299  inline ReceiveMessageRequest& AddAttributeNames(QueueAttributeName&& value) { m_attributeNamesHasBeenSet = true; m_attributeNames.push_back(std::move(value)); return *this; }
300 
301 
318  inline const Aws::Vector<Aws::String>& GetMessageAttributeNames() const{ return m_messageAttributeNames; }
319 
336  inline bool MessageAttributeNamesHasBeenSet() const { return m_messageAttributeNamesHasBeenSet; }
337 
354  inline void SetMessageAttributeNames(const Aws::Vector<Aws::String>& value) { m_messageAttributeNamesHasBeenSet = true; m_messageAttributeNames = value; }
355 
372  inline void SetMessageAttributeNames(Aws::Vector<Aws::String>&& value) { m_messageAttributeNamesHasBeenSet = true; m_messageAttributeNames = std::move(value); }
373 
390  inline ReceiveMessageRequest& WithMessageAttributeNames(const Aws::Vector<Aws::String>& value) { SetMessageAttributeNames(value); return *this;}
391 
408  inline ReceiveMessageRequest& WithMessageAttributeNames(Aws::Vector<Aws::String>&& value) { SetMessageAttributeNames(std::move(value)); return *this;}
409 
426  inline ReceiveMessageRequest& AddMessageAttributeNames(const Aws::String& value) { m_messageAttributeNamesHasBeenSet = true; m_messageAttributeNames.push_back(value); return *this; }
427 
444  inline ReceiveMessageRequest& AddMessageAttributeNames(Aws::String&& value) { m_messageAttributeNamesHasBeenSet = true; m_messageAttributeNames.push_back(std::move(value)); return *this; }
445 
462  inline ReceiveMessageRequest& AddMessageAttributeNames(const char* value) { m_messageAttributeNamesHasBeenSet = true; m_messageAttributeNames.push_back(value); return *this; }
463 
464 
470  inline int GetMaxNumberOfMessages() const{ return m_maxNumberOfMessages; }
471 
477  inline bool MaxNumberOfMessagesHasBeenSet() const { return m_maxNumberOfMessagesHasBeenSet; }
478 
484  inline void SetMaxNumberOfMessages(int value) { m_maxNumberOfMessagesHasBeenSet = true; m_maxNumberOfMessages = value; }
485 
491  inline ReceiveMessageRequest& WithMaxNumberOfMessages(int value) { SetMaxNumberOfMessages(value); return *this;}
492 
493 
499  inline int GetVisibilityTimeout() const{ return m_visibilityTimeout; }
500 
506  inline bool VisibilityTimeoutHasBeenSet() const { return m_visibilityTimeoutHasBeenSet; }
507 
513  inline void SetVisibilityTimeout(int value) { m_visibilityTimeoutHasBeenSet = true; m_visibilityTimeout = value; }
514 
520  inline ReceiveMessageRequest& WithVisibilityTimeout(int value) { SetVisibilityTimeout(value); return *this;}
521 
522 
537  inline int GetWaitTimeSeconds() const{ return m_waitTimeSeconds; }
538 
553  inline bool WaitTimeSecondsHasBeenSet() const { return m_waitTimeSecondsHasBeenSet; }
554 
569  inline void SetWaitTimeSeconds(int value) { m_waitTimeSecondsHasBeenSet = true; m_waitTimeSeconds = value; }
570 
585  inline ReceiveMessageRequest& WithWaitTimeSeconds(int value) { SetWaitTimeSeconds(value); return *this;}
586 
587 
637  inline const Aws::String& GetReceiveRequestAttemptId() const{ return m_receiveRequestAttemptId; }
638 
688  inline bool ReceiveRequestAttemptIdHasBeenSet() const { return m_receiveRequestAttemptIdHasBeenSet; }
689 
739  inline void SetReceiveRequestAttemptId(const Aws::String& value) { m_receiveRequestAttemptIdHasBeenSet = true; m_receiveRequestAttemptId = value; }
740 
790  inline void SetReceiveRequestAttemptId(Aws::String&& value) { m_receiveRequestAttemptIdHasBeenSet = true; m_receiveRequestAttemptId = std::move(value); }
791 
841  inline void SetReceiveRequestAttemptId(const char* value) { m_receiveRequestAttemptIdHasBeenSet = true; m_receiveRequestAttemptId.assign(value); }
842 
892  inline ReceiveMessageRequest& WithReceiveRequestAttemptId(const Aws::String& value) { SetReceiveRequestAttemptId(value); return *this;}
893 
943  inline ReceiveMessageRequest& WithReceiveRequestAttemptId(Aws::String&& value) { SetReceiveRequestAttemptId(std::move(value)); return *this;}
944 
994  inline ReceiveMessageRequest& WithReceiveRequestAttemptId(const char* value) { SetReceiveRequestAttemptId(value); return *this;}
995 
996  private:
997 
998  Aws::String m_queueUrl;
999  bool m_queueUrlHasBeenSet;
1000 
1001  Aws::Vector<QueueAttributeName> m_attributeNames;
1002  bool m_attributeNamesHasBeenSet;
1003 
1004  Aws::Vector<Aws::String> m_messageAttributeNames;
1005  bool m_messageAttributeNamesHasBeenSet;
1006 
1007  int m_maxNumberOfMessages;
1008  bool m_maxNumberOfMessagesHasBeenSet;
1009 
1010  int m_visibilityTimeout;
1011  bool m_visibilityTimeoutHasBeenSet;
1012 
1013  int m_waitTimeSeconds;
1014  bool m_waitTimeSecondsHasBeenSet;
1015 
1016  Aws::String m_receiveRequestAttemptId;
1017  bool m_receiveRequestAttemptIdHasBeenSet;
1018  };
1019 
1020 } // namespace Model
1021 } // namespace SQS
1022 } // namespace Aws
Aws::SQS::Model::ReceiveMessageRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: ReceiveMessageRequest.h:35
Aws::SQS::Model::ReceiveMessageRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::SQS::Model::ReceiveMessageRequest::GetMessageAttributeNames
const Aws::Vector< Aws::String > & GetMessageAttributeNames() const
Definition: ReceiveMessageRequest.h:318
Aws::SQS::Model::ReceiveMessageRequest::WithQueueUrl
ReceiveMessageRequest & WithQueueUrl(const Aws::String &value)
Definition: ReceiveMessageRequest.h:78
Aws::Http::URI
Definition: URI.h:32
Aws::SQS::Model::ReceiveMessageRequest::GetAttributeNames
const Aws::Vector< QueueAttributeName > & GetAttributeNames() const
Definition: ReceiveMessageRequest.h:117
Aws::SQS::Model::ReceiveMessageRequest::WithVisibilityTimeout
ReceiveMessageRequest & WithVisibilityTimeout(int value)
Definition: ReceiveMessageRequest.h:520
Aws::SQS::Model::ReceiveMessageRequest::SetMessageAttributeNames
void SetMessageAttributeNames(const Aws::Vector< Aws::String > &value)
Definition: ReceiveMessageRequest.h:354
Aws::SQS::Model::ReceiveMessageRequest::AddMessageAttributeNames
ReceiveMessageRequest & AddMessageAttributeNames(const char *value)
Definition: ReceiveMessageRequest.h:462
Aws::SQS::Model::ReceiveMessageRequest
Definition: ReceiveMessageRequest.h:27
Aws::SQS::Model::ReceiveMessageRequest::AttributeNamesHasBeenSet
bool AttributeNamesHasBeenSet() const
Definition: ReceiveMessageRequest.h:143
Aws::SQS::Model::ReceiveMessageRequest::ReceiveMessageRequest
ReceiveMessageRequest()
Aws::SQS::Model::ReceiveMessageRequest::SetQueueUrl
void SetQueueUrl(const Aws::String &value)
Definition: ReceiveMessageRequest.h:60
Aws::SQS::Model::ReceiveMessageRequest::GetWaitTimeSeconds
int GetWaitTimeSeconds() const
Definition: ReceiveMessageRequest.h:537
Aws::SQS::Model::ReceiveMessageRequest::WaitTimeSecondsHasBeenSet
bool WaitTimeSecondsHasBeenSet() const
Definition: ReceiveMessageRequest.h:553
Aws::SQS::Model::ReceiveMessageRequest::SetVisibilityTimeout
void SetVisibilityTimeout(int value)
Definition: ReceiveMessageRequest.h:513
Aws::SQS::Model::ReceiveMessageRequest::QueueUrlHasBeenSet
bool QueueUrlHasBeenSet() const
Definition: ReceiveMessageRequest.h:54
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::SQS::Model::ReceiveMessageRequest::ReceiveRequestAttemptIdHasBeenSet
bool ReceiveRequestAttemptIdHasBeenSet() const
Definition: ReceiveMessageRequest.h:688
AWSVector.h
Aws::SQS::Model::ReceiveMessageRequest::AddMessageAttributeNames
ReceiveMessageRequest & AddMessageAttributeNames(Aws::String &&value)
Definition: ReceiveMessageRequest.h:444
Aws::SQS::Model::ReceiveMessageRequest::SetMessageAttributeNames
void SetMessageAttributeNames(Aws::Vector< Aws::String > &&value)
Definition: ReceiveMessageRequest.h:372
Aws::SQS::Model::ReceiveMessageRequest::MessageAttributeNamesHasBeenSet
bool MessageAttributeNamesHasBeenSet() const
Definition: ReceiveMessageRequest.h:336
Aws::SQS::Model::ReceiveMessageRequest::AddAttributeNames
ReceiveMessageRequest & AddAttributeNames(const QueueAttributeName &value)
Definition: ReceiveMessageRequest.h:273
Aws::SQS::Model::ReceiveMessageRequest::WithWaitTimeSeconds
ReceiveMessageRequest & WithWaitTimeSeconds(int value)
Definition: ReceiveMessageRequest.h:585
Aws::SQS::Model::ReceiveMessageRequest::SetWaitTimeSeconds
void SetWaitTimeSeconds(int value)
Definition: ReceiveMessageRequest.h:569
Aws::SQS::Model::ReceiveMessageRequest::AddAttributeNames
ReceiveMessageRequest & AddAttributeNames(QueueAttributeName &&value)
Definition: ReceiveMessageRequest.h:299
Aws::SQS::Model::ReceiveMessageRequest::SetAttributeNames
void SetAttributeNames(const Aws::Vector< QueueAttributeName > &value)
Definition: ReceiveMessageRequest.h:169
Aws::SQS::Model::ReceiveMessageRequest::GetMaxNumberOfMessages
int GetMaxNumberOfMessages() const
Definition: ReceiveMessageRequest.h:470
Aws::SQS::Model::ReceiveMessageRequest::WithMessageAttributeNames
ReceiveMessageRequest & WithMessageAttributeNames(Aws::Vector< Aws::String > &&value)
Definition: ReceiveMessageRequest.h:408
Aws::SQS::Model::ReceiveMessageRequest::WithReceiveRequestAttemptId
ReceiveMessageRequest & WithReceiveRequestAttemptId(const Aws::String &value)
Definition: ReceiveMessageRequest.h:892
Aws::SQS::Model::ReceiveMessageRequest::GetVisibilityTimeout
int GetVisibilityTimeout() const
Definition: ReceiveMessageRequest.h:499
Aws::SQS::Model::ReceiveMessageRequest::SetReceiveRequestAttemptId
void SetReceiveRequestAttemptId(const Aws::String &value)
Definition: ReceiveMessageRequest.h:739
Aws::SQS::Model::ReceiveMessageRequest::DumpBodyToUrl
void DumpBodyToUrl(Aws::Http::URI &uri) const override
Aws::SQS::Model::QueueAttributeName
QueueAttributeName
Definition: QueueAttributeName.h:17
Aws::SQS::Model::ReceiveMessageRequest::VisibilityTimeoutHasBeenSet
bool VisibilityTimeoutHasBeenSet() const
Definition: ReceiveMessageRequest.h:506
Aws::SQS::Model::ReceiveMessageRequest::WithAttributeNames
ReceiveMessageRequest & WithAttributeNames(const Aws::Vector< QueueAttributeName > &value)
Definition: ReceiveMessageRequest.h:221
Aws::SQS::Model::ReceiveMessageRequest::WithAttributeNames
ReceiveMessageRequest & WithAttributeNames(Aws::Vector< QueueAttributeName > &&value)
Definition: ReceiveMessageRequest.h:247
Aws::Chime::Model::NotificationTarget::NOT_SET
@ NOT_SET
AWSString.h
Aws::SQS::Model::ReceiveMessageRequest::WithMaxNumberOfMessages
ReceiveMessageRequest & WithMaxNumberOfMessages(int value)
Definition: ReceiveMessageRequest.h:491
AWS_SQS_API
#define AWS_SQS_API
Definition: SQS_EXPORTS.h:28
Aws::SQS::Model::ReceiveMessageRequest::GetQueueUrl
const Aws::String & GetQueueUrl() const
Definition: ReceiveMessageRequest.h:48
Aws::SQS::Model::ReceiveMessageRequest::WithReceiveRequestAttemptId
ReceiveMessageRequest & WithReceiveRequestAttemptId(Aws::String &&value)
Definition: ReceiveMessageRequest.h:943
QueueAttributeName.h
Aws::SQS::Model::ReceiveMessageRequest::WithQueueUrl
ReceiveMessageRequest & WithQueueUrl(const char *value)
Definition: ReceiveMessageRequest.h:90
SQS_EXPORTS.h
Aws::SQS::Model::ReceiveMessageRequest::SetAttributeNames
void SetAttributeNames(Aws::Vector< QueueAttributeName > &&value)
Definition: ReceiveMessageRequest.h:195
Aws::SQS::SQSRequest
Definition: SQSRequest.h:17
Aws::SQS::Model::ReceiveMessageRequest::SetQueueUrl
void SetQueueUrl(const char *value)
Definition: ReceiveMessageRequest.h:72
Aws
Definition: AccessManagementClient.h:15
Aws::SQS::Model::ReceiveMessageRequest::SetReceiveRequestAttemptId
void SetReceiveRequestAttemptId(const char *value)
Definition: ReceiveMessageRequest.h:841
Aws::SQS::Model::ReceiveMessageRequest::SetReceiveRequestAttemptId
void SetReceiveRequestAttemptId(Aws::String &&value)
Definition: ReceiveMessageRequest.h:790
Aws::SQS::Model::ReceiveMessageRequest::GetReceiveRequestAttemptId
const Aws::String & GetReceiveRequestAttemptId() const
Definition: ReceiveMessageRequest.h:637
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::SQS::Model::ReceiveMessageRequest::WithReceiveRequestAttemptId
ReceiveMessageRequest & WithReceiveRequestAttemptId(const char *value)
Definition: ReceiveMessageRequest.h:994
Aws::SQS::Model::ReceiveMessageRequest::WithQueueUrl
ReceiveMessageRequest & WithQueueUrl(Aws::String &&value)
Definition: ReceiveMessageRequest.h:84
Aws::SQS::Model::ReceiveMessageRequest::MaxNumberOfMessagesHasBeenSet
bool MaxNumberOfMessagesHasBeenSet() const
Definition: ReceiveMessageRequest.h:477
SQSRequest.h
Aws::SQS::Model::ReceiveMessageRequest::WithMessageAttributeNames
ReceiveMessageRequest & WithMessageAttributeNames(const Aws::Vector< Aws::String > &value)
Definition: ReceiveMessageRequest.h:390
Aws::SQS::Model::ReceiveMessageRequest::SetMaxNumberOfMessages
void SetMaxNumberOfMessages(int value)
Definition: ReceiveMessageRequest.h:484
Aws::SQS::Model::ReceiveMessageRequest::SetQueueUrl
void SetQueueUrl(Aws::String &&value)
Definition: ReceiveMessageRequest.h:66
Aws::SQS::Model::ReceiveMessageRequest::AddMessageAttributeNames
ReceiveMessageRequest & AddMessageAttributeNames(const Aws::String &value)
Definition: ReceiveMessageRequest.h:426