1 /**
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  * SPDX-License-Identifier: Apache-2.0.
4  */
5 
6 #pragma once
7 #include <aws/pinpoint/Pinpoint_EXPORTS.h>
8 #include <aws/pinpoint/PinpointRequest.h>
9 #include <aws/core/utils/memory/stl/AWSString.h>
10 #include <utility>
11 
12 namespace Aws
13 {
14 namespace Http
15 {
16     class URI;
17 } //namespace Http
18 namespace Pinpoint
19 {
20 namespace Model
21 {
22 
23   /**
24    */
25   class AWS_PINPOINT_API GetCampaignActivitiesRequest : public PinpointRequest
26   {
27   public:
28     GetCampaignActivitiesRequest();
29 
30     // Service request name is the Operation name which will send this request out,
31     // each operation should has unique request name, so that we can get operation's name from this request.
32     // Note: this is not true for response, multiple operations may have the same response name,
33     // so we can not get operation's name from response.
GetServiceRequestName()34     inline virtual const char* GetServiceRequestName() const override { return "GetCampaignActivities"; }
35 
36     Aws::String SerializePayload() const override;
37 
38     void AddQueryStringParameters(Aws::Http::URI& uri) const override;
39 
40 
41     /**
42      * <p>The unique identifier for the application. This identifier is displayed as
43      * the <b>Project ID</b> on the Amazon Pinpoint console.</p>
44      */
GetApplicationId()45     inline const Aws::String& GetApplicationId() const{ return m_applicationId; }
46 
47     /**
48      * <p>The unique identifier for the application. This identifier is displayed as
49      * the <b>Project ID</b> on the Amazon Pinpoint console.</p>
50      */
ApplicationIdHasBeenSet()51     inline bool ApplicationIdHasBeenSet() const { return m_applicationIdHasBeenSet; }
52 
53     /**
54      * <p>The unique identifier for the application. This identifier is displayed as
55      * the <b>Project ID</b> on the Amazon Pinpoint console.</p>
56      */
SetApplicationId(const Aws::String & value)57     inline void SetApplicationId(const Aws::String& value) { m_applicationIdHasBeenSet = true; m_applicationId = value; }
58 
59     /**
60      * <p>The unique identifier for the application. This identifier is displayed as
61      * the <b>Project ID</b> on the Amazon Pinpoint console.</p>
62      */
SetApplicationId(Aws::String && value)63     inline void SetApplicationId(Aws::String&& value) { m_applicationIdHasBeenSet = true; m_applicationId = std::move(value); }
64 
65     /**
66      * <p>The unique identifier for the application. This identifier is displayed as
67      * the <b>Project ID</b> on the Amazon Pinpoint console.</p>
68      */
SetApplicationId(const char * value)69     inline void SetApplicationId(const char* value) { m_applicationIdHasBeenSet = true; m_applicationId.assign(value); }
70 
71     /**
72      * <p>The unique identifier for the application. This identifier is displayed as
73      * the <b>Project ID</b> on the Amazon Pinpoint console.</p>
74      */
WithApplicationId(const Aws::String & value)75     inline GetCampaignActivitiesRequest& WithApplicationId(const Aws::String& value) { SetApplicationId(value); return *this;}
76 
77     /**
78      * <p>The unique identifier for the application. This identifier is displayed as
79      * the <b>Project ID</b> on the Amazon Pinpoint console.</p>
80      */
WithApplicationId(Aws::String && value)81     inline GetCampaignActivitiesRequest& WithApplicationId(Aws::String&& value) { SetApplicationId(std::move(value)); return *this;}
82 
83     /**
84      * <p>The unique identifier for the application. This identifier is displayed as
85      * the <b>Project ID</b> on the Amazon Pinpoint console.</p>
86      */
WithApplicationId(const char * value)87     inline GetCampaignActivitiesRequest& WithApplicationId(const char* value) { SetApplicationId(value); return *this;}
88 
89 
90     /**
91      * <p>The unique identifier for the campaign.</p>
92      */
GetCampaignId()93     inline const Aws::String& GetCampaignId() const{ return m_campaignId; }
94 
95     /**
96      * <p>The unique identifier for the campaign.</p>
97      */
CampaignIdHasBeenSet()98     inline bool CampaignIdHasBeenSet() const { return m_campaignIdHasBeenSet; }
99 
100     /**
101      * <p>The unique identifier for the campaign.</p>
102      */
SetCampaignId(const Aws::String & value)103     inline void SetCampaignId(const Aws::String& value) { m_campaignIdHasBeenSet = true; m_campaignId = value; }
104 
105     /**
106      * <p>The unique identifier for the campaign.</p>
107      */
SetCampaignId(Aws::String && value)108     inline void SetCampaignId(Aws::String&& value) { m_campaignIdHasBeenSet = true; m_campaignId = std::move(value); }
109 
110     /**
111      * <p>The unique identifier for the campaign.</p>
112      */
SetCampaignId(const char * value)113     inline void SetCampaignId(const char* value) { m_campaignIdHasBeenSet = true; m_campaignId.assign(value); }
114 
115     /**
116      * <p>The unique identifier for the campaign.</p>
117      */
WithCampaignId(const Aws::String & value)118     inline GetCampaignActivitiesRequest& WithCampaignId(const Aws::String& value) { SetCampaignId(value); return *this;}
119 
120     /**
121      * <p>The unique identifier for the campaign.</p>
122      */
WithCampaignId(Aws::String && value)123     inline GetCampaignActivitiesRequest& WithCampaignId(Aws::String&& value) { SetCampaignId(std::move(value)); return *this;}
124 
125     /**
126      * <p>The unique identifier for the campaign.</p>
127      */
WithCampaignId(const char * value)128     inline GetCampaignActivitiesRequest& WithCampaignId(const char* value) { SetCampaignId(value); return *this;}
129 
130 
131     /**
132      * <p>The maximum number of items to include in each page of a paginated response.
133      * This parameter is not supported for application, campaign, and journey
134      * metrics.</p>
135      */
GetPageSize()136     inline const Aws::String& GetPageSize() const{ return m_pageSize; }
137 
138     /**
139      * <p>The maximum number of items to include in each page of a paginated response.
140      * This parameter is not supported for application, campaign, and journey
141      * metrics.</p>
142      */
PageSizeHasBeenSet()143     inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; }
144 
145     /**
146      * <p>The maximum number of items to include in each page of a paginated response.
147      * This parameter is not supported for application, campaign, and journey
148      * metrics.</p>
149      */
SetPageSize(const Aws::String & value)150     inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; }
151 
152     /**
153      * <p>The maximum number of items to include in each page of a paginated response.
154      * This parameter is not supported for application, campaign, and journey
155      * metrics.</p>
156      */
SetPageSize(Aws::String && value)157     inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); }
158 
159     /**
160      * <p>The maximum number of items to include in each page of a paginated response.
161      * This parameter is not supported for application, campaign, and journey
162      * metrics.</p>
163      */
SetPageSize(const char * value)164     inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); }
165 
166     /**
167      * <p>The maximum number of items to include in each page of a paginated response.
168      * This parameter is not supported for application, campaign, and journey
169      * metrics.</p>
170      */
WithPageSize(const Aws::String & value)171     inline GetCampaignActivitiesRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;}
172 
173     /**
174      * <p>The maximum number of items to include in each page of a paginated response.
175      * This parameter is not supported for application, campaign, and journey
176      * metrics.</p>
177      */
WithPageSize(Aws::String && value)178     inline GetCampaignActivitiesRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;}
179 
180     /**
181      * <p>The maximum number of items to include in each page of a paginated response.
182      * This parameter is not supported for application, campaign, and journey
183      * metrics.</p>
184      */
WithPageSize(const char * value)185     inline GetCampaignActivitiesRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;}
186 
187 
188     /**
189      * <p>The NextToken string that specifies which page of results to return in a
190      * paginated response.</p>
191      */
GetToken()192     inline const Aws::String& GetToken() const{ return m_token; }
193 
194     /**
195      * <p>The NextToken string that specifies which page of results to return in a
196      * paginated response.</p>
197      */
TokenHasBeenSet()198     inline bool TokenHasBeenSet() const { return m_tokenHasBeenSet; }
199 
200     /**
201      * <p>The NextToken string that specifies which page of results to return in a
202      * paginated response.</p>
203      */
SetToken(const Aws::String & value)204     inline void SetToken(const Aws::String& value) { m_tokenHasBeenSet = true; m_token = value; }
205 
206     /**
207      * <p>The NextToken string that specifies which page of results to return in a
208      * paginated response.</p>
209      */
SetToken(Aws::String && value)210     inline void SetToken(Aws::String&& value) { m_tokenHasBeenSet = true; m_token = std::move(value); }
211 
212     /**
213      * <p>The NextToken string that specifies which page of results to return in a
214      * paginated response.</p>
215      */
SetToken(const char * value)216     inline void SetToken(const char* value) { m_tokenHasBeenSet = true; m_token.assign(value); }
217 
218     /**
219      * <p>The NextToken string that specifies which page of results to return in a
220      * paginated response.</p>
221      */
WithToken(const Aws::String & value)222     inline GetCampaignActivitiesRequest& WithToken(const Aws::String& value) { SetToken(value); return *this;}
223 
224     /**
225      * <p>The NextToken string that specifies which page of results to return in a
226      * paginated response.</p>
227      */
WithToken(Aws::String && value)228     inline GetCampaignActivitiesRequest& WithToken(Aws::String&& value) { SetToken(std::move(value)); return *this;}
229 
230     /**
231      * <p>The NextToken string that specifies which page of results to return in a
232      * paginated response.</p>
233      */
WithToken(const char * value)234     inline GetCampaignActivitiesRequest& WithToken(const char* value) { SetToken(value); return *this;}
235 
236   private:
237 
238     Aws::String m_applicationId;
239     bool m_applicationIdHasBeenSet;
240 
241     Aws::String m_campaignId;
242     bool m_campaignIdHasBeenSet;
243 
244     Aws::String m_pageSize;
245     bool m_pageSizeHasBeenSet;
246 
247     Aws::String m_token;
248     bool m_tokenHasBeenSet;
249   };
250 
251 } // namespace Model
252 } // namespace Pinpoint
253 } // namespace Aws
254