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/honeycode/Honeycode_EXPORTS.h>
8 #include <aws/honeycode/HoneycodeRequest.h>
9 #include <aws/core/utils/memory/stl/AWSString.h>
10 #include <aws/core/utils/memory/stl/AWSVector.h>
11 #include <utility>
12 
13 namespace Aws
14 {
15 namespace Honeycode
16 {
17 namespace Model
18 {
19 
20   /**
21    */
22   class AWS_HONEYCODE_API ListTableRowsRequest : public HoneycodeRequest
23   {
24   public:
25     ListTableRowsRequest();
26 
27     // Service request name is the Operation name which will send this request out,
28     // each operation should has unique request name, so that we can get operation's name from this request.
29     // Note: this is not true for response, multiple operations may have the same response name,
30     // so we can not get operation's name from response.
GetServiceRequestName()31     inline virtual const char* GetServiceRequestName() const override { return "ListTableRows"; }
32 
33     Aws::String SerializePayload() const override;
34 
35 
36     /**
37      * <p>The ID of the workbook that contains the table whose rows are being
38      * retrieved.</p> <p> If a workbook with the specified id could not be found, this
39      * API throws ResourceNotFoundException. </p>
40      */
GetWorkbookId()41     inline const Aws::String& GetWorkbookId() const{ return m_workbookId; }
42 
43     /**
44      * <p>The ID of the workbook that contains the table whose rows are being
45      * retrieved.</p> <p> If a workbook with the specified id could not be found, this
46      * API throws ResourceNotFoundException. </p>
47      */
WorkbookIdHasBeenSet()48     inline bool WorkbookIdHasBeenSet() const { return m_workbookIdHasBeenSet; }
49 
50     /**
51      * <p>The ID of the workbook that contains the table whose rows are being
52      * retrieved.</p> <p> If a workbook with the specified id could not be found, this
53      * API throws ResourceNotFoundException. </p>
54      */
SetWorkbookId(const Aws::String & value)55     inline void SetWorkbookId(const Aws::String& value) { m_workbookIdHasBeenSet = true; m_workbookId = value; }
56 
57     /**
58      * <p>The ID of the workbook that contains the table whose rows are being
59      * retrieved.</p> <p> If a workbook with the specified id could not be found, this
60      * API throws ResourceNotFoundException. </p>
61      */
SetWorkbookId(Aws::String && value)62     inline void SetWorkbookId(Aws::String&& value) { m_workbookIdHasBeenSet = true; m_workbookId = std::move(value); }
63 
64     /**
65      * <p>The ID of the workbook that contains the table whose rows are being
66      * retrieved.</p> <p> If a workbook with the specified id could not be found, this
67      * API throws ResourceNotFoundException. </p>
68      */
SetWorkbookId(const char * value)69     inline void SetWorkbookId(const char* value) { m_workbookIdHasBeenSet = true; m_workbookId.assign(value); }
70 
71     /**
72      * <p>The ID of the workbook that contains the table whose rows are being
73      * retrieved.</p> <p> If a workbook with the specified id could not be found, this
74      * API throws ResourceNotFoundException. </p>
75      */
WithWorkbookId(const Aws::String & value)76     inline ListTableRowsRequest& WithWorkbookId(const Aws::String& value) { SetWorkbookId(value); return *this;}
77 
78     /**
79      * <p>The ID of the workbook that contains the table whose rows are being
80      * retrieved.</p> <p> If a workbook with the specified id could not be found, this
81      * API throws ResourceNotFoundException. </p>
82      */
WithWorkbookId(Aws::String && value)83     inline ListTableRowsRequest& WithWorkbookId(Aws::String&& value) { SetWorkbookId(std::move(value)); return *this;}
84 
85     /**
86      * <p>The ID of the workbook that contains the table whose rows are being
87      * retrieved.</p> <p> If a workbook with the specified id could not be found, this
88      * API throws ResourceNotFoundException. </p>
89      */
WithWorkbookId(const char * value)90     inline ListTableRowsRequest& WithWorkbookId(const char* value) { SetWorkbookId(value); return *this;}
91 
92 
93     /**
94      * <p>The ID of the table whose rows are being retrieved.</p> <p> If a table with
95      * the specified id could not be found, this API throws ResourceNotFoundException.
96      * </p>
97      */
GetTableId()98     inline const Aws::String& GetTableId() const{ return m_tableId; }
99 
100     /**
101      * <p>The ID of the table whose rows are being retrieved.</p> <p> If a table with
102      * the specified id could not be found, this API throws ResourceNotFoundException.
103      * </p>
104      */
TableIdHasBeenSet()105     inline bool TableIdHasBeenSet() const { return m_tableIdHasBeenSet; }
106 
107     /**
108      * <p>The ID of the table whose rows are being retrieved.</p> <p> If a table with
109      * the specified id could not be found, this API throws ResourceNotFoundException.
110      * </p>
111      */
SetTableId(const Aws::String & value)112     inline void SetTableId(const Aws::String& value) { m_tableIdHasBeenSet = true; m_tableId = value; }
113 
114     /**
115      * <p>The ID of the table whose rows are being retrieved.</p> <p> If a table with
116      * the specified id could not be found, this API throws ResourceNotFoundException.
117      * </p>
118      */
SetTableId(Aws::String && value)119     inline void SetTableId(Aws::String&& value) { m_tableIdHasBeenSet = true; m_tableId = std::move(value); }
120 
121     /**
122      * <p>The ID of the table whose rows are being retrieved.</p> <p> If a table with
123      * the specified id could not be found, this API throws ResourceNotFoundException.
124      * </p>
125      */
SetTableId(const char * value)126     inline void SetTableId(const char* value) { m_tableIdHasBeenSet = true; m_tableId.assign(value); }
127 
128     /**
129      * <p>The ID of the table whose rows are being retrieved.</p> <p> If a table with
130      * the specified id could not be found, this API throws ResourceNotFoundException.
131      * </p>
132      */
WithTableId(const Aws::String & value)133     inline ListTableRowsRequest& WithTableId(const Aws::String& value) { SetTableId(value); return *this;}
134 
135     /**
136      * <p>The ID of the table whose rows are being retrieved.</p> <p> If a table with
137      * the specified id could not be found, this API throws ResourceNotFoundException.
138      * </p>
139      */
WithTableId(Aws::String && value)140     inline ListTableRowsRequest& WithTableId(Aws::String&& value) { SetTableId(std::move(value)); return *this;}
141 
142     /**
143      * <p>The ID of the table whose rows are being retrieved.</p> <p> If a table with
144      * the specified id could not be found, this API throws ResourceNotFoundException.
145      * </p>
146      */
WithTableId(const char * value)147     inline ListTableRowsRequest& WithTableId(const char* value) { SetTableId(value); return *this;}
148 
149 
150     /**
151      * <p> This parameter is optional. If one or more row ids are specified in this
152      * list, then only the specified row ids are returned in the result. If no row ids
153      * are specified here, then all the rows in the table are returned. </p>
154      */
GetRowIds()155     inline const Aws::Vector<Aws::String>& GetRowIds() const{ return m_rowIds; }
156 
157     /**
158      * <p> This parameter is optional. If one or more row ids are specified in this
159      * list, then only the specified row ids are returned in the result. If no row ids
160      * are specified here, then all the rows in the table are returned. </p>
161      */
RowIdsHasBeenSet()162     inline bool RowIdsHasBeenSet() const { return m_rowIdsHasBeenSet; }
163 
164     /**
165      * <p> This parameter is optional. If one or more row ids are specified in this
166      * list, then only the specified row ids are returned in the result. If no row ids
167      * are specified here, then all the rows in the table are returned. </p>
168      */
SetRowIds(const Aws::Vector<Aws::String> & value)169     inline void SetRowIds(const Aws::Vector<Aws::String>& value) { m_rowIdsHasBeenSet = true; m_rowIds = value; }
170 
171     /**
172      * <p> This parameter is optional. If one or more row ids are specified in this
173      * list, then only the specified row ids are returned in the result. If no row ids
174      * are specified here, then all the rows in the table are returned. </p>
175      */
SetRowIds(Aws::Vector<Aws::String> && value)176     inline void SetRowIds(Aws::Vector<Aws::String>&& value) { m_rowIdsHasBeenSet = true; m_rowIds = std::move(value); }
177 
178     /**
179      * <p> This parameter is optional. If one or more row ids are specified in this
180      * list, then only the specified row ids are returned in the result. If no row ids
181      * are specified here, then all the rows in the table are returned. </p>
182      */
WithRowIds(const Aws::Vector<Aws::String> & value)183     inline ListTableRowsRequest& WithRowIds(const Aws::Vector<Aws::String>& value) { SetRowIds(value); return *this;}
184 
185     /**
186      * <p> This parameter is optional. If one or more row ids are specified in this
187      * list, then only the specified row ids are returned in the result. If no row ids
188      * are specified here, then all the rows in the table are returned. </p>
189      */
WithRowIds(Aws::Vector<Aws::String> && value)190     inline ListTableRowsRequest& WithRowIds(Aws::Vector<Aws::String>&& value) { SetRowIds(std::move(value)); return *this;}
191 
192     /**
193      * <p> This parameter is optional. If one or more row ids are specified in this
194      * list, then only the specified row ids are returned in the result. If no row ids
195      * are specified here, then all the rows in the table are returned. </p>
196      */
AddRowIds(const Aws::String & value)197     inline ListTableRowsRequest& AddRowIds(const Aws::String& value) { m_rowIdsHasBeenSet = true; m_rowIds.push_back(value); return *this; }
198 
199     /**
200      * <p> This parameter is optional. If one or more row ids are specified in this
201      * list, then only the specified row ids are returned in the result. If no row ids
202      * are specified here, then all the rows in the table are returned. </p>
203      */
AddRowIds(Aws::String && value)204     inline ListTableRowsRequest& AddRowIds(Aws::String&& value) { m_rowIdsHasBeenSet = true; m_rowIds.push_back(std::move(value)); return *this; }
205 
206     /**
207      * <p> This parameter is optional. If one or more row ids are specified in this
208      * list, then only the specified row ids are returned in the result. If no row ids
209      * are specified here, then all the rows in the table are returned. </p>
210      */
AddRowIds(const char * value)211     inline ListTableRowsRequest& AddRowIds(const char* value) { m_rowIdsHasBeenSet = true; m_rowIds.push_back(value); return *this; }
212 
213 
214     /**
215      * <p>The maximum number of rows to return in each page of the results.</p>
216      */
GetMaxResults()217     inline int GetMaxResults() const{ return m_maxResults; }
218 
219     /**
220      * <p>The maximum number of rows to return in each page of the results.</p>
221      */
MaxResultsHasBeenSet()222     inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
223 
224     /**
225      * <p>The maximum number of rows to return in each page of the results.</p>
226      */
SetMaxResults(int value)227     inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
228 
229     /**
230      * <p>The maximum number of rows to return in each page of the results.</p>
231      */
WithMaxResults(int value)232     inline ListTableRowsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
233 
234 
235     /**
236      * <p> This parameter is optional. If a nextToken is not specified, the API returns
237      * the first page of data. </p> <p> Pagination tokens expire after 1 hour. If you
238      * use a token that was returned more than an hour back, the API will throw
239      * ValidationException. </p>
240      */
GetNextToken()241     inline const Aws::String& GetNextToken() const{ return m_nextToken; }
242 
243     /**
244      * <p> This parameter is optional. If a nextToken is not specified, the API returns
245      * the first page of data. </p> <p> Pagination tokens expire after 1 hour. If you
246      * use a token that was returned more than an hour back, the API will throw
247      * ValidationException. </p>
248      */
NextTokenHasBeenSet()249     inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
250 
251     /**
252      * <p> This parameter is optional. If a nextToken is not specified, the API returns
253      * the first page of data. </p> <p> Pagination tokens expire after 1 hour. If you
254      * use a token that was returned more than an hour back, the API will throw
255      * ValidationException. </p>
256      */
SetNextToken(const Aws::String & value)257     inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
258 
259     /**
260      * <p> This parameter is optional. If a nextToken is not specified, the API returns
261      * the first page of data. </p> <p> Pagination tokens expire after 1 hour. If you
262      * use a token that was returned more than an hour back, the API will throw
263      * ValidationException. </p>
264      */
SetNextToken(Aws::String && value)265     inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
266 
267     /**
268      * <p> This parameter is optional. If a nextToken is not specified, the API returns
269      * the first page of data. </p> <p> Pagination tokens expire after 1 hour. If you
270      * use a token that was returned more than an hour back, the API will throw
271      * ValidationException. </p>
272      */
SetNextToken(const char * value)273     inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
274 
275     /**
276      * <p> This parameter is optional. If a nextToken is not specified, the API returns
277      * the first page of data. </p> <p> Pagination tokens expire after 1 hour. If you
278      * use a token that was returned more than an hour back, the API will throw
279      * ValidationException. </p>
280      */
WithNextToken(const Aws::String & value)281     inline ListTableRowsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
282 
283     /**
284      * <p> This parameter is optional. If a nextToken is not specified, the API returns
285      * the first page of data. </p> <p> Pagination tokens expire after 1 hour. If you
286      * use a token that was returned more than an hour back, the API will throw
287      * ValidationException. </p>
288      */
WithNextToken(Aws::String && value)289     inline ListTableRowsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
290 
291     /**
292      * <p> This parameter is optional. If a nextToken is not specified, the API returns
293      * the first page of data. </p> <p> Pagination tokens expire after 1 hour. If you
294      * use a token that was returned more than an hour back, the API will throw
295      * ValidationException. </p>
296      */
WithNextToken(const char * value)297     inline ListTableRowsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
298 
299   private:
300 
301     Aws::String m_workbookId;
302     bool m_workbookIdHasBeenSet;
303 
304     Aws::String m_tableId;
305     bool m_tableIdHasBeenSet;
306 
307     Aws::Vector<Aws::String> m_rowIds;
308     bool m_rowIdsHasBeenSet;
309 
310     int m_maxResults;
311     bool m_maxResultsHasBeenSet;
312 
313     Aws::String m_nextToken;
314     bool m_nextTokenHasBeenSet;
315   };
316 
317 } // namespace Model
318 } // namespace Honeycode
319 } // namespace Aws
320