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 GetJourneyExecutionActivityMetricsRequest : public PinpointRequest
26   {
27   public:
28     GetJourneyExecutionActivityMetricsRequest();
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 "GetJourneyExecutionActivityMetrics"; }
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 GetJourneyExecutionActivityMetricsRequest& 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 GetJourneyExecutionActivityMetricsRequest& 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 GetJourneyExecutionActivityMetricsRequest& WithApplicationId(const char* value) { SetApplicationId(value); return *this;}
88 
89 
90     /**
91      * <p>The unique identifier for the journey activity.</p>
92      */
GetJourneyActivityId()93     inline const Aws::String& GetJourneyActivityId() const{ return m_journeyActivityId; }
94 
95     /**
96      * <p>The unique identifier for the journey activity.</p>
97      */
JourneyActivityIdHasBeenSet()98     inline bool JourneyActivityIdHasBeenSet() const { return m_journeyActivityIdHasBeenSet; }
99 
100     /**
101      * <p>The unique identifier for the journey activity.</p>
102      */
SetJourneyActivityId(const Aws::String & value)103     inline void SetJourneyActivityId(const Aws::String& value) { m_journeyActivityIdHasBeenSet = true; m_journeyActivityId = value; }
104 
105     /**
106      * <p>The unique identifier for the journey activity.</p>
107      */
SetJourneyActivityId(Aws::String && value)108     inline void SetJourneyActivityId(Aws::String&& value) { m_journeyActivityIdHasBeenSet = true; m_journeyActivityId = std::move(value); }
109 
110     /**
111      * <p>The unique identifier for the journey activity.</p>
112      */
SetJourneyActivityId(const char * value)113     inline void SetJourneyActivityId(const char* value) { m_journeyActivityIdHasBeenSet = true; m_journeyActivityId.assign(value); }
114 
115     /**
116      * <p>The unique identifier for the journey activity.</p>
117      */
WithJourneyActivityId(const Aws::String & value)118     inline GetJourneyExecutionActivityMetricsRequest& WithJourneyActivityId(const Aws::String& value) { SetJourneyActivityId(value); return *this;}
119 
120     /**
121      * <p>The unique identifier for the journey activity.</p>
122      */
WithJourneyActivityId(Aws::String && value)123     inline GetJourneyExecutionActivityMetricsRequest& WithJourneyActivityId(Aws::String&& value) { SetJourneyActivityId(std::move(value)); return *this;}
124 
125     /**
126      * <p>The unique identifier for the journey activity.</p>
127      */
WithJourneyActivityId(const char * value)128     inline GetJourneyExecutionActivityMetricsRequest& WithJourneyActivityId(const char* value) { SetJourneyActivityId(value); return *this;}
129 
130 
131     /**
132      * <p>The unique identifier for the journey.</p>
133      */
GetJourneyId()134     inline const Aws::String& GetJourneyId() const{ return m_journeyId; }
135 
136     /**
137      * <p>The unique identifier for the journey.</p>
138      */
JourneyIdHasBeenSet()139     inline bool JourneyIdHasBeenSet() const { return m_journeyIdHasBeenSet; }
140 
141     /**
142      * <p>The unique identifier for the journey.</p>
143      */
SetJourneyId(const Aws::String & value)144     inline void SetJourneyId(const Aws::String& value) { m_journeyIdHasBeenSet = true; m_journeyId = value; }
145 
146     /**
147      * <p>The unique identifier for the journey.</p>
148      */
SetJourneyId(Aws::String && value)149     inline void SetJourneyId(Aws::String&& value) { m_journeyIdHasBeenSet = true; m_journeyId = std::move(value); }
150 
151     /**
152      * <p>The unique identifier for the journey.</p>
153      */
SetJourneyId(const char * value)154     inline void SetJourneyId(const char* value) { m_journeyIdHasBeenSet = true; m_journeyId.assign(value); }
155 
156     /**
157      * <p>The unique identifier for the journey.</p>
158      */
WithJourneyId(const Aws::String & value)159     inline GetJourneyExecutionActivityMetricsRequest& WithJourneyId(const Aws::String& value) { SetJourneyId(value); return *this;}
160 
161     /**
162      * <p>The unique identifier for the journey.</p>
163      */
WithJourneyId(Aws::String && value)164     inline GetJourneyExecutionActivityMetricsRequest& WithJourneyId(Aws::String&& value) { SetJourneyId(std::move(value)); return *this;}
165 
166     /**
167      * <p>The unique identifier for the journey.</p>
168      */
WithJourneyId(const char * value)169     inline GetJourneyExecutionActivityMetricsRequest& WithJourneyId(const char* value) { SetJourneyId(value); return *this;}
170 
171 
172     /**
173      * <p>The  string that specifies which page of results to return in a paginated
174      * response. This parameter is not supported for application, campaign, and journey
175      * metrics.</p>
176      */
GetNextToken()177     inline const Aws::String& GetNextToken() const{ return m_nextToken; }
178 
179     /**
180      * <p>The  string that specifies which page of results to return in a paginated
181      * response. This parameter is not supported for application, campaign, and journey
182      * metrics.</p>
183      */
NextTokenHasBeenSet()184     inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
185 
186     /**
187      * <p>The  string that specifies which page of results to return in a paginated
188      * response. This parameter is not supported for application, campaign, and journey
189      * metrics.</p>
190      */
SetNextToken(const Aws::String & value)191     inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
192 
193     /**
194      * <p>The  string that specifies which page of results to return in a paginated
195      * response. This parameter is not supported for application, campaign, and journey
196      * metrics.</p>
197      */
SetNextToken(Aws::String && value)198     inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
199 
200     /**
201      * <p>The  string that specifies which page of results to return in a paginated
202      * response. This parameter is not supported for application, campaign, and journey
203      * metrics.</p>
204      */
SetNextToken(const char * value)205     inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
206 
207     /**
208      * <p>The  string that specifies which page of results to return in a paginated
209      * response. This parameter is not supported for application, campaign, and journey
210      * metrics.</p>
211      */
WithNextToken(const Aws::String & value)212     inline GetJourneyExecutionActivityMetricsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
213 
214     /**
215      * <p>The  string that specifies which page of results to return in a paginated
216      * response. This parameter is not supported for application, campaign, and journey
217      * metrics.</p>
218      */
WithNextToken(Aws::String && value)219     inline GetJourneyExecutionActivityMetricsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
220 
221     /**
222      * <p>The  string that specifies which page of results to return in a paginated
223      * response. This parameter is not supported for application, campaign, and journey
224      * metrics.</p>
225      */
WithNextToken(const char * value)226     inline GetJourneyExecutionActivityMetricsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
227 
228 
229     /**
230      * <p>The maximum number of items to include in each page of a paginated response.
231      * This parameter is not supported for application, campaign, and journey
232      * metrics.</p>
233      */
GetPageSize()234     inline const Aws::String& GetPageSize() const{ return m_pageSize; }
235 
236     /**
237      * <p>The maximum number of items to include in each page of a paginated response.
238      * This parameter is not supported for application, campaign, and journey
239      * metrics.</p>
240      */
PageSizeHasBeenSet()241     inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; }
242 
243     /**
244      * <p>The maximum number of items to include in each page of a paginated response.
245      * This parameter is not supported for application, campaign, and journey
246      * metrics.</p>
247      */
SetPageSize(const Aws::String & value)248     inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; }
249 
250     /**
251      * <p>The maximum number of items to include in each page of a paginated response.
252      * This parameter is not supported for application, campaign, and journey
253      * metrics.</p>
254      */
SetPageSize(Aws::String && value)255     inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); }
256 
257     /**
258      * <p>The maximum number of items to include in each page of a paginated response.
259      * This parameter is not supported for application, campaign, and journey
260      * metrics.</p>
261      */
SetPageSize(const char * value)262     inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); }
263 
264     /**
265      * <p>The maximum number of items to include in each page of a paginated response.
266      * This parameter is not supported for application, campaign, and journey
267      * metrics.</p>
268      */
WithPageSize(const Aws::String & value)269     inline GetJourneyExecutionActivityMetricsRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;}
270 
271     /**
272      * <p>The maximum number of items to include in each page of a paginated response.
273      * This parameter is not supported for application, campaign, and journey
274      * metrics.</p>
275      */
WithPageSize(Aws::String && value)276     inline GetJourneyExecutionActivityMetricsRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;}
277 
278     /**
279      * <p>The maximum number of items to include in each page of a paginated response.
280      * This parameter is not supported for application, campaign, and journey
281      * metrics.</p>
282      */
WithPageSize(const char * value)283     inline GetJourneyExecutionActivityMetricsRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;}
284 
285   private:
286 
287     Aws::String m_applicationId;
288     bool m_applicationIdHasBeenSet;
289 
290     Aws::String m_journeyActivityId;
291     bool m_journeyActivityIdHasBeenSet;
292 
293     Aws::String m_journeyId;
294     bool m_journeyIdHasBeenSet;
295 
296     Aws::String m_nextToken;
297     bool m_nextTokenHasBeenSet;
298 
299     Aws::String m_pageSize;
300     bool m_pageSizeHasBeenSet;
301   };
302 
303 } // namespace Model
304 } // namespace Pinpoint
305 } // namespace Aws
306