AWS SDK for C++  1.8.71
AWS SDK for C++
ListObjectsRequest.h
Go to the documentation of this file.
1 
6 #pragma once
7 #include <aws/s3/S3_EXPORTS.h>
8 #include <aws/s3/S3Request.h>
13 #include <utility>
14 
15 namespace Aws
16 {
17 namespace Http
18 {
19  class URI;
20 } //namespace Http
21 namespace S3
22 {
23 namespace Model
24 {
25 
29  {
30  public:
32 
33  // Service request name is the Operation name which will send this request out,
34  // each operation should has unique request name, so that we can get operation's name from this request.
35  // Note: this is not true for response, multiple operations may have the same response name,
36  // so we can not get operation's name from response.
37  inline virtual const char* GetServiceRequestName() const override { return "ListObjects"; }
38 
39  Aws::String SerializePayload() const override;
40 
41  void AddQueryStringParameters(Aws::Http::URI& uri) const override;
42 
43  Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
44 
45 
67  inline const Aws::String& GetBucket() const{ return m_bucket; }
68 
90  inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
91 
113  inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
114 
136  inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
137 
159  inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
160 
182  inline ListObjectsRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
183 
205  inline ListObjectsRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
206 
228  inline ListObjectsRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
229 
230 
234  inline const Aws::String& GetDelimiter() const{ return m_delimiter; }
235 
239  inline bool DelimiterHasBeenSet() const { return m_delimiterHasBeenSet; }
240 
244  inline void SetDelimiter(const Aws::String& value) { m_delimiterHasBeenSet = true; m_delimiter = value; }
245 
249  inline void SetDelimiter(Aws::String&& value) { m_delimiterHasBeenSet = true; m_delimiter = std::move(value); }
250 
254  inline void SetDelimiter(const char* value) { m_delimiterHasBeenSet = true; m_delimiter.assign(value); }
255 
259  inline ListObjectsRequest& WithDelimiter(const Aws::String& value) { SetDelimiter(value); return *this;}
260 
264  inline ListObjectsRequest& WithDelimiter(Aws::String&& value) { SetDelimiter(std::move(value)); return *this;}
265 
269  inline ListObjectsRequest& WithDelimiter(const char* value) { SetDelimiter(value); return *this;}
270 
271 
272 
273  inline const EncodingType& GetEncodingType() const{ return m_encodingType; }
274 
275 
276  inline bool EncodingTypeHasBeenSet() const { return m_encodingTypeHasBeenSet; }
277 
278 
279  inline void SetEncodingType(const EncodingType& value) { m_encodingTypeHasBeenSet = true; m_encodingType = value; }
280 
281 
282  inline void SetEncodingType(EncodingType&& value) { m_encodingTypeHasBeenSet = true; m_encodingType = std::move(value); }
283 
284 
285  inline ListObjectsRequest& WithEncodingType(const EncodingType& value) { SetEncodingType(value); return *this;}
286 
287 
288  inline ListObjectsRequest& WithEncodingType(EncodingType&& value) { SetEncodingType(std::move(value)); return *this;}
289 
290 
294  inline const Aws::String& GetMarker() const{ return m_marker; }
295 
299  inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; }
300 
304  inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; }
305 
309  inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); }
310 
314  inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); }
315 
319  inline ListObjectsRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;}
320 
324  inline ListObjectsRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;}
325 
329  inline ListObjectsRequest& WithMarker(const char* value) { SetMarker(value); return *this;}
330 
331 
337  inline int GetMaxKeys() const{ return m_maxKeys; }
338 
344  inline bool MaxKeysHasBeenSet() const { return m_maxKeysHasBeenSet; }
345 
351  inline void SetMaxKeys(int value) { m_maxKeysHasBeenSet = true; m_maxKeys = value; }
352 
358  inline ListObjectsRequest& WithMaxKeys(int value) { SetMaxKeys(value); return *this;}
359 
360 
364  inline const Aws::String& GetPrefix() const{ return m_prefix; }
365 
369  inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; }
370 
374  inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; }
375 
379  inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = std::move(value); }
380 
384  inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); }
385 
389  inline ListObjectsRequest& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;}
390 
394  inline ListObjectsRequest& WithPrefix(Aws::String&& value) { SetPrefix(std::move(value)); return *this;}
395 
399  inline ListObjectsRequest& WithPrefix(const char* value) { SetPrefix(value); return *this;}
400 
401 
407  inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
408 
414  inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
415 
421  inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
422 
428  inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
429 
435  inline ListObjectsRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
436 
442  inline ListObjectsRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
443 
444 
450  inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
451 
457  inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
458 
464  inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
465 
471  inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
472 
478  inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
479 
485  inline ListObjectsRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;}
486 
492  inline ListObjectsRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
493 
499  inline ListObjectsRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
500 
501 
502 
503  inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
504 
505 
506  inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
507 
508 
509  inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
510 
511 
512  inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
513 
514 
515  inline ListObjectsRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;}
516 
517 
518  inline ListObjectsRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;}
519 
520 
521  inline ListObjectsRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
522 
523 
524  inline ListObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
525 
526 
527  inline ListObjectsRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
528 
529 
530  inline ListObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
531 
532 
533  inline ListObjectsRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
534 
535 
536  inline ListObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
537 
538 
539  inline ListObjectsRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
540 
541  private:
542 
543  Aws::String m_bucket;
544  bool m_bucketHasBeenSet;
545 
546  Aws::String m_delimiter;
547  bool m_delimiterHasBeenSet;
548 
549  EncodingType m_encodingType;
550  bool m_encodingTypeHasBeenSet;
551 
552  Aws::String m_marker;
553  bool m_markerHasBeenSet;
554 
555  int m_maxKeys;
556  bool m_maxKeysHasBeenSet;
557 
558  Aws::String m_prefix;
559  bool m_prefixHasBeenSet;
560 
561  RequestPayer m_requestPayer;
562  bool m_requestPayerHasBeenSet;
563 
564  Aws::String m_expectedBucketOwner;
565  bool m_expectedBucketOwnerHasBeenSet;
566 
567  Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
568  bool m_customizedAccessLogTagHasBeenSet;
569  };
570 
571 } // namespace Model
572 } // namespace S3
573 } // namespace Aws
ListObjectsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
void SetDelimiter(const char *value)
ListObjectsRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
ListObjectsRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
ListObjectsRequest & WithPrefix(Aws::String &&value)
ListObjectsRequest & WithRequestPayer(const RequestPayer &value)
ListObjectsRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
void SetPrefix(Aws::String &&value)
ListObjectsRequest & WithMaxKeys(int value)
ListObjectsRequest & WithExpectedBucketOwner(Aws::String &&value)
ListObjectsRequest & WithMarker(const Aws::String &value)
void SetRequestPayer(const RequestPayer &value)
const Aws::String & GetMarker() const
ListObjectsRequest & WithMarker(const char *value)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
Definition: AWSMap.h:19
const RequestPayer & GetRequestPayer() const
ListObjectsRequest & WithExpectedBucketOwner(const Aws::String &value)
#define AWS_S3_API
Definition: S3_EXPORTS.h:28
void SetExpectedBucketOwner(const char *value)
void SetMarker(const Aws::String &value)
ListObjectsRequest & WithDelimiter(const Aws::String &value)
ListObjectsRequest & WithDelimiter(Aws::String &&value)
void SetEncodingType(EncodingType &&value)
ListObjectsRequest & AddCustomizedAccessLogTag(const char *key, const char *value)
ListObjectsRequest & WithBucket(const char *value)
ListObjectsRequest & WithExpectedBucketOwner(const char *value)
ListObjectsRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
void SetBucket(const Aws::String &value)
void SetBucket(Aws::String &&value)
const Aws::String & GetPrefix() const
void SetExpectedBucketOwner(const Aws::String &value)
const Aws::String & GetBucket() const
void SetExpectedBucketOwner(Aws::String &&value)
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
void SetRequestPayer(RequestPayer &&value)
void SetDelimiter(Aws::String &&value)
ListObjectsRequest & WithBucket(Aws::String &&value)
ListObjectsRequest & WithDelimiter(const char *value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
ListObjectsRequest & WithMarker(Aws::String &&value)
const Aws::String & GetDelimiter() const
const EncodingType & GetEncodingType() const
ListObjectsRequest & WithEncodingType(const EncodingType &value)
const Aws::String & GetExpectedBucketOwner() const
ListObjectsRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
ListObjectsRequest & WithEncodingType(EncodingType &&value)
ListObjectsRequest & WithPrefix(const Aws::String &value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
ListObjectsRequest & WithPrefix(const char *value)
ListObjectsRequest & WithBucket(const Aws::String &value)
void SetMarker(Aws::String &&value)
ListObjectsRequest & WithRequestPayer(RequestPayer &&value)
void SetDelimiter(const Aws::String &value)
ListObjectsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
ListObjectsRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
void SetPrefix(const Aws::String &value)
void SetEncodingType(const EncodingType &value)
virtual const char * GetServiceRequestName() const override