AWS SDK for C++

AWS SDK for C++ Version 1.11.607

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() = default;
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
88 inline const Aws::String& GetBucket() const { return m_bucket; }
89 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
90 template<typename BucketT = Aws::String>
91 void SetBucket(BucketT&& value) { m_bucketHasBeenSet = true; m_bucket = std::forward<BucketT>(value); }
92 template<typename BucketT = Aws::String>
93 ListObjectsV2Request& WithBucket(BucketT&& value) { SetBucket(std::forward<BucketT>(value)); return *this;}
95
97
110 inline const Aws::String& GetDelimiter() const { return m_delimiter; }
111 inline bool DelimiterHasBeenSet() const { return m_delimiterHasBeenSet; }
112 template<typename DelimiterT = Aws::String>
113 void SetDelimiter(DelimiterT&& value) { m_delimiterHasBeenSet = true; m_delimiter = std::forward<DelimiterT>(value); }
114 template<typename DelimiterT = Aws::String>
115 ListObjectsV2Request& WithDelimiter(DelimiterT&& value) { SetDelimiter(std::forward<DelimiterT>(value)); return *this;}
117
119
135 inline EncodingType GetEncodingType() const { return m_encodingType; }
136 inline bool EncodingTypeHasBeenSet() const { return m_encodingTypeHasBeenSet; }
137 inline void SetEncodingType(EncodingType value) { m_encodingTypeHasBeenSet = true; m_encodingType = value; }
140
142
147 inline int GetMaxKeys() const { return m_maxKeys; }
148 inline bool MaxKeysHasBeenSet() const { return m_maxKeysHasBeenSet; }
149 inline void SetMaxKeys(int value) { m_maxKeysHasBeenSet = true; m_maxKeys = value; }
150 inline ListObjectsV2Request& WithMaxKeys(int value) { SetMaxKeys(value); return *this;}
152
154
159 inline const Aws::String& GetPrefix() const { return m_prefix; }
160 inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; }
161 template<typename PrefixT = Aws::String>
162 void SetPrefix(PrefixT&& value) { m_prefixHasBeenSet = true; m_prefix = std::forward<PrefixT>(value); }
163 template<typename PrefixT = Aws::String>
164 ListObjectsV2Request& WithPrefix(PrefixT&& value) { SetPrefix(std::forward<PrefixT>(value)); return *this;}
166
168
174 inline const Aws::String& GetContinuationToken() const { return m_continuationToken; }
175 inline bool ContinuationTokenHasBeenSet() const { return m_continuationTokenHasBeenSet; }
176 template<typename ContinuationTokenT = Aws::String>
177 void SetContinuationToken(ContinuationTokenT&& value) { m_continuationTokenHasBeenSet = true; m_continuationToken = std::forward<ContinuationTokenT>(value); }
178 template<typename ContinuationTokenT = Aws::String>
179 ListObjectsV2Request& WithContinuationToken(ContinuationTokenT&& value) { SetContinuationToken(std::forward<ContinuationTokenT>(value)); return *this;}
181
183
190 inline bool GetFetchOwner() const { return m_fetchOwner; }
191 inline bool FetchOwnerHasBeenSet() const { return m_fetchOwnerHasBeenSet; }
192 inline void SetFetchOwner(bool value) { m_fetchOwnerHasBeenSet = true; m_fetchOwner = value; }
193 inline ListObjectsV2Request& WithFetchOwner(bool value) { SetFetchOwner(value); return *this;}
195
197
203 inline const Aws::String& GetStartAfter() const { return m_startAfter; }
204 inline bool StartAfterHasBeenSet() const { return m_startAfterHasBeenSet; }
205 template<typename StartAfterT = Aws::String>
206 void SetStartAfter(StartAfterT&& value) { m_startAfterHasBeenSet = true; m_startAfter = std::forward<StartAfterT>(value); }
207 template<typename StartAfterT = Aws::String>
208 ListObjectsV2Request& WithStartAfter(StartAfterT&& value) { SetStartAfter(std::forward<StartAfterT>(value)); return *this;}
210
212
218 inline RequestPayer GetRequestPayer() const { return m_requestPayer; }
219 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
220 inline void SetRequestPayer(RequestPayer value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
223
225
230 inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; }
231 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
232 template<typename ExpectedBucketOwnerT = Aws::String>
233 void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::forward<ExpectedBucketOwnerT>(value); }
234 template<typename ExpectedBucketOwnerT = Aws::String>
235 ListObjectsV2Request& WithExpectedBucketOwner(ExpectedBucketOwnerT&& value) { SetExpectedBucketOwner(std::forward<ExpectedBucketOwnerT>(value)); return *this;}
237
239
244 inline const Aws::Vector<OptionalObjectAttributes>& GetOptionalObjectAttributes() const { return m_optionalObjectAttributes; }
245 inline bool OptionalObjectAttributesHasBeenSet() const { return m_optionalObjectAttributesHasBeenSet; }
246 template<typename OptionalObjectAttributesT = Aws::Vector<OptionalObjectAttributes>>
247 void SetOptionalObjectAttributes(OptionalObjectAttributesT&& value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes = std::forward<OptionalObjectAttributesT>(value); }
248 template<typename OptionalObjectAttributesT = Aws::Vector<OptionalObjectAttributes>>
249 ListObjectsV2Request& WithOptionalObjectAttributes(OptionalObjectAttributesT&& value) { SetOptionalObjectAttributes(std::forward<OptionalObjectAttributesT>(value)); return *this;}
250 inline ListObjectsV2Request& AddOptionalObjectAttributes(OptionalObjectAttributes value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes.push_back(value); return *this; }
252
254
255 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
256 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
257 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
258 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value); }
259 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
260 ListObjectsV2Request& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value)); return *this;}
261 template<typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
262 ListObjectsV2Request& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
263 m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value)); return *this;
264 }
266 private:
267
268 Aws::String m_bucket;
269 bool m_bucketHasBeenSet = false;
270
271 Aws::String m_delimiter;
272 bool m_delimiterHasBeenSet = false;
273
274 EncodingType m_encodingType{EncodingType::NOT_SET};
275 bool m_encodingTypeHasBeenSet = false;
276
277 int m_maxKeys{0};
278 bool m_maxKeysHasBeenSet = false;
279
280 Aws::String m_prefix;
281 bool m_prefixHasBeenSet = false;
282
283 Aws::String m_continuationToken;
284 bool m_continuationTokenHasBeenSet = false;
285
286 bool m_fetchOwner{false};
287 bool m_fetchOwnerHasBeenSet = false;
288
289 Aws::String m_startAfter;
290 bool m_startAfterHasBeenSet = false;
291
292 RequestPayer m_requestPayer{RequestPayer::NOT_SET};
293 bool m_requestPayerHasBeenSet = false;
294
295 Aws::String m_expectedBucketOwner;
296 bool m_expectedBucketOwnerHasBeenSet = false;
297
298 Aws::Vector<OptionalObjectAttributes> m_optionalObjectAttributes;
299 bool m_optionalObjectAttributesHasBeenSet = false;
300
301 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
302 bool m_customizedAccessLogTagHasBeenSet = false;
303 };
304
305} // namespace Model
306} // namespace S3Crt
307} // namespace Aws
void SetCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
const Aws::String & GetContinuationToken() const
ListObjectsV2Request & WithOptionalObjectAttributes(OptionalObjectAttributesT &&value)
const Aws::String & GetExpectedBucketOwner() const
ListObjectsV2Request & WithRequestPayer(RequestPayer value)
virtual const char * GetServiceRequestName() const override
ListObjectsV2Request & WithMaxKeys(int value)
ListObjectsV2Request & WithPrefix(PrefixT &&value)
AWS_S3CRT_API Aws::String SerializePayload() const override
ListObjectsV2Request & WithEncodingType(EncodingType value)
const Aws::Vector< OptionalObjectAttributes > & GetOptionalObjectAttributes() const
ListObjectsV2Request & WithDelimiter(DelimiterT &&value)
AWS_S3CRT_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
ListObjectsV2Request & WithExpectedBucketOwner(ExpectedBucketOwnerT &&value)
ListObjectsV2Request & WithCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
AWS_S3CRT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
ListObjectsV2Request & WithStartAfter(StartAfterT &&value)
AWS_S3CRT_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
void SetOptionalObjectAttributes(OptionalObjectAttributesT &&value)
ListObjectsV2Request & WithFetchOwner(bool value)
ListObjectsV2Request & WithContinuationToken(ContinuationTokenT &&value)
AWS_S3CRT_API ListObjectsV2Request()=default
AWS_S3CRT_API EndpointParameters GetEndpointContextParams() const override
void SetContinuationToken(ContinuationTokenT &&value)
ListObjectsV2Request & AddOptionalObjectAttributes(OptionalObjectAttributes value)
ListObjectsV2Request & WithBucket(BucketT &&value)
void SetExpectedBucketOwner(ExpectedBucketOwnerT &&value)
ListObjectsV2Request & AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT &&key, CustomizedAccessLogTagValueT &&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