AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
ListObjectsV2Request.h
1
6#pragma once
7#include <aws/s3-crt/S3Crt_EXPORTS.h>
8#include <aws/s3-crt/S3CrtRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/s3-crt/model/EncodingType.h>
11#include <aws/s3-crt/model/RequestPayer.h>
12#include <aws/core/utils/memory/stl/AWSVector.h>
13#include <aws/core/utils/memory/stl/AWSMap.h>
14#include <aws/s3-crt/model/OptionalObjectAttributes.h>
15#include <utility>
16
17namespace Aws
18{
19namespace Http
20{
21 class URI;
22} //namespace Http
23namespace S3Crt
24{
25namespace Model
26{
27
31 {
32 public:
33 AWS_S3CRT_API ListObjectsV2Request();
34
35 // Service request name is the Operation name which will send this request out,
36 // each operation should has unique request name, so that we can get operation's name from this request.
37 // Note: this is not true for response, multiple operations may have the same response name,
38 // so we can not get operation's name from response.
39 inline virtual const char* GetServiceRequestName() const override { return "ListObjectsV2"; }
40
41 AWS_S3CRT_API Aws::String SerializePayload() const override;
42
43 AWS_S3CRT_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
44
46
47 AWS_S3CRT_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override;
51 AWS_S3CRT_API EndpointParameters GetEndpointContextParams() const override;
52
54
86 inline const Aws::String& GetBucket() const{ return m_bucket; }
87 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
88 inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
89 inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
90 inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
91 inline ListObjectsV2Request& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
92 inline ListObjectsV2Request& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
93 inline ListObjectsV2Request& WithBucket(const char* value) { SetBucket(value); return *this;}
95
97
108 inline const Aws::String& GetDelimiter() const{ return m_delimiter; }
109 inline bool DelimiterHasBeenSet() const { return m_delimiterHasBeenSet; }
110 inline void SetDelimiter(const Aws::String& value) { m_delimiterHasBeenSet = true; m_delimiter = value; }
111 inline void SetDelimiter(Aws::String&& value) { m_delimiterHasBeenSet = true; m_delimiter = std::move(value); }
112 inline void SetDelimiter(const char* value) { m_delimiterHasBeenSet = true; m_delimiter.assign(value); }
113 inline ListObjectsV2Request& WithDelimiter(const Aws::String& value) { SetDelimiter(value); return *this;}
114 inline ListObjectsV2Request& WithDelimiter(Aws::String&& value) { SetDelimiter(std::move(value)); return *this;}
115 inline ListObjectsV2Request& WithDelimiter(const char* value) { SetDelimiter(value); return *this;}
117
119
135 inline const EncodingType& GetEncodingType() const{ return m_encodingType; }
136 inline bool EncodingTypeHasBeenSet() const { return m_encodingTypeHasBeenSet; }
137 inline void SetEncodingType(const EncodingType& value) { m_encodingTypeHasBeenSet = true; m_encodingType = value; }
138 inline void SetEncodingType(EncodingType&& value) { m_encodingTypeHasBeenSet = true; m_encodingType = std::move(value); }
139 inline ListObjectsV2Request& WithEncodingType(const EncodingType& value) { SetEncodingType(value); return *this;}
140 inline ListObjectsV2Request& WithEncodingType(EncodingType&& value) { SetEncodingType(std::move(value)); return *this;}
142
144
149 inline int GetMaxKeys() const{ return m_maxKeys; }
150 inline bool MaxKeysHasBeenSet() const { return m_maxKeysHasBeenSet; }
151 inline void SetMaxKeys(int value) { m_maxKeysHasBeenSet = true; m_maxKeys = value; }
152 inline ListObjectsV2Request& WithMaxKeys(int value) { SetMaxKeys(value); return *this;}
154
156
161 inline const Aws::String& GetPrefix() const{ return m_prefix; }
162 inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; }
163 inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; }
164 inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = std::move(value); }
165 inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); }
166 inline ListObjectsV2Request& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;}
167 inline ListObjectsV2Request& WithPrefix(Aws::String&& value) { SetPrefix(std::move(value)); return *this;}
168 inline ListObjectsV2Request& WithPrefix(const char* value) { SetPrefix(value); return *this;}
170
172
178 inline const Aws::String& GetContinuationToken() const{ return m_continuationToken; }
179 inline bool ContinuationTokenHasBeenSet() const { return m_continuationTokenHasBeenSet; }
180 inline void SetContinuationToken(const Aws::String& value) { m_continuationTokenHasBeenSet = true; m_continuationToken = value; }
181 inline void SetContinuationToken(Aws::String&& value) { m_continuationTokenHasBeenSet = true; m_continuationToken = std::move(value); }
182 inline void SetContinuationToken(const char* value) { m_continuationTokenHasBeenSet = true; m_continuationToken.assign(value); }
183 inline ListObjectsV2Request& WithContinuationToken(const Aws::String& value) { SetContinuationToken(value); return *this;}
184 inline ListObjectsV2Request& WithContinuationToken(Aws::String&& value) { SetContinuationToken(std::move(value)); return *this;}
185 inline ListObjectsV2Request& WithContinuationToken(const char* value) { SetContinuationToken(value); return *this;}
187
189
196 inline bool GetFetchOwner() const{ return m_fetchOwner; }
197 inline bool FetchOwnerHasBeenSet() const { return m_fetchOwnerHasBeenSet; }
198 inline void SetFetchOwner(bool value) { m_fetchOwnerHasBeenSet = true; m_fetchOwner = value; }
199 inline ListObjectsV2Request& WithFetchOwner(bool value) { SetFetchOwner(value); return *this;}
201
203
209 inline const Aws::String& GetStartAfter() const{ return m_startAfter; }
210 inline bool StartAfterHasBeenSet() const { return m_startAfterHasBeenSet; }
211 inline void SetStartAfter(const Aws::String& value) { m_startAfterHasBeenSet = true; m_startAfter = value; }
212 inline void SetStartAfter(Aws::String&& value) { m_startAfterHasBeenSet = true; m_startAfter = std::move(value); }
213 inline void SetStartAfter(const char* value) { m_startAfterHasBeenSet = true; m_startAfter.assign(value); }
214 inline ListObjectsV2Request& WithStartAfter(const Aws::String& value) { SetStartAfter(value); return *this;}
215 inline ListObjectsV2Request& WithStartAfter(Aws::String&& value) { SetStartAfter(std::move(value)); return *this;}
216 inline ListObjectsV2Request& WithStartAfter(const char* value) { SetStartAfter(value); return *this;}
218
220
226 inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
227 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
228 inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
229 inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
230 inline ListObjectsV2Request& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
231 inline ListObjectsV2Request& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
233
235
240 inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
241 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
242 inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
243 inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
244 inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
246 inline ListObjectsV2Request& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
247 inline ListObjectsV2Request& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
249
251
256 inline const Aws::Vector<OptionalObjectAttributes>& GetOptionalObjectAttributes() const{ return m_optionalObjectAttributes; }
257 inline bool OptionalObjectAttributesHasBeenSet() const { return m_optionalObjectAttributesHasBeenSet; }
258 inline void SetOptionalObjectAttributes(const Aws::Vector<OptionalObjectAttributes>& value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes = value; }
259 inline void SetOptionalObjectAttributes(Aws::Vector<OptionalObjectAttributes>&& value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes = std::move(value); }
262 inline ListObjectsV2Request& AddOptionalObjectAttributes(const OptionalObjectAttributes& value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes.push_back(value); return *this; }
263 inline ListObjectsV2Request& AddOptionalObjectAttributes(OptionalObjectAttributes&& value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes.push_back(std::move(value)); return *this; }
265
267
268 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
269 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
270 inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
271 inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
274 inline ListObjectsV2Request& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
275 inline ListObjectsV2Request& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
276 inline ListObjectsV2Request& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
277 inline ListObjectsV2Request& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
278 inline ListObjectsV2Request& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
279 inline ListObjectsV2Request& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
280 inline ListObjectsV2Request& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
282 private:
283
284 Aws::String m_bucket;
285 bool m_bucketHasBeenSet = false;
286
287 Aws::String m_delimiter;
288 bool m_delimiterHasBeenSet = false;
289
290 EncodingType m_encodingType;
291 bool m_encodingTypeHasBeenSet = false;
292
293 int m_maxKeys;
294 bool m_maxKeysHasBeenSet = false;
295
296 Aws::String m_prefix;
297 bool m_prefixHasBeenSet = false;
298
299 Aws::String m_continuationToken;
300 bool m_continuationTokenHasBeenSet = false;
301
302 bool m_fetchOwner;
303 bool m_fetchOwnerHasBeenSet = false;
304
305 Aws::String m_startAfter;
306 bool m_startAfterHasBeenSet = false;
307
308 RequestPayer m_requestPayer;
309 bool m_requestPayerHasBeenSet = false;
310
311 Aws::String m_expectedBucketOwner;
312 bool m_expectedBucketOwnerHasBeenSet = false;
313
314 Aws::Vector<OptionalObjectAttributes> m_optionalObjectAttributes;
315 bool m_optionalObjectAttributesHasBeenSet = false;
316
317 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
318 bool m_customizedAccessLogTagHasBeenSet = false;
319 };
320
321} // namespace Model
322} // namespace S3Crt
323} // namespace Aws
ListObjectsV2Request & WithOptionalObjectAttributes(const Aws::Vector< OptionalObjectAttributes > &value)
const Aws::String & GetContinuationToken() const
ListObjectsV2Request & WithPrefix(Aws::String &&value)
ListObjectsV2Request & AddCustomizedAccessLogTag(const char *key, const char *value)
ListObjectsV2Request & WithStartAfter(const Aws::String &value)
const Aws::String & GetExpectedBucketOwner() const
void SetOptionalObjectAttributes(Aws::Vector< OptionalObjectAttributes > &&value)
virtual const char * GetServiceRequestName() const override
ListObjectsV2Request & WithMaxKeys(int value)
ListObjectsV2Request & WithStartAfter(const char *value)
void SetBucket(const Aws::String &value)
AWS_S3CRT_API Aws::String SerializePayload() const override
ListObjectsV2Request & WithContinuationToken(const Aws::String &value)
ListObjectsV2Request & WithOptionalObjectAttributes(Aws::Vector< OptionalObjectAttributes > &&value)
ListObjectsV2Request & WithDelimiter(const Aws::String &value)
const Aws::Vector< OptionalObjectAttributes > & GetOptionalObjectAttributes() const
void SetOptionalObjectAttributes(const Aws::Vector< OptionalObjectAttributes > &value)
ListObjectsV2Request & WithBucket(const char *value)
ListObjectsV2Request & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
ListObjectsV2Request & WithExpectedBucketOwner(Aws::String &&value)
ListObjectsV2Request & WithExpectedBucketOwner(const char *value)
AWS_S3CRT_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
ListObjectsV2Request & WithBucket(const Aws::String &value)
ListObjectsV2Request & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
void SetPrefix(const Aws::String &value)
ListObjectsV2Request & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
ListObjectsV2Request & WithPrefix(const Aws::String &value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
ListObjectsV2Request & WithContinuationToken(Aws::String &&value)
void SetRequestPayer(const RequestPayer &value)
ListObjectsV2Request & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
void SetStartAfter(const Aws::String &value)
ListObjectsV2Request & WithBucket(Aws::String &&value)
AWS_S3CRT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
ListObjectsV2Request & WithEncodingType(EncodingType &&value)
const EncodingType & GetEncodingType() const
AWS_S3CRT_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
ListObjectsV2Request & WithRequestPayer(const RequestPayer &value)
void SetDelimiter(const Aws::String &value)
ListObjectsV2Request & WithExpectedBucketOwner(const Aws::String &value)
void SetExpectedBucketOwner(const Aws::String &value)
ListObjectsV2Request & WithPrefix(const char *value)
ListObjectsV2Request & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
ListObjectsV2Request & WithDelimiter(const char *value)
ListObjectsV2Request & WithFetchOwner(bool value)
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
ListObjectsV2Request & AddOptionalObjectAttributes(const OptionalObjectAttributes &value)
ListObjectsV2Request & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
AWS_S3CRT_API EndpointParameters GetEndpointContextParams() const override
ListObjectsV2Request & WithEncodingType(const EncodingType &value)
ListObjectsV2Request & WithContinuationToken(const char *value)
void SetEncodingType(const EncodingType &value)
void SetContinuationToken(const Aws::String &value)
ListObjectsV2Request & WithDelimiter(Aws::String &&value)
const RequestPayer & GetRequestPayer() const
ListObjectsV2Request & WithStartAfter(Aws::String &&value)
ListObjectsV2Request & WithRequestPayer(RequestPayer &&value)
ListObjectsV2Request & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
ListObjectsV2Request & AddOptionalObjectAttributes(OptionalObjectAttributes &&value)
ListObjectsV2Request & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
Aws::Endpoint::EndpointParameters EndpointParameters
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_iostream< char, std::char_traits< char > > IOStream
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector