AWS SDK for C++

AWS SDK for C++ Version 1.11.830

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 IsStreaming() const override { return false; }
42
46 AWS_S3CRT_API EndpointParameters GetEndpointContextParams() const override;
47
49
52 inline const Aws::String& GetBucket() const { return m_bucket; }
53 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
54 template <typename BucketT = Aws::String>
55 void SetBucket(BucketT&& value) {
56 m_bucketHasBeenSet = true;
57 m_bucket = std::forward<BucketT>(value);
58 }
59 template <typename BucketT = Aws::String>
61 SetBucket(std::forward<BucketT>(value));
62 return *this;
63 }
65
67
70 inline const Aws::String& GetKey() const { return m_key; }
71 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
72 template <typename KeyT = Aws::String>
73 void SetKey(KeyT&& value) {
74 m_keyHasBeenSet = true;
75 m_key = std::forward<KeyT>(value);
76 }
77 template <typename KeyT = Aws::String>
79 SetKey(std::forward<KeyT>(value));
80 return *this;
81 }
83
85
88 inline const Aws::String& GetVersionId() const { return m_versionId; }
89 inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
90 template <typename VersionIdT = Aws::String>
91 void SetVersionId(VersionIdT&& value) {
92 m_versionIdHasBeenSet = true;
93 m_versionId = std::forward<VersionIdT>(value);
94 }
95 template <typename VersionIdT = Aws::String>
97 SetVersionId(std::forward<VersionIdT>(value));
98 return *this;
99 }
101
103
107 inline const Aws::String& GetAnnotationName() const { return m_annotationName; }
108 inline bool AnnotationNameHasBeenSet() const { return m_annotationNameHasBeenSet; }
109 template <typename AnnotationNameT = Aws::String>
110 void SetAnnotationName(AnnotationNameT&& value) {
111 m_annotationNameHasBeenSet = true;
112 m_annotationName = std::forward<AnnotationNameT>(value);
113 }
114 template <typename AnnotationNameT = Aws::String>
116 SetAnnotationName(std::forward<AnnotationNameT>(value));
117 return *this;
118 }
120
122
126 inline const Aws::String& GetObjectIfMatch() const { return m_objectIfMatch; }
127 inline bool ObjectIfMatchHasBeenSet() const { return m_objectIfMatchHasBeenSet; }
128 template <typename ObjectIfMatchT = Aws::String>
129 void SetObjectIfMatch(ObjectIfMatchT&& value) {
130 m_objectIfMatchHasBeenSet = true;
131 m_objectIfMatch = std::forward<ObjectIfMatchT>(value);
132 }
133 template <typename ObjectIfMatchT = Aws::String>
135 SetObjectIfMatch(std::forward<ObjectIfMatchT>(value));
136 return *this;
137 }
139
141
147 inline ChecksumAlgorithm GetChecksumAlgorithm() const { return m_checksumAlgorithm; }
148 inline bool ChecksumAlgorithmHasBeenSet() const { return m_checksumAlgorithmHasBeenSet; }
150 m_checksumAlgorithmHasBeenSet = true;
151 m_checksumAlgorithm = value;
152 }
155 return *this;
156 }
158
160
163 inline const Aws::String& GetChecksumCRC32() const { return m_checksumCRC32; }
164 inline bool ChecksumCRC32HasBeenSet() const { return m_checksumCRC32HasBeenSet; }
165 template <typename ChecksumCRC32T = Aws::String>
166 void SetChecksumCRC32(ChecksumCRC32T&& value) {
167 m_checksumCRC32HasBeenSet = true;
168 m_checksumCRC32 = std::forward<ChecksumCRC32T>(value);
170 }
171 inline void SetChecksumCRC32(const char* value) {
172 m_checksumCRC32HasBeenSet = true;
173 m_checksumCRC32.assign(value);
175 }
176 template <typename ChecksumCRC32T = Aws::String>
178 SetChecksumCRC32(std::forward<ChecksumCRC32T>(value));
179 return *this;
180 }
182
184
187 inline const Aws::String& GetChecksumCRC32C() const { return m_checksumCRC32C; }
188 inline bool ChecksumCRC32CHasBeenSet() const { return m_checksumCRC32CHasBeenSet; }
189 template <typename ChecksumCRC32CT = Aws::String>
190 void SetChecksumCRC32C(ChecksumCRC32CT&& value) {
191 m_checksumCRC32CHasBeenSet = true;
192 m_checksumCRC32C = std::forward<ChecksumCRC32CT>(value);
194 }
195 inline void SetChecksumCRC32C(const char* value) {
196 m_checksumCRC32CHasBeenSet = true;
197 m_checksumCRC32C.assign(value);
199 }
200 template <typename ChecksumCRC32CT = Aws::String>
202 SetChecksumCRC32C(std::forward<ChecksumCRC32CT>(value));
203 return *this;
204 }
206
208
211 inline const Aws::String& GetChecksumCRC64NVME() const { return m_checksumCRC64NVME; }
212 inline bool ChecksumCRC64NVMEHasBeenSet() const { return m_checksumCRC64NVMEHasBeenSet; }
213 template <typename ChecksumCRC64NVMET = Aws::String>
214 void SetChecksumCRC64NVME(ChecksumCRC64NVMET&& value) {
215 m_checksumCRC64NVMEHasBeenSet = true;
216 m_checksumCRC64NVME = std::forward<ChecksumCRC64NVMET>(value);
217 }
218 template <typename ChecksumCRC64NVMET = Aws::String>
220 SetChecksumCRC64NVME(std::forward<ChecksumCRC64NVMET>(value));
221 return *this;
222 }
224
226
229 inline const Aws::String& GetChecksumSHA1() const { return m_checksumSHA1; }
230 inline bool ChecksumSHA1HasBeenSet() const { return m_checksumSHA1HasBeenSet; }
231 template <typename ChecksumSHA1T = Aws::String>
232 void SetChecksumSHA1(ChecksumSHA1T&& value) {
233 m_checksumSHA1HasBeenSet = true;
234 m_checksumSHA1 = std::forward<ChecksumSHA1T>(value);
236 }
237 inline void SetChecksumSHA1(const char* value) {
238 m_checksumSHA1HasBeenSet = true;
239 m_checksumSHA1.assign(value);
241 }
242 template <typename ChecksumSHA1T = Aws::String>
244 SetChecksumSHA1(std::forward<ChecksumSHA1T>(value));
245 return *this;
246 }
248
250
253 inline const Aws::String& GetChecksumSHA256() const { return m_checksumSHA256; }
254 inline bool ChecksumSHA256HasBeenSet() const { return m_checksumSHA256HasBeenSet; }
255 template <typename ChecksumSHA256T = Aws::String>
256 void SetChecksumSHA256(ChecksumSHA256T&& value) {
257 m_checksumSHA256HasBeenSet = true;
258 m_checksumSHA256 = std::forward<ChecksumSHA256T>(value);
260 }
261 inline void SetChecksumSHA256(const char* value) {
262 m_checksumSHA256HasBeenSet = true;
263 m_checksumSHA256.assign(value);
265 }
266 template <typename ChecksumSHA256T = Aws::String>
268 SetChecksumSHA256(std::forward<ChecksumSHA256T>(value));
269 return *this;
270 }
272
274
277 inline const Aws::String& GetChecksumSHA512() const { return m_checksumSHA512; }
278 inline bool ChecksumSHA512HasBeenSet() const { return m_checksumSHA512HasBeenSet; }
279 template <typename ChecksumSHA512T = Aws::String>
280 void SetChecksumSHA512(ChecksumSHA512T&& value) {
281 m_checksumSHA512HasBeenSet = true;
282 m_checksumSHA512 = std::forward<ChecksumSHA512T>(value);
284 }
285 inline void SetChecksumSHA512(const char* value) {
286 m_checksumSHA512HasBeenSet = true;
287 m_checksumSHA512.assign(value);
289 }
290 template <typename ChecksumSHA512T = Aws::String>
292 SetChecksumSHA512(std::forward<ChecksumSHA512T>(value));
293 return *this;
294 }
296
298
301 inline const Aws::String& GetChecksumMD5() const { return m_checksumMD5; }
302 inline bool ChecksumMD5HasBeenSet() const { return m_checksumMD5HasBeenSet; }
303 template <typename ChecksumMD5T = Aws::String>
304 void SetChecksumMD5(ChecksumMD5T&& value) {
305 m_checksumMD5HasBeenSet = true;
306 m_checksumMD5 = std::forward<ChecksumMD5T>(value);
308 }
309 inline void SetChecksumMD5(const char* value) {
310 m_checksumMD5HasBeenSet = true;
311 m_checksumMD5.assign(value);
313 }
314 template <typename ChecksumMD5T = Aws::String>
316 SetChecksumMD5(std::forward<ChecksumMD5T>(value));
317 return *this;
318 }
320
322
325 inline const Aws::String& GetChecksumXXHASH64() const { return m_checksumXXHASH64; }
326 inline bool ChecksumXXHASH64HasBeenSet() const { return m_checksumXXHASH64HasBeenSet; }
327 template <typename ChecksumXXHASH64T = Aws::String>
328 void SetChecksumXXHASH64(ChecksumXXHASH64T&& value) {
329 m_checksumXXHASH64HasBeenSet = true;
330 m_checksumXXHASH64 = std::forward<ChecksumXXHASH64T>(value);
332 }
333 inline void SetChecksumXXHASH64(const char* value) {
334 m_checksumXXHASH64HasBeenSet = true;
335 m_checksumXXHASH64.assign(value);
337 }
338 template <typename ChecksumXXHASH64T = Aws::String>
340 SetChecksumXXHASH64(std::forward<ChecksumXXHASH64T>(value));
341 return *this;
342 }
344
346
349 inline const Aws::String& GetChecksumXXHASH3() const { return m_checksumXXHASH3; }
350 inline bool ChecksumXXHASH3HasBeenSet() const { return m_checksumXXHASH3HasBeenSet; }
351 template <typename ChecksumXXHASH3T = Aws::String>
352 void SetChecksumXXHASH3(ChecksumXXHASH3T&& value) {
353 m_checksumXXHASH3HasBeenSet = true;
354 m_checksumXXHASH3 = std::forward<ChecksumXXHASH3T>(value);
356 }
357 inline void SetChecksumXXHASH3(const char* value) {
358 m_checksumXXHASH3HasBeenSet = true;
359 m_checksumXXHASH3.assign(value);
361 }
362 template <typename ChecksumXXHASH3T = Aws::String>
364 SetChecksumXXHASH3(std::forward<ChecksumXXHASH3T>(value));
365 return *this;
366 }
368
370
373 inline const Aws::String& GetChecksumXXHASH128() const { return m_checksumXXHASH128; }
374 inline bool ChecksumXXHASH128HasBeenSet() const { return m_checksumXXHASH128HasBeenSet; }
375 template <typename ChecksumXXHASH128T = Aws::String>
376 void SetChecksumXXHASH128(ChecksumXXHASH128T&& value) {
377 m_checksumXXHASH128HasBeenSet = true;
378 m_checksumXXHASH128 = std::forward<ChecksumXXHASH128T>(value);
380 }
381 inline void SetChecksumXXHASH128(const char* value) {
382 m_checksumXXHASH128HasBeenSet = true;
383 m_checksumXXHASH128.assign(value);
385 }
386 template <typename ChecksumXXHASH128T = Aws::String>
388 SetChecksumXXHASH128(std::forward<ChecksumXXHASH128T>(value));
389 return *this;
390 }
392
394
397 inline const Aws::String& GetContentMD5() const { return m_contentMD5; }
398 inline bool ContentMD5HasBeenSet() const { return m_contentMD5HasBeenSet; }
399 template <typename ContentMD5T = Aws::String>
400 void SetContentMD5(ContentMD5T&& value) {
401 m_contentMD5HasBeenSet = true;
402 m_contentMD5 = std::forward<ContentMD5T>(value);
403 }
404 template <typename ContentMD5T = Aws::String>
406 SetContentMD5(std::forward<ContentMD5T>(value));
407 return *this;
408 }
410
412
413 inline RequestPayer GetRequestPayer() const { return m_requestPayer; }
414 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
415 inline void SetRequestPayer(RequestPayer value) {
416 m_requestPayerHasBeenSet = true;
417 m_requestPayer = value;
418 }
420 SetRequestPayer(value);
421 return *this;
422 }
424
426
430 inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; }
431 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
432 template <typename ExpectedBucketOwnerT = Aws::String>
433 void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) {
434 m_expectedBucketOwnerHasBeenSet = true;
435 m_expectedBucketOwner = std::forward<ExpectedBucketOwnerT>(value);
436 }
437 template <typename ExpectedBucketOwnerT = Aws::String>
439 SetExpectedBucketOwner(std::forward<ExpectedBucketOwnerT>(value));
440 return *this;
441 }
443
445
446 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
447 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
448 template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
449 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
450 m_customizedAccessLogTagHasBeenSet = true;
451 m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value);
452 }
453 template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
454 PutObjectAnnotationRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
455 SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value));
456 return *this;
457 }
458 template <typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
459 PutObjectAnnotationRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
460 m_customizedAccessLogTagHasBeenSet = true;
461 m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value));
462 return *this;
463 }
465 private:
466 Aws::String m_bucket;
467
468 Aws::String m_key;
469
470 Aws::String m_versionId;
471
472 Aws::String m_annotationName;
473
474 Aws::String m_objectIfMatch;
475
477
478 Aws::String m_checksumCRC32;
479
480 Aws::String m_checksumCRC32C;
481
482 Aws::String m_checksumCRC64NVME;
483
484 Aws::String m_checksumSHA1;
485
486 Aws::String m_checksumSHA256;
487
488 Aws::String m_checksumSHA512;
489
490 Aws::String m_checksumMD5;
491
492 Aws::String m_checksumXXHASH64;
493
494 Aws::String m_checksumXXHASH3;
495
496 Aws::String m_checksumXXHASH128;
497
498 Aws::String m_contentMD5;
499
500 RequestPayer m_requestPayer{RequestPayer::NOT_SET};
501
502 Aws::String m_expectedBucketOwner;
503
504 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
505 bool m_bucketHasBeenSet = false;
506 bool m_keyHasBeenSet = false;
507 bool m_versionIdHasBeenSet = false;
508 bool m_annotationNameHasBeenSet = false;
509 bool m_objectIfMatchHasBeenSet = false;
510 bool m_checksumAlgorithmHasBeenSet = false;
511 bool m_checksumCRC32HasBeenSet = false;
512 bool m_checksumCRC32CHasBeenSet = false;
513 bool m_checksumCRC64NVMEHasBeenSet = false;
514 bool m_checksumSHA1HasBeenSet = false;
515 bool m_checksumSHA256HasBeenSet = false;
516 bool m_checksumSHA512HasBeenSet = false;
517 bool m_checksumMD5HasBeenSet = false;
518 bool m_checksumXXHASH64HasBeenSet = false;
519 bool m_checksumXXHASH3HasBeenSet = false;
520 bool m_checksumXXHASH128HasBeenSet = false;
521 bool m_contentMD5HasBeenSet = false;
522 bool m_requestPayerHasBeenSet = false;
523 bool m_expectedBucketOwnerHasBeenSet = false;
524 bool m_customizedAccessLogTagHasBeenSet = false;
525};
526
527} // namespace Model
528} // namespace S3Crt
529} // 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
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