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 ListJourneysRequest : public PinpointRequest
26   {
27   public:
28     ListJourneysRequest();
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 "ListJourneys"; }
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 ListJourneysRequest& 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 ListJourneysRequest& 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 ListJourneysRequest& WithApplicationId(const char* value) { SetApplicationId(value); return *this;}
88 
89 
90     /**
91      * <p>The maximum number of items to include in each page of a paginated response.
92      * This parameter is not supported for application, campaign, and journey
93      * metrics.</p>
94      */
GetPageSize()95     inline const Aws::String& GetPageSize() const{ return m_pageSize; }
96 
97     /**
98      * <p>The maximum number of items to include in each page of a paginated response.
99      * This parameter is not supported for application, campaign, and journey
100      * metrics.</p>
101      */
PageSizeHasBeenSet()102     inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; }
103 
104     /**
105      * <p>The maximum number of items to include in each page of a paginated response.
106      * This parameter is not supported for application, campaign, and journey
107      * metrics.</p>
108      */
SetPageSize(const Aws::String & value)109     inline void SetPageSize(const Aws::String& value) { m_pageSizeHasBeenSet = true; m_pageSize = value; }
110 
111     /**
112      * <p>The maximum number of items to include in each page of a paginated response.
113      * This parameter is not supported for application, campaign, and journey
114      * metrics.</p>
115      */
SetPageSize(Aws::String && value)116     inline void SetPageSize(Aws::String&& value) { m_pageSizeHasBeenSet = true; m_pageSize = std::move(value); }
117 
118     /**
119      * <p>The maximum number of items to include in each page of a paginated response.
120      * This parameter is not supported for application, campaign, and journey
121      * metrics.</p>
122      */
SetPageSize(const char * value)123     inline void SetPageSize(const char* value) { m_pageSizeHasBeenSet = true; m_pageSize.assign(value); }
124 
125     /**
126      * <p>The maximum number of items to include in each page of a paginated response.
127      * This parameter is not supported for application, campaign, and journey
128      * metrics.</p>
129      */
WithPageSize(const Aws::String & value)130     inline ListJourneysRequest& WithPageSize(const Aws::String& value) { SetPageSize(value); return *this;}
131 
132     /**
133      * <p>The maximum number of items to include in each page of a paginated response.
134      * This parameter is not supported for application, campaign, and journey
135      * metrics.</p>
136      */
WithPageSize(Aws::String && value)137     inline ListJourneysRequest& WithPageSize(Aws::String&& value) { SetPageSize(std::move(value)); return *this;}
138 
139     /**
140      * <p>The maximum number of items to include in each page of a paginated response.
141      * This parameter is not supported for application, campaign, and journey
142      * metrics.</p>
143      */
WithPageSize(const char * value)144     inline ListJourneysRequest& WithPageSize(const char* value) { SetPageSize(value); return *this;}
145 
146 
147     /**
148      * <p>The NextToken string that specifies which page of results to return in a
149      * paginated response.</p>
150      */
GetToken()151     inline const Aws::String& GetToken() const{ return m_token; }
152 
153     /**
154      * <p>The NextToken string that specifies which page of results to return in a
155      * paginated response.</p>
156      */
TokenHasBeenSet()157     inline bool TokenHasBeenSet() const { return m_tokenHasBeenSet; }
158 
159     /**
160      * <p>The NextToken string that specifies which page of results to return in a
161      * paginated response.</p>
162      */
SetToken(const Aws::String & value)163     inline void SetToken(const Aws::String& value) { m_tokenHasBeenSet = true; m_token = value; }
164 
165     /**
166      * <p>The NextToken string that specifies which page of results to return in a
167      * paginated response.</p>
168      */
SetToken(Aws::String && value)169     inline void SetToken(Aws::String&& value) { m_tokenHasBeenSet = true; m_token = std::move(value); }
170 
171     /**
172      * <p>The NextToken string that specifies which page of results to return in a
173      * paginated response.</p>
174      */
SetToken(const char * value)175     inline void SetToken(const char* value) { m_tokenHasBeenSet = true; m_token.assign(value); }
176 
177     /**
178      * <p>The NextToken string that specifies which page of results to return in a
179      * paginated response.</p>
180      */
WithToken(const Aws::String & value)181     inline ListJourneysRequest& WithToken(const Aws::String& value) { SetToken(value); return *this;}
182 
183     /**
184      * <p>The NextToken string that specifies which page of results to return in a
185      * paginated response.</p>
186      */
WithToken(Aws::String && value)187     inline ListJourneysRequest& WithToken(Aws::String&& value) { SetToken(std::move(value)); return *this;}
188 
189     /**
190      * <p>The NextToken string that specifies which page of results to return in a
191      * paginated response.</p>
192      */
WithToken(const char * value)193     inline ListJourneysRequest& WithToken(const char* value) { SetToken(value); return *this;}
194 
195   private:
196 
197     Aws::String m_applicationId;
198     bool m_applicationIdHasBeenSet;
199 
200     Aws::String m_pageSize;
201     bool m_pageSizeHasBeenSet;
202 
203     Aws::String m_token;
204     bool m_tokenHasBeenSet;
205   };
206 
207 } // namespace Model
208 } // namespace Pinpoint
209 } // namespace Aws
210