AWS SDK for C++

AWS SDK for C++ Version 1.11.844

Loading...
Searching...
No Matches
PutObjectAnnotationRequest.h
1
6#pragma once
7#include <aws/core/utils/Array.h>
8#include <aws/core/utils/memory/stl/AWSMap.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/s3-crt/S3CrtRequest.h>
11#include <aws/s3-crt/S3Crt_EXPORTS.h>
12#include <aws/s3-crt/model/ChecksumAlgorithm.h>
13#include <aws/s3-crt/model/RequestPayer.h>
14
15#include <utility>
16
17namespace Aws {
18namespace Http {
19class URI;
20} // namespace Http
21namespace S3Crt {
22namespace Model {
23
27 public:
28 AWS_S3CRT_API PutObjectAnnotationRequest() = default;
29
30 // Service request name is the Operation name which will send this request out,
31 // each operation should has unique request name, so that we can get operation's name from this request.
32 // Note: this is not true for response, multiple operations may have the same response name,
33 // so we can not get operation's name from response.
34 inline virtual const char* GetServiceRequestName() const override { return "PutObjectAnnotation"; }
35
36 AWS_S3CRT_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
37
39
40 AWS_S3CRT_API Aws::String GetChecksumAlgorithmName() const override;
41 AWS_S3CRT_API bool ChecksumAlgorithmIsSet() const override;
42 AWS_S3CRT_API bool IsStreaming() const override { return false; }
43
47 AWS_S3CRT_API EndpointParameters GetEndpointContextParams() const override;
48
50
53 inline const Aws::String& GetBucket() const { return m_bucket; }
54 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
55 template <typename BucketT = Aws::String>
56 void SetBucket(BucketT&& value) {
57 m_bucketHasBeenSet = true;
58 m_bucket = std::forward<BucketT>(value);
59 }
60 template <typename BucketT = Aws::String>
62 SetBucket(std::forward<BucketT>(value));
63 return *this;
64 }
66
68
71 inline const Aws::String& GetKey() const { return m_key; }
72 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
73 template <typename KeyT = Aws::String>
74 void SetKey(KeyT&& value) {
75 m_keyHasBeenSet = true;
76 m_key = std::forward<KeyT>(value);
77 }
78 template <typename KeyT = Aws::String>
80 SetKey(std::forward<KeyT>(value));
81 return *this;
82 }
84
86
89 inline const Aws::String& GetVersionId() const { return m_versionId; }
90 inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
91 template <typename VersionIdT = Aws::String>
92 void SetVersionId(VersionIdT&& value) {
93 m_versionIdHasBeenSet = true;
94 m_versionId = std::forward<VersionIdT>(value);
95 }
96 template <typename VersionIdT = Aws::String>
98 SetVersionId(std::forward<VersionIdT>(value));
99 return *this;
100 }
102
104
108 inline const Aws::String& GetAnnotationName() const { return m_annotationName; }
109 inline bool AnnotationNameHasBeenSet() const { return m_annotationNameHasBeenSet; }
110 template <typename AnnotationNameT = Aws::String>
111 void SetAnnotationName(AnnotationNameT&& value) {
112 m_annotationNameHasBeenSet = true;
113 m_annotationName = std::forward<AnnotationNameT>(value);
114 }
115 template <typename AnnotationNameT = Aws::String>
117 SetAnnotationName(std::forward<AnnotationNameT>(value));
118 return *this;
119 }
121
123
127 inline const Aws::String& GetObjectIfMatch() const { return m_objectIfMatch; }
128 inline bool ObjectIfMatchHasBeenSet() const { return m_objectIfMatchHasBeenSet; }
129 template <typename ObjectIfMatchT = Aws::String>
130 void SetObjectIfMatch(ObjectIfMatchT&& value) {
131 m_objectIfMatchHasBeenSet = true;
132 m_objectIfMatch = std::forward<ObjectIfMatchT>(value);
133 }
134 template <typename ObjectIfMatchT = Aws::String>
136 SetObjectIfMatch(std::forward<ObjectIfMatchT>(value));
137 return *this;
138 }
140
142
148 inline ChecksumAlgorithm GetChecksumAlgorithm() const { return m_checksumAlgorithm; }
149 inline bool ChecksumAlgorithmHasBeenSet() const { return m_checksumAlgorithmHasBeenSet; }
151 m_checksumAlgorithmHasBeenSet = true;
152 m_checksumAlgorithm = value;
153 }
156 return *this;
157 }
159
161
164 inline const Aws::String& GetChecksumCRC32() const { return m_checksumCRC32; }
165 inline bool ChecksumCRC32HasBeenSet() const { return m_checksumCRC32HasBeenSet; }
166 template <typename ChecksumCRC32T = Aws::String>
167 void SetChecksumCRC32(ChecksumCRC32T&& value) {
168 m_checksumCRC32HasBeenSet = true;
169 m_checksumCRC32 = std::forward<ChecksumCRC32T>(value);
171 }
172 inline void SetChecksumCRC32(const char* value) {
173 m_checksumCRC32HasBeenSet = true;
174 m_checksumCRC32.assign(value);
176 }
177 template <typename ChecksumCRC32T = Aws::String>
179 SetChecksumCRC32(std::forward<ChecksumCRC32T>(value));
180 return *this;
181 }
183
185
188 inline const Aws::String& GetChecksumCRC32C() const { return m_checksumCRC32C; }
189 inline bool ChecksumCRC32CHasBeenSet() const { return m_checksumCRC32CHasBeenSet; }
190 template <typename ChecksumCRC32CT = Aws::String>
191 void SetChecksumCRC32C(ChecksumCRC32CT&& value) {
192 m_checksumCRC32CHasBeenSet = true;
193 m_checksumCRC32C = std::forward<ChecksumCRC32CT>(value);
195 }
196 inline void SetChecksumCRC32C(const char* value) {
197 m_checksumCRC32CHasBeenSet = true;
198 m_checksumCRC32C.assign(value);
200 }
201 template <typename ChecksumCRC32CT = Aws::String>
203 SetChecksumCRC32C(std::forward<ChecksumCRC32CT>(value));
204 return *this;
205 }
207
209
212 inline const Aws::String& GetChecksumCRC64NVME() const { return m_checksumCRC64NVME; }
213 inline bool ChecksumCRC64NVMEHasBeenSet() const { return m_checksumCRC64NVMEHasBeenSet; }
214 template <typename ChecksumCRC64NVMET = Aws::String>
215 void SetChecksumCRC64NVME(ChecksumCRC64NVMET&& value) {
216 m_checksumCRC64NVMEHasBeenSet = true;
217 m_checksumCRC64NVME = std::forward<ChecksumCRC64NVMET>(value);
218 }
219 template <typename ChecksumCRC64NVMET = Aws::String>
221 SetChecksumCRC64NVME(std::forward<ChecksumCRC64NVMET>(value));
222 return *this;
223 }
225
227
230 inline const Aws::String& GetChecksumSHA1() const { return m_checksumSHA1; }
231 inline bool ChecksumSHA1HasBeenSet() const { return m_checksumSHA1HasBeenSet; }
232 template <typename ChecksumSHA1T = Aws::String>
233 void SetChecksumSHA1(ChecksumSHA1T&& value) {
234 m_checksumSHA1HasBeenSet = true;
235 m_checksumSHA1 = std::forward<ChecksumSHA1T>(value);
237 }
238 inline void SetChecksumSHA1(const char* value) {
239 m_checksumSHA1HasBeenSet = true;
240 m_checksumSHA1.assign(value);
242 }
243 template <typename ChecksumSHA1T = Aws::String>
245 SetChecksumSHA1(std::forward<ChecksumSHA1T>(value));
246 return *this;
247 }
249
251
254 inline const Aws::String& GetChecksumSHA256() const { return m_checksumSHA256; }
255 inline bool ChecksumSHA256HasBeenSet() const { return m_checksumSHA256HasBeenSet; }
256 template <typename ChecksumSHA256T = Aws::String>
257 void SetChecksumSHA256(ChecksumSHA256T&& value) {
258 m_checksumSHA256HasBeenSet = true;
259 m_checksumSHA256 = std::forward<ChecksumSHA256T>(value);
261 }
262 inline void SetChecksumSHA256(const char* value) {
263 m_checksumSHA256HasBeenSet = true;
264 m_checksumSHA256.assign(value);
266 }
267 template <typename ChecksumSHA256T = Aws::String>
269 SetChecksumSHA256(std::forward<ChecksumSHA256T>(value));
270 return *this;
271 }
273
275
278 inline const Aws::String& GetChecksumSHA512() const { return m_checksumSHA512; }
279 inline bool ChecksumSHA512HasBeenSet() const { return m_checksumSHA512HasBeenSet; }
280 template <typename ChecksumSHA512T = Aws::String>
281 void SetChecksumSHA512(ChecksumSHA512T&& value) {
282 m_checksumSHA512HasBeenSet = true;
283 m_checksumSHA512 = std::forward<ChecksumSHA512T>(value);
285 }
286 inline void SetChecksumSHA512(const char* value) {
287 m_checksumSHA512HasBeenSet = true;
288 m_checksumSHA512.assign(value);
290 }
291 template <typename ChecksumSHA512T = Aws::String>
293 SetChecksumSHA512(std::forward<ChecksumSHA512T>(value));
294 return *this;
295 }
297
299
302 inline const Aws::String& GetChecksumMD5() const { return m_checksumMD5; }
303 inline bool ChecksumMD5HasBeenSet() const { return m_checksumMD5HasBeenSet; }
304 template <typename ChecksumMD5T = Aws::String>
305 void SetChecksumMD5(ChecksumMD5T&& value) {
306 m_checksumMD5HasBeenSet = true;
307 m_checksumMD5 = std::forward<ChecksumMD5T>(value);
309 }
310 inline void SetChecksumMD5(const char* value) {
311 m_checksumMD5HasBeenSet = true;
312 m_checksumMD5.assign(value);
314 }
315 template <typename ChecksumMD5T = Aws::String>
317 SetChecksumMD5(std::forward<ChecksumMD5T>(value));
318 return *this;
319 }
321
323
326 inline const Aws::String& GetChecksumXXHASH64() const { return m_checksumXXHASH64; }
327 inline bool ChecksumXXHASH64HasBeenSet() const { return m_checksumXXHASH64HasBeenSet; }
328 template <typename ChecksumXXHASH64T = Aws::String>
329 void SetChecksumXXHASH64(ChecksumXXHASH64T&& value) {
330 m_checksumXXHASH64HasBeenSet = true;
331 m_checksumXXHASH64 = std::forward<ChecksumXXHASH64T>(value);
333 }
334 inline void SetChecksumXXHASH64(const char* value) {
335 m_checksumXXHASH64HasBeenSet = true;
336 m_checksumXXHASH64.assign(value);
338 }
339 template <typename ChecksumXXHASH64T = Aws::String>
341 SetChecksumXXHASH64(std::forward<ChecksumXXHASH64T>(value));
342 return *this;
343 }
345
347
350 inline const Aws::String& GetChecksumXXHASH3() const { return m_checksumXXHASH3; }
351 inline bool ChecksumXXHASH3HasBeenSet() const { return m_checksumXXHASH3HasBeenSet; }
352 template <typename ChecksumXXHASH3T = Aws::String>
353 void SetChecksumXXHASH3(ChecksumXXHASH3T&& value) {
354 m_checksumXXHASH3HasBeenSet = true;
355 m_checksumXXHASH3 = std::forward<ChecksumXXHASH3T>(value);
357 }
358 inline void SetChecksumXXHASH3(const char* value) {
359 m_checksumXXHASH3HasBeenSet = true;
360 m_checksumXXHASH3.assign(value);
362 }
363 template <typename ChecksumXXHASH3T = Aws::String>
365 SetChecksumXXHASH3(std::forward<ChecksumXXHASH3T>(value));
366 return *this;
367 }
369
371
374 inline const Aws::String& GetChecksumXXHASH128() const { return m_checksumXXHASH128; }
375 inline bool ChecksumXXHASH128HasBeenSet() const { return m_checksumXXHASH128HasBeenSet; }
376 template <typename ChecksumXXHASH128T = Aws::String>
377 void SetChecksumXXHASH128(ChecksumXXHASH128T&& value) {
378 m_checksumXXHASH128HasBeenSet = true;
379 m_checksumXXHASH128 = std::forward<ChecksumXXHASH128T>(value);
381 }
382 inline void SetChecksumXXHASH128(const char* value) {
383 m_checksumXXHASH128HasBeenSet = true;
384 m_checksumXXHASH128.assign(value);
386 }
387 template <typename ChecksumXXHASH128T = Aws::String>
389 SetChecksumXXHASH128(std::forward<ChecksumXXHASH128T>(value));
390 return *this;
391 }
393
395
398 inline const Aws::String& GetContentMD5() const { return m_contentMD5; }
399 inline bool ContentMD5HasBeenSet() const { return m_contentMD5HasBeenSet; }
400 template <typename ContentMD5T = Aws::String>
401 void SetContentMD5(ContentMD5T&& value) {
402 m_contentMD5HasBeenSet = true;
403 m_contentMD5 = std::forward<ContentMD5T>(value);
404 }
405 template <typename ContentMD5T = Aws::String>
407 SetContentMD5(std::forward<ContentMD5T>(value));
408 return *this;
409 }
411
413
414 inline RequestPayer GetRequestPayer() const { return m_requestPayer; }
415 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
416 inline void SetRequestPayer(RequestPayer value) {
417 m_requestPayerHasBeenSet = true;
418 m_requestPayer = value;
419 }
421 SetRequestPayer(value);
422 return *this;
423 }
425
427
431 inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; }
432 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
433 template <typename ExpectedBucketOwnerT = Aws::String>
434 void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) {
435 m_expectedBucketOwnerHasBeenSet = true;
436 m_expectedBucketOwner = std::forward<ExpectedBucketOwnerT>(value);
437 }
438 template <typename ExpectedBucketOwnerT = Aws::String>
440 SetExpectedBucketOwner(std::forward<ExpectedBucketOwnerT>(value));
441 return *this;
442 }
444
446
447 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
448 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
449 template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
450 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
451 m_customizedAccessLogTagHasBeenSet = true;
452 m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value);
453 }
454 template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
455 PutObjectAnnotationRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
456 SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value));
457 return *this;
458 }
459 template <typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
460 PutObjectAnnotationRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
461 m_customizedAccessLogTagHasBeenSet = true;
462 m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value));
463 return *this;
464 }
466 private:
467 Aws::String m_bucket;
468
469 Aws::String m_key;
470
471 Aws::String m_versionId;
472
473 Aws::String m_annotationName;
474
475 Aws::String m_objectIfMatch;
476
478
479 Aws::String m_checksumCRC32;
480
481 Aws::String m_checksumCRC32C;
482
483 Aws::String m_checksumCRC64NVME;
484
485 Aws::String m_checksumSHA1;
486
487 Aws::String m_checksumSHA256;
488
489 Aws::String m_checksumSHA512;
490
491 Aws::String m_checksumMD5;
492
493 Aws::String m_checksumXXHASH64;
494
495 Aws::String m_checksumXXHASH3;
496
497 Aws::String m_checksumXXHASH128;
498
499 Aws::String m_contentMD5;
500
501 RequestPayer m_requestPayer{RequestPayer::NOT_SET};
502
503 Aws::String m_expectedBucketOwner;
504
505 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
506 bool m_bucketHasBeenSet = false;
507 bool m_keyHasBeenSet = false;
508 bool m_versionIdHasBeenSet = false;
509 bool m_annotationNameHasBeenSet = false;
510 bool m_objectIfMatchHasBeenSet = false;
511 bool m_checksumAlgorithmHasBeenSet = false;
512 bool m_checksumCRC32HasBeenSet = false;
513 bool m_checksumCRC32CHasBeenSet = false;
514 bool m_checksumCRC64NVMEHasBeenSet = false;
515 bool m_checksumSHA1HasBeenSet = false;
516 bool m_checksumSHA256HasBeenSet = false;
517 bool m_checksumSHA512HasBeenSet = false;
518 bool m_checksumMD5HasBeenSet = false;
519 bool m_checksumXXHASH64HasBeenSet = false;
520 bool m_checksumXXHASH3HasBeenSet = false;
521 bool m_checksumXXHASH128HasBeenSet = false;
522 bool m_contentMD5HasBeenSet = false;
523 bool m_requestPayerHasBeenSet = false;
524 bool m_expectedBucketOwnerHasBeenSet = false;
525 bool m_customizedAccessLogTagHasBeenSet = false;
526};
527
528} // namespace Model
529} // namespace S3Crt
530} // namespace Aws
Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters
AWS_S3CRT_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
PutObjectAnnotationRequest & WithChecksumMD5(ChecksumMD5T &&value)
PutObjectAnnotationRequest & WithCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
PutObjectAnnotationRequest & WithChecksumCRC32C(ChecksumCRC32CT &&value)
PutObjectAnnotationRequest & WithChecksumSHA512(ChecksumSHA512T &&value)
PutObjectAnnotationRequest & WithBucket(BucketT &&value)
PutObjectAnnotationRequest & AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT &&key, CustomizedAccessLogTagValueT &&value)
PutObjectAnnotationRequest & WithChecksumSHA256(ChecksumSHA256T &&value)
void SetCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
PutObjectAnnotationRequest & WithExpectedBucketOwner(ExpectedBucketOwnerT &&value)
PutObjectAnnotationRequest & WithChecksumSHA1(ChecksumSHA1T &&value)
virtual const char * GetServiceRequestName() const override
PutObjectAnnotationRequest & WithChecksumXXHASH128(ChecksumXXHASH128T &&value)
PutObjectAnnotationRequest & WithChecksumCRC64NVME(ChecksumCRC64NVMET &&value)
PutObjectAnnotationRequest & WithChecksumXXHASH3(ChecksumXXHASH3T &&value)
PutObjectAnnotationRequest & WithChecksumCRC32(ChecksumCRC32T &&value)
PutObjectAnnotationRequest & WithChecksumAlgorithm(ChecksumAlgorithm value)
AWS_S3CRT_API EndpointParameters GetEndpointContextParams() const override
PutObjectAnnotationRequest & WithObjectIfMatch(ObjectIfMatchT &&value)
PutObjectAnnotationRequest & WithContentMD5(ContentMD5T &&value)
PutObjectAnnotationRequest & WithChecksumXXHASH64(ChecksumXXHASH64T &&value)
PutObjectAnnotationRequest & WithAnnotationName(AnnotationNameT &&value)
PutObjectAnnotationRequest & WithKey(KeyT &&value)
void SetExpectedBucketOwner(ExpectedBucketOwnerT &&value)
AWS_S3CRT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
AWS_S3CRT_API PutObjectAnnotationRequest()=default
AWS_S3CRT_API bool ChecksumAlgorithmIsSet() const override
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
PutObjectAnnotationRequest & WithRequestPayer(RequestPayer value)
PutObjectAnnotationRequest & WithVersionId(VersionIdT &&value)
AWS_S3CRT_API Aws::String GetChecksumAlgorithmName() const override
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String