AWS SDK for C++  1.8.55
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 
49  inline const Aws::String& GetBucket() const{ return m_bucket; }
50 
54  inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
55 
59  inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
60 
64  inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
65 
69  inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
70 
74  inline ListObjectsRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
75 
79  inline ListObjectsRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
80 
84  inline ListObjectsRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
85 
86 
90  inline const Aws::String& GetDelimiter() const{ return m_delimiter; }
91 
95  inline bool DelimiterHasBeenSet() const { return m_delimiterHasBeenSet; }
96 
100  inline void SetDelimiter(const Aws::String& value) { m_delimiterHasBeenSet = true; m_delimiter = value; }
101 
105  inline void SetDelimiter(Aws::String&& value) { m_delimiterHasBeenSet = true; m_delimiter = std::move(value); }
106 
110  inline void SetDelimiter(const char* value) { m_delimiterHasBeenSet = true; m_delimiter.assign(value); }
111 
115  inline ListObjectsRequest& WithDelimiter(const Aws::String& value) { SetDelimiter(value); return *this;}
116 
120  inline ListObjectsRequest& WithDelimiter(Aws::String&& value) { SetDelimiter(std::move(value)); return *this;}
121 
125  inline ListObjectsRequest& WithDelimiter(const char* value) { SetDelimiter(value); return *this;}
126 
127 
128 
129  inline const EncodingType& GetEncodingType() const{ return m_encodingType; }
130 
131 
132  inline bool EncodingTypeHasBeenSet() const { return m_encodingTypeHasBeenSet; }
133 
134 
135  inline void SetEncodingType(const EncodingType& value) { m_encodingTypeHasBeenSet = true; m_encodingType = value; }
136 
137 
138  inline void SetEncodingType(EncodingType&& value) { m_encodingTypeHasBeenSet = true; m_encodingType = std::move(value); }
139 
140 
141  inline ListObjectsRequest& WithEncodingType(const EncodingType& value) { SetEncodingType(value); return *this;}
142 
143 
144  inline ListObjectsRequest& WithEncodingType(EncodingType&& value) { SetEncodingType(std::move(value)); return *this;}
145 
146 
150  inline const Aws::String& GetMarker() const{ return m_marker; }
151 
155  inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; }
156 
160  inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; }
161 
165  inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); }
166 
170  inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); }
171 
175  inline ListObjectsRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;}
176 
180  inline ListObjectsRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;}
181 
185  inline ListObjectsRequest& WithMarker(const char* value) { SetMarker(value); return *this;}
186 
187 
193  inline int GetMaxKeys() const{ return m_maxKeys; }
194 
200  inline bool MaxKeysHasBeenSet() const { return m_maxKeysHasBeenSet; }
201 
207  inline void SetMaxKeys(int value) { m_maxKeysHasBeenSet = true; m_maxKeys = value; }
208 
214  inline ListObjectsRequest& WithMaxKeys(int value) { SetMaxKeys(value); return *this;}
215 
216 
220  inline const Aws::String& GetPrefix() const{ return m_prefix; }
221 
225  inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; }
226 
230  inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; }
231 
235  inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = std::move(value); }
236 
240  inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); }
241 
245  inline ListObjectsRequest& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;}
246 
250  inline ListObjectsRequest& WithPrefix(Aws::String&& value) { SetPrefix(std::move(value)); return *this;}
251 
255  inline ListObjectsRequest& WithPrefix(const char* value) { SetPrefix(value); return *this;}
256 
257 
263  inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
264 
270  inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
271 
277  inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
278 
284  inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
285 
291  inline ListObjectsRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
292 
298  inline ListObjectsRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
299 
300 
306  inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
307 
313  inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
314 
320  inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
321 
327  inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
328 
334  inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
335 
341  inline ListObjectsRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;}
342 
348  inline ListObjectsRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
349 
355  inline ListObjectsRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
356 
357 
358 
359  inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
360 
361 
362  inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
363 
364 
365  inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
366 
367 
368  inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
369 
370 
371  inline ListObjectsRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;}
372 
373 
374  inline ListObjectsRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;}
375 
376 
377  inline ListObjectsRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
378 
379 
380  inline ListObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
381 
382 
383  inline ListObjectsRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
384 
385 
386  inline ListObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
387 
388 
389  inline ListObjectsRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
390 
391 
392  inline ListObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
393 
394 
395  inline ListObjectsRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
396 
397  private:
398 
399  Aws::String m_bucket;
400  bool m_bucketHasBeenSet;
401 
402  Aws::String m_delimiter;
403  bool m_delimiterHasBeenSet;
404 
405  EncodingType m_encodingType;
406  bool m_encodingTypeHasBeenSet;
407 
408  Aws::String m_marker;
409  bool m_markerHasBeenSet;
410 
411  int m_maxKeys;
412  bool m_maxKeysHasBeenSet;
413 
414  Aws::String m_prefix;
415  bool m_prefixHasBeenSet;
416 
417  RequestPayer m_requestPayer;
418  bool m_requestPayerHasBeenSet;
419 
420  Aws::String m_expectedBucketOwner;
421  bool m_expectedBucketOwnerHasBeenSet;
422 
423  Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
424  bool m_customizedAccessLogTagHasBeenSet;
425  };
426 
427 } // namespace Model
428 } // namespace S3
429 } // 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