1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/s3/S3_EXPORTS.h>
#include <aws/s3/S3Request.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/s3/model/EncodingType.h>
#include <aws/s3/model/RequestPayer.h>
#include <aws/core/utils/memory/stl/AWSMap.h>
#include <utility>
namespace Aws
{
namespace Http
{
class URI;
} //namespace Http
namespace S3
{
namespace Model
{
/**
*/
class ListObjectsV2Request : public S3Request
{
public:
AWS_S3_API ListObjectsV2Request();
// Service request name is the Operation name which will send this request out,
// each operation should has unique request name, so that we can get operation's name from this request.
// Note: this is not true for response, multiple operations may have the same response name,
// so we can not get operation's name from response.
inline virtual const char* GetServiceRequestName() const override { return "ListObjectsV2"; }
AWS_S3_API Aws::String SerializePayload() const override;
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation.
*/
AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
/**
* <p>Bucket name to list. </p> <p>When using this action with an access point, you
* must direct requests to the access point hostname. The access point hostname
* takes the form
* <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
* When using this action with an access point through the Amazon Web Services
* SDKs, you provide the access point ARN in place of the bucket name. For more
* information about access point ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using
* access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this
* action with Amazon S3 on Outposts, you must direct requests to the S3 on
* Outposts hostname. The S3 on Outposts hostname takes the form <code>
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
* When using this action with S3 on Outposts through the Amazon Web Services SDKs,
* you provide the Outposts bucket ARN in place of the bucket name. For more
* information about S3 on Outposts ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
inline const Aws::String& GetBucket() const{ return m_bucket; }
/**
* <p>Bucket name to list. </p> <p>When using this action with an access point, you
* must direct requests to the access point hostname. The access point hostname
* takes the form
* <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
* When using this action with an access point through the Amazon Web Services
* SDKs, you provide the access point ARN in place of the bucket name. For more
* information about access point ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using
* access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this
* action with Amazon S3 on Outposts, you must direct requests to the S3 on
* Outposts hostname. The S3 on Outposts hostname takes the form <code>
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
* When using this action with S3 on Outposts through the Amazon Web Services SDKs,
* you provide the Outposts bucket ARN in place of the bucket name. For more
* information about S3 on Outposts ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
/**
* <p>Bucket name to list. </p> <p>When using this action with an access point, you
* must direct requests to the access point hostname. The access point hostname
* takes the form
* <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
* When using this action with an access point through the Amazon Web Services
* SDKs, you provide the access point ARN in place of the bucket name. For more
* information about access point ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using
* access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this
* action with Amazon S3 on Outposts, you must direct requests to the S3 on
* Outposts hostname. The S3 on Outposts hostname takes the form <code>
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
* When using this action with S3 on Outposts through the Amazon Web Services SDKs,
* you provide the Outposts bucket ARN in place of the bucket name. For more
* information about S3 on Outposts ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
/**
* <p>Bucket name to list. </p> <p>When using this action with an access point, you
* must direct requests to the access point hostname. The access point hostname
* takes the form
* <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
* When using this action with an access point through the Amazon Web Services
* SDKs, you provide the access point ARN in place of the bucket name. For more
* information about access point ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using
* access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this
* action with Amazon S3 on Outposts, you must direct requests to the S3 on
* Outposts hostname. The S3 on Outposts hostname takes the form <code>
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
* When using this action with S3 on Outposts through the Amazon Web Services SDKs,
* you provide the Outposts bucket ARN in place of the bucket name. For more
* information about S3 on Outposts ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
/**
* <p>Bucket name to list. </p> <p>When using this action with an access point, you
* must direct requests to the access point hostname. The access point hostname
* takes the form
* <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
* When using this action with an access point through the Amazon Web Services
* SDKs, you provide the access point ARN in place of the bucket name. For more
* information about access point ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using
* access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this
* action with Amazon S3 on Outposts, you must direct requests to the S3 on
* Outposts hostname. The S3 on Outposts hostname takes the form <code>
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
* When using this action with S3 on Outposts through the Amazon Web Services SDKs,
* you provide the Outposts bucket ARN in place of the bucket name. For more
* information about S3 on Outposts ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
/**
* <p>Bucket name to list. </p> <p>When using this action with an access point, you
* must direct requests to the access point hostname. The access point hostname
* takes the form
* <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
* When using this action with an access point through the Amazon Web Services
* SDKs, you provide the access point ARN in place of the bucket name. For more
* information about access point ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using
* access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this
* action with Amazon S3 on Outposts, you must direct requests to the S3 on
* Outposts hostname. The S3 on Outposts hostname takes the form <code>
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
* When using this action with S3 on Outposts through the Amazon Web Services SDKs,
* you provide the Outposts bucket ARN in place of the bucket name. For more
* information about S3 on Outposts ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
inline ListObjectsV2Request& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
/**
* <p>Bucket name to list. </p> <p>When using this action with an access point, you
* must direct requests to the access point hostname. The access point hostname
* takes the form
* <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
* When using this action with an access point through the Amazon Web Services
* SDKs, you provide the access point ARN in place of the bucket name. For more
* information about access point ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using
* access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this
* action with Amazon S3 on Outposts, you must direct requests to the S3 on
* Outposts hostname. The S3 on Outposts hostname takes the form <code>
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
* When using this action with S3 on Outposts through the Amazon Web Services SDKs,
* you provide the Outposts bucket ARN in place of the bucket name. For more
* information about S3 on Outposts ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
inline ListObjectsV2Request& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
/**
* <p>Bucket name to list. </p> <p>When using this action with an access point, you
* must direct requests to the access point hostname. The access point hostname
* takes the form
* <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com.
* When using this action with an access point through the Amazon Web Services
* SDKs, you provide the access point ARN in place of the bucket name. For more
* information about access point ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using
* access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>When using this
* action with Amazon S3 on Outposts, you must direct requests to the S3 on
* Outposts hostname. The S3 on Outposts hostname takes the form <code>
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>.
* When using this action with S3 on Outposts through the Amazon Web Services SDKs,
* you provide the Outposts bucket ARN in place of the bucket name. For more
* information about S3 on Outposts ARNs, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using
* Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
inline ListObjectsV2Request& WithBucket(const char* value) { SetBucket(value); return *this;}
/**
* <p>A delimiter is a character you use to group keys.</p>
*/
inline const Aws::String& GetDelimiter() const{ return m_delimiter; }
/**
* <p>A delimiter is a character you use to group keys.</p>
*/
inline bool DelimiterHasBeenSet() const { return m_delimiterHasBeenSet; }
/**
* <p>A delimiter is a character you use to group keys.</p>
*/
inline void SetDelimiter(const Aws::String& value) { m_delimiterHasBeenSet = true; m_delimiter = value; }
/**
* <p>A delimiter is a character you use to group keys.</p>
*/
inline void SetDelimiter(Aws::String&& value) { m_delimiterHasBeenSet = true; m_delimiter = std::move(value); }
/**
* <p>A delimiter is a character you use to group keys.</p>
*/
inline void SetDelimiter(const char* value) { m_delimiterHasBeenSet = true; m_delimiter.assign(value); }
/**
* <p>A delimiter is a character you use to group keys.</p>
*/
inline ListObjectsV2Request& WithDelimiter(const Aws::String& value) { SetDelimiter(value); return *this;}
/**
* <p>A delimiter is a character you use to group keys.</p>
*/
inline ListObjectsV2Request& WithDelimiter(Aws::String&& value) { SetDelimiter(std::move(value)); return *this;}
/**
* <p>A delimiter is a character you use to group keys.</p>
*/
inline ListObjectsV2Request& WithDelimiter(const char* value) { SetDelimiter(value); return *this;}
/**
* <p>Encoding type used by Amazon S3 to encode object keys in the response.</p>
*/
inline const EncodingType& GetEncodingType() const{ return m_encodingType; }
/**
* <p>Encoding type used by Amazon S3 to encode object keys in the response.</p>
*/
inline bool EncodingTypeHasBeenSet() const { return m_encodingTypeHasBeenSet; }
/**
* <p>Encoding type used by Amazon S3 to encode object keys in the response.</p>
*/
inline void SetEncodingType(const EncodingType& value) { m_encodingTypeHasBeenSet = true; m_encodingType = value; }
/**
* <p>Encoding type used by Amazon S3 to encode object keys in the response.</p>
*/
inline void SetEncodingType(EncodingType&& value) { m_encodingTypeHasBeenSet = true; m_encodingType = std::move(value); }
/**
* <p>Encoding type used by Amazon S3 to encode object keys in the response.</p>
*/
inline ListObjectsV2Request& WithEncodingType(const EncodingType& value) { SetEncodingType(value); return *this;}
/**
* <p>Encoding type used by Amazon S3 to encode object keys in the response.</p>
*/
inline ListObjectsV2Request& WithEncodingType(EncodingType&& value) { SetEncodingType(std::move(value)); return *this;}
/**
* <p>Sets the maximum number of keys returned in the response. By default the
* action returns up to 1,000 key names. The response might contain fewer keys but
* will never contain more.</p>
*/
inline int GetMaxKeys() const{ return m_maxKeys; }
/**
* <p>Sets the maximum number of keys returned in the response. By default the
* action returns up to 1,000 key names. The response might contain fewer keys but
* will never contain more.</p>
*/
inline bool MaxKeysHasBeenSet() const { return m_maxKeysHasBeenSet; }
/**
* <p>Sets the maximum number of keys returned in the response. By default the
* action returns up to 1,000 key names. The response might contain fewer keys but
* will never contain more.</p>
*/
inline void SetMaxKeys(int value) { m_maxKeysHasBeenSet = true; m_maxKeys = value; }
/**
* <p>Sets the maximum number of keys returned in the response. By default the
* action returns up to 1,000 key names. The response might contain fewer keys but
* will never contain more.</p>
*/
inline ListObjectsV2Request& WithMaxKeys(int value) { SetMaxKeys(value); return *this;}
/**
* <p>Limits the response to keys that begin with the specified prefix.</p>
*/
inline const Aws::String& GetPrefix() const{ return m_prefix; }
/**
* <p>Limits the response to keys that begin with the specified prefix.</p>
*/
inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; }
/**
* <p>Limits the response to keys that begin with the specified prefix.</p>
*/
inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; }
/**
* <p>Limits the response to keys that begin with the specified prefix.</p>
*/
inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = std::move(value); }
/**
* <p>Limits the response to keys that begin with the specified prefix.</p>
*/
inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); }
/**
* <p>Limits the response to keys that begin with the specified prefix.</p>
*/
inline ListObjectsV2Request& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;}
/**
* <p>Limits the response to keys that begin with the specified prefix.</p>
*/
inline ListObjectsV2Request& WithPrefix(Aws::String&& value) { SetPrefix(std::move(value)); return *this;}
/**
* <p>Limits the response to keys that begin with the specified prefix.</p>
*/
inline ListObjectsV2Request& WithPrefix(const char* value) { SetPrefix(value); return *this;}
/**
* <p>ContinuationToken indicates Amazon S3 that the list is being continued on
* this bucket with a token. ContinuationToken is obfuscated and is not a real
* key.</p>
*/
inline const Aws::String& GetContinuationToken() const{ return m_continuationToken; }
/**
* <p>ContinuationToken indicates Amazon S3 that the list is being continued on
* this bucket with a token. ContinuationToken is obfuscated and is not a real
* key.</p>
*/
inline bool ContinuationTokenHasBeenSet() const { return m_continuationTokenHasBeenSet; }
/**
* <p>ContinuationToken indicates Amazon S3 that the list is being continued on
* this bucket with a token. ContinuationToken is obfuscated and is not a real
* key.</p>
*/
inline void SetContinuationToken(const Aws::String& value) { m_continuationTokenHasBeenSet = true; m_continuationToken = value; }
/**
* <p>ContinuationToken indicates Amazon S3 that the list is being continued on
* this bucket with a token. ContinuationToken is obfuscated and is not a real
* key.</p>
*/
inline void SetContinuationToken(Aws::String&& value) { m_continuationTokenHasBeenSet = true; m_continuationToken = std::move(value); }
/**
* <p>ContinuationToken indicates Amazon S3 that the list is being continued on
* this bucket with a token. ContinuationToken is obfuscated and is not a real
* key.</p>
*/
inline void SetContinuationToken(const char* value) { m_continuationTokenHasBeenSet = true; m_continuationToken.assign(value); }
/**
* <p>ContinuationToken indicates Amazon S3 that the list is being continued on
* this bucket with a token. ContinuationToken is obfuscated and is not a real
* key.</p>
*/
inline ListObjectsV2Request& WithContinuationToken(const Aws::String& value) { SetContinuationToken(value); return *this;}
/**
* <p>ContinuationToken indicates Amazon S3 that the list is being continued on
* this bucket with a token. ContinuationToken is obfuscated and is not a real
* key.</p>
*/
inline ListObjectsV2Request& WithContinuationToken(Aws::String&& value) { SetContinuationToken(std::move(value)); return *this;}
/**
* <p>ContinuationToken indicates Amazon S3 that the list is being continued on
* this bucket with a token. ContinuationToken is obfuscated and is not a real
* key.</p>
*/
inline ListObjectsV2Request& WithContinuationToken(const char* value) { SetContinuationToken(value); return *this;}
/**
* <p>The owner field is not present in listV2 by default, if you want to return
* owner field with each key in the result then set the fetch owner field to
* true.</p>
*/
inline bool GetFetchOwner() const{ return m_fetchOwner; }
/**
* <p>The owner field is not present in listV2 by default, if you want to return
* owner field with each key in the result then set the fetch owner field to
* true.</p>
*/
inline bool FetchOwnerHasBeenSet() const { return m_fetchOwnerHasBeenSet; }
/**
* <p>The owner field is not present in listV2 by default, if you want to return
* owner field with each key in the result then set the fetch owner field to
* true.</p>
*/
inline void SetFetchOwner(bool value) { m_fetchOwnerHasBeenSet = true; m_fetchOwner = value; }
/**
* <p>The owner field is not present in listV2 by default, if you want to return
* owner field with each key in the result then set the fetch owner field to
* true.</p>
*/
inline ListObjectsV2Request& WithFetchOwner(bool value) { SetFetchOwner(value); return *this;}
/**
* <p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3
* starts listing after this specified key. StartAfter can be any key in the
* bucket.</p>
*/
inline const Aws::String& GetStartAfter() const{ return m_startAfter; }
/**
* <p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3
* starts listing after this specified key. StartAfter can be any key in the
* bucket.</p>
*/
inline bool StartAfterHasBeenSet() const { return m_startAfterHasBeenSet; }
/**
* <p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3
* starts listing after this specified key. StartAfter can be any key in the
* bucket.</p>
*/
inline void SetStartAfter(const Aws::String& value) { m_startAfterHasBeenSet = true; m_startAfter = value; }
/**
* <p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3
* starts listing after this specified key. StartAfter can be any key in the
* bucket.</p>
*/
inline void SetStartAfter(Aws::String&& value) { m_startAfterHasBeenSet = true; m_startAfter = std::move(value); }
/**
* <p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3
* starts listing after this specified key. StartAfter can be any key in the
* bucket.</p>
*/
inline void SetStartAfter(const char* value) { m_startAfterHasBeenSet = true; m_startAfter.assign(value); }
/**
* <p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3
* starts listing after this specified key. StartAfter can be any key in the
* bucket.</p>
*/
inline ListObjectsV2Request& WithStartAfter(const Aws::String& value) { SetStartAfter(value); return *this;}
/**
* <p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3
* starts listing after this specified key. StartAfter can be any key in the
* bucket.</p>
*/
inline ListObjectsV2Request& WithStartAfter(Aws::String&& value) { SetStartAfter(std::move(value)); return *this;}
/**
* <p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3
* starts listing after this specified key. StartAfter can be any key in the
* bucket.</p>
*/
inline ListObjectsV2Request& WithStartAfter(const char* value) { SetStartAfter(value); return *this;}
/**
* <p>Confirms that the requester knows that she or he will be charged for the list
* objects request in V2 style. Bucket owners need not specify this parameter in
* their requests.</p>
*/
inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
/**
* <p>Confirms that the requester knows that she or he will be charged for the list
* objects request in V2 style. Bucket owners need not specify this parameter in
* their requests.</p>
*/
inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
/**
* <p>Confirms that the requester knows that she or he will be charged for the list
* objects request in V2 style. Bucket owners need not specify this parameter in
* their requests.</p>
*/
inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
/**
* <p>Confirms that the requester knows that she or he will be charged for the list
* objects request in V2 style. Bucket owners need not specify this parameter in
* their requests.</p>
*/
inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
/**
* <p>Confirms that the requester knows that she or he will be charged for the list
* objects request in V2 style. Bucket owners need not specify this parameter in
* their requests.</p>
*/
inline ListObjectsV2Request& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
/**
* <p>Confirms that the requester knows that she or he will be charged for the list
* objects request in V2 style. Bucket owners need not specify this parameter in
* their requests.</p>
*/
inline ListObjectsV2Request& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
/**
* <p>The account ID of the expected bucket owner. If the bucket is owned by a
* different account, the request fails with the HTTP status code <code>403
* Forbidden</code> (access denied).</p>
*/
inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
/**
* <p>The account ID of the expected bucket owner. If the bucket is owned by a
* different account, the request fails with the HTTP status code <code>403
* Forbidden</code> (access denied).</p>
*/
inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
/**
* <p>The account ID of the expected bucket owner. If the bucket is owned by a
* different account, the request fails with the HTTP status code <code>403
* Forbidden</code> (access denied).</p>
*/
inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
/**
* <p>The account ID of the expected bucket owner. If the bucket is owned by a
* different account, the request fails with the HTTP status code <code>403
* Forbidden</code> (access denied).</p>
*/
inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
/**
* <p>The account ID of the expected bucket owner. If the bucket is owned by a
* different account, the request fails with the HTTP status code <code>403
* Forbidden</code> (access denied).</p>
*/
inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
/**
* <p>The account ID of the expected bucket owner. If the bucket is owned by a
* different account, the request fails with the HTTP status code <code>403
* Forbidden</code> (access denied).</p>
*/
inline ListObjectsV2Request& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;}
/**
* <p>The account ID of the expected bucket owner. If the bucket is owned by a
* different account, the request fails with the HTTP status code <code>403
* Forbidden</code> (access denied).</p>
*/
inline ListObjectsV2Request& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
/**
* <p>The account ID of the expected bucket owner. If the bucket is owned by a
* different account, the request fails with the HTTP status code <code>403
* Forbidden</code> (access denied).</p>
*/
inline ListObjectsV2Request& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
inline ListObjectsV2Request& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;}
inline ListObjectsV2Request& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;}
inline ListObjectsV2Request& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
inline ListObjectsV2Request& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
inline ListObjectsV2Request& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
inline ListObjectsV2Request& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
inline ListObjectsV2Request& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
inline ListObjectsV2Request& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
inline ListObjectsV2Request& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
private:
Aws::String m_bucket;
bool m_bucketHasBeenSet = false;
Aws::String m_delimiter;
bool m_delimiterHasBeenSet = false;
EncodingType m_encodingType;
bool m_encodingTypeHasBeenSet = false;
int m_maxKeys;
bool m_maxKeysHasBeenSet = false;
Aws::String m_prefix;
bool m_prefixHasBeenSet = false;
Aws::String m_continuationToken;
bool m_continuationTokenHasBeenSet = false;
bool m_fetchOwner;
bool m_fetchOwnerHasBeenSet = false;
Aws::String m_startAfter;
bool m_startAfterHasBeenSet = false;
RequestPayer m_requestPayer;
bool m_requestPayerHasBeenSet = false;
Aws::String m_expectedBucketOwner;
bool m_expectedBucketOwnerHasBeenSet = false;
Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
bool m_customizedAccessLogTagHasBeenSet = false;
};
} // namespace Model
} // namespace S3
} // namespace Aws
|