AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
PutObjectAclRequest.h
1
6#pragma once
7#include <aws/s3/S3_EXPORTS.h>
8#include <aws/s3/S3Request.h>
9#include <aws/s3/model/ObjectCannedACL.h>
10#include <aws/s3/model/AccessControlPolicy.h>
11#include <aws/core/utils/memory/stl/AWSString.h>
12#include <aws/s3/model/ChecksumAlgorithm.h>
13#include <aws/s3/model/RequestPayer.h>
14#include <aws/core/utils/memory/stl/AWSMap.h>
15#include <utility>
16
17namespace Aws
18{
19namespace Http
20{
21 class URI;
22} //namespace Http
23namespace S3
24{
25namespace Model
26{
27
31 {
32 public:
33 AWS_S3_API PutObjectAclRequest();
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 "PutObjectAcl"; }
40
41 AWS_S3_API Aws::String SerializePayload() const override;
42
43 AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
44
46
47 AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override;
48 AWS_S3_API Aws::String GetChecksumAlgorithmName() const override;
49
53 AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
54
56
61 inline const ObjectCannedACL& GetACL() const{ return m_aCL; }
62 inline bool ACLHasBeenSet() const { return m_aCLHasBeenSet; }
63 inline void SetACL(const ObjectCannedACL& value) { m_aCLHasBeenSet = true; m_aCL = value; }
64 inline void SetACL(ObjectCannedACL&& value) { m_aCLHasBeenSet = true; m_aCL = std::move(value); }
65 inline PutObjectAclRequest& WithACL(const ObjectCannedACL& value) { SetACL(value); return *this;}
66 inline PutObjectAclRequest& WithACL(ObjectCannedACL&& value) { SetACL(std::move(value)); return *this;}
68
70
74 inline const AccessControlPolicy& GetAccessControlPolicy() const{ return m_accessControlPolicy; }
75 inline bool AccessControlPolicyHasBeenSet() const { return m_accessControlPolicyHasBeenSet; }
76 inline void SetAccessControlPolicy(const AccessControlPolicy& value) { m_accessControlPolicyHasBeenSet = true; m_accessControlPolicy = value; }
77 inline void SetAccessControlPolicy(AccessControlPolicy&& value) { m_accessControlPolicyHasBeenSet = true; m_accessControlPolicy = std::move(value); }
81
83
105 inline const Aws::String& GetBucket() const{ return m_bucket; }
106 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
107 inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
108 inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
109 inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
110 inline PutObjectAclRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
111 inline PutObjectAclRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
112 inline PutObjectAclRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
114
116
124 inline const Aws::String& GetContentMD5() const{ return m_contentMD5; }
125 inline bool ContentMD5HasBeenSet() const { return m_contentMD5HasBeenSet; }
126 inline void SetContentMD5(const Aws::String& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = value; }
127 inline void SetContentMD5(Aws::String&& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = std::move(value); }
128 inline void SetContentMD5(const char* value) { m_contentMD5HasBeenSet = true; m_contentMD5.assign(value); }
129 inline PutObjectAclRequest& WithContentMD5(const Aws::String& value) { SetContentMD5(value); return *this;}
130 inline PutObjectAclRequest& WithContentMD5(Aws::String&& value) { SetContentMD5(std::move(value)); return *this;}
131 inline PutObjectAclRequest& WithContentMD5(const char* value) { SetContentMD5(value); return *this;}
133
135
147 inline const ChecksumAlgorithm& GetChecksumAlgorithm() const{ return m_checksumAlgorithm; }
148 inline bool ChecksumAlgorithmHasBeenSet() const { return m_checksumAlgorithmHasBeenSet; }
149 inline void SetChecksumAlgorithm(const ChecksumAlgorithm& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = value; }
150 inline void SetChecksumAlgorithm(ChecksumAlgorithm&& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = std::move(value); }
152 inline PutObjectAclRequest& WithChecksumAlgorithm(ChecksumAlgorithm&& value) { SetChecksumAlgorithm(std::move(value)); return *this;}
154
156
161 inline const Aws::String& GetGrantFullControl() const{ return m_grantFullControl; }
162 inline bool GrantFullControlHasBeenSet() const { return m_grantFullControlHasBeenSet; }
163 inline void SetGrantFullControl(const Aws::String& value) { m_grantFullControlHasBeenSet = true; m_grantFullControl = value; }
164 inline void SetGrantFullControl(Aws::String&& value) { m_grantFullControlHasBeenSet = true; m_grantFullControl = std::move(value); }
165 inline void SetGrantFullControl(const char* value) { m_grantFullControlHasBeenSet = true; m_grantFullControl.assign(value); }
166 inline PutObjectAclRequest& WithGrantFullControl(const Aws::String& value) { SetGrantFullControl(value); return *this;}
167 inline PutObjectAclRequest& WithGrantFullControl(Aws::String&& value) { SetGrantFullControl(std::move(value)); return *this;}
168 inline PutObjectAclRequest& WithGrantFullControl(const char* value) { SetGrantFullControl(value); return *this;}
170
172
176 inline const Aws::String& GetGrantRead() const{ return m_grantRead; }
177 inline bool GrantReadHasBeenSet() const { return m_grantReadHasBeenSet; }
178 inline void SetGrantRead(const Aws::String& value) { m_grantReadHasBeenSet = true; m_grantRead = value; }
179 inline void SetGrantRead(Aws::String&& value) { m_grantReadHasBeenSet = true; m_grantRead = std::move(value); }
180 inline void SetGrantRead(const char* value) { m_grantReadHasBeenSet = true; m_grantRead.assign(value); }
181 inline PutObjectAclRequest& WithGrantRead(const Aws::String& value) { SetGrantRead(value); return *this;}
182 inline PutObjectAclRequest& WithGrantRead(Aws::String&& value) { SetGrantRead(std::move(value)); return *this;}
183 inline PutObjectAclRequest& WithGrantRead(const char* value) { SetGrantRead(value); return *this;}
185
187
191 inline const Aws::String& GetGrantReadACP() const{ return m_grantReadACP; }
192 inline bool GrantReadACPHasBeenSet() const { return m_grantReadACPHasBeenSet; }
193 inline void SetGrantReadACP(const Aws::String& value) { m_grantReadACPHasBeenSet = true; m_grantReadACP = value; }
194 inline void SetGrantReadACP(Aws::String&& value) { m_grantReadACPHasBeenSet = true; m_grantReadACP = std::move(value); }
195 inline void SetGrantReadACP(const char* value) { m_grantReadACPHasBeenSet = true; m_grantReadACP.assign(value); }
196 inline PutObjectAclRequest& WithGrantReadACP(const Aws::String& value) { SetGrantReadACP(value); return *this;}
197 inline PutObjectAclRequest& WithGrantReadACP(Aws::String&& value) { SetGrantReadACP(std::move(value)); return *this;}
198 inline PutObjectAclRequest& WithGrantReadACP(const char* value) { SetGrantReadACP(value); return *this;}
200
202
207 inline const Aws::String& GetGrantWrite() const{ return m_grantWrite; }
208 inline bool GrantWriteHasBeenSet() const { return m_grantWriteHasBeenSet; }
209 inline void SetGrantWrite(const Aws::String& value) { m_grantWriteHasBeenSet = true; m_grantWrite = value; }
210 inline void SetGrantWrite(Aws::String&& value) { m_grantWriteHasBeenSet = true; m_grantWrite = std::move(value); }
211 inline void SetGrantWrite(const char* value) { m_grantWriteHasBeenSet = true; m_grantWrite.assign(value); }
212 inline PutObjectAclRequest& WithGrantWrite(const Aws::String& value) { SetGrantWrite(value); return *this;}
213 inline PutObjectAclRequest& WithGrantWrite(Aws::String&& value) { SetGrantWrite(std::move(value)); return *this;}
214 inline PutObjectAclRequest& WithGrantWrite(const char* value) { SetGrantWrite(value); return *this;}
216
218
222 inline const Aws::String& GetGrantWriteACP() const{ return m_grantWriteACP; }
223 inline bool GrantWriteACPHasBeenSet() const { return m_grantWriteACPHasBeenSet; }
224 inline void SetGrantWriteACP(const Aws::String& value) { m_grantWriteACPHasBeenSet = true; m_grantWriteACP = value; }
225 inline void SetGrantWriteACP(Aws::String&& value) { m_grantWriteACPHasBeenSet = true; m_grantWriteACP = std::move(value); }
226 inline void SetGrantWriteACP(const char* value) { m_grantWriteACPHasBeenSet = true; m_grantWriteACP.assign(value); }
227 inline PutObjectAclRequest& WithGrantWriteACP(const Aws::String& value) { SetGrantWriteACP(value); return *this;}
228 inline PutObjectAclRequest& WithGrantWriteACP(Aws::String&& value) { SetGrantWriteACP(std::move(value)); return *this;}
229 inline PutObjectAclRequest& WithGrantWriteACP(const char* value) { SetGrantWriteACP(value); return *this;}
231
233
236 inline const Aws::String& GetKey() const{ return m_key; }
237 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
238 inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; }
239 inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); }
240 inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); }
241 inline PutObjectAclRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;}
242 inline PutObjectAclRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;}
243 inline PutObjectAclRequest& WithKey(const char* value) { SetKey(value); return *this;}
245
247
248 inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
249 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
250 inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
251 inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
252 inline PutObjectAclRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
253 inline PutObjectAclRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
255
257
261 inline const Aws::String& GetVersionId() const{ return m_versionId; }
262 inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
263 inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; }
264 inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); }
265 inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); }
266 inline PutObjectAclRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;}
267 inline PutObjectAclRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;}
268 inline PutObjectAclRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;}
270
272
277 inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
278 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
279 inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
280 inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
281 inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
283 inline PutObjectAclRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
284 inline PutObjectAclRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
286
288
289 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
290 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
291 inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
292 inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
295 inline PutObjectAclRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
296 inline PutObjectAclRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
297 inline PutObjectAclRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
298 inline PutObjectAclRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
299 inline PutObjectAclRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
300 inline PutObjectAclRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
301 inline PutObjectAclRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
303 private:
304
305 ObjectCannedACL m_aCL;
306 bool m_aCLHasBeenSet = false;
307
308 AccessControlPolicy m_accessControlPolicy;
309 bool m_accessControlPolicyHasBeenSet = false;
310
311 Aws::String m_bucket;
312 bool m_bucketHasBeenSet = false;
313
314 Aws::String m_contentMD5;
315 bool m_contentMD5HasBeenSet = false;
316
317 ChecksumAlgorithm m_checksumAlgorithm;
318 bool m_checksumAlgorithmHasBeenSet = false;
319
320 Aws::String m_grantFullControl;
321 bool m_grantFullControlHasBeenSet = false;
322
323 Aws::String m_grantRead;
324 bool m_grantReadHasBeenSet = false;
325
326 Aws::String m_grantReadACP;
327 bool m_grantReadACPHasBeenSet = false;
328
329 Aws::String m_grantWrite;
330 bool m_grantWriteHasBeenSet = false;
331
332 Aws::String m_grantWriteACP;
333 bool m_grantWriteACPHasBeenSet = false;
334
335 Aws::String m_key;
336 bool m_keyHasBeenSet = false;
337
338 RequestPayer m_requestPayer;
339 bool m_requestPayerHasBeenSet = false;
340
341 Aws::String m_versionId;
342 bool m_versionIdHasBeenSet = false;
343
344 Aws::String m_expectedBucketOwner;
345 bool m_expectedBucketOwnerHasBeenSet = false;
346
347 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
348 bool m_customizedAccessLogTagHasBeenSet = false;
349 };
350
351} // namespace Model
352} // namespace S3
353} // namespace Aws
PutObjectAclRequest & WithChecksumAlgorithm(const ChecksumAlgorithm &value)
const Aws::String & GetGrantWriteACP() const
PutObjectAclRequest & WithBucket(const Aws::String &value)
PutObjectAclRequest & WithContentMD5(const Aws::String &value)
const RequestPayer & GetRequestPayer() const
PutObjectAclRequest & WithChecksumAlgorithm(ChecksumAlgorithm &&value)
void SetACL(ObjectCannedACL &&value)
PutObjectAclRequest & WithAccessControlPolicy(AccessControlPolicy &&value)
PutObjectAclRequest & WithContentMD5(Aws::String &&value)
void SetChecksumAlgorithm(const ChecksumAlgorithm &value)
void SetContentMD5(const Aws::String &value)
void SetRequestPayer(const RequestPayer &value)
PutObjectAclRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
PutObjectAclRequest & WithKey(const char *value)
PutObjectAclRequest & WithGrantWrite(const Aws::String &value)
PutObjectAclRequest & WithGrantReadACP(const char *value)
PutObjectAclRequest & WithGrantFullControl(Aws::String &&value)
PutObjectAclRequest & WithKey(const Aws::String &value)
void SetVersionId(const Aws::String &value)
void SetGrantRead(const Aws::String &value)
PutObjectAclRequest & WithACL(const ObjectCannedACL &value)
const ObjectCannedACL & GetACL() const
PutObjectAclRequest & WithRequestPayer(RequestPayer &&value)
const Aws::String & GetGrantWrite() const
void SetAccessControlPolicy(const AccessControlPolicy &value)
PutObjectAclRequest & WithExpectedBucketOwner(const char *value)
PutObjectAclRequest & WithGrantWriteACP(const Aws::String &value)
void SetAccessControlPolicy(AccessControlPolicy &&value)
PutObjectAclRequest & WithGrantRead(const Aws::String &value)
void SetExpectedBucketOwner(Aws::String &&value)
PutObjectAclRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
PutObjectAclRequest & WithGrantWrite(Aws::String &&value)
PutObjectAclRequest & WithGrantWriteACP(const char *value)
void SetGrantWriteACP(Aws::String &&value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
const Aws::String & GetExpectedBucketOwner() const
PutObjectAclRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
PutObjectAclRequest & WithBucket(const char *value)
const Aws::String & GetGrantFullControl() const
void SetChecksumAlgorithm(ChecksumAlgorithm &&value)
PutObjectAclRequest & WithGrantReadACP(Aws::String &&value)
PutObjectAclRequest & WithAccessControlPolicy(const AccessControlPolicy &value)
PutObjectAclRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
void SetExpectedBucketOwner(const char *value)
void SetContentMD5(Aws::String &&value)
void SetKey(const Aws::String &value)
PutObjectAclRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
void SetGrantFullControl(const Aws::String &value)
const Aws::String & GetBucket() const
PutObjectAclRequest & WithGrantWriteACP(Aws::String &&value)
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
const ChecksumAlgorithm & GetChecksumAlgorithm() const
PutObjectAclRequest & WithVersionId(Aws::String &&value)
PutObjectAclRequest & WithExpectedBucketOwner(const Aws::String &value)
PutObjectAclRequest & WithKey(Aws::String &&value)
AWS_S3_API Aws::String GetChecksumAlgorithmName() const override
PutObjectAclRequest & WithRequestPayer(const RequestPayer &value)
PutObjectAclRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
const AccessControlPolicy & GetAccessControlPolicy() const
virtual const char * GetServiceRequestName() const override
void SetACL(const ObjectCannedACL &value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
PutObjectAclRequest & WithGrantRead(const char *value)
PutObjectAclRequest & WithExpectedBucketOwner(Aws::String &&value)
PutObjectAclRequest & WithGrantFullControl(const char *value)
PutObjectAclRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
void SetRequestPayer(RequestPayer &&value)
void SetGrantWriteACP(const Aws::String &value)
AWS_S3_API Aws::String SerializePayload() const override
void SetGrantReadACP(const Aws::String &value)
void SetExpectedBucketOwner(const Aws::String &value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
PutObjectAclRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
void SetGrantFullControl(const char *value)
PutObjectAclRequest & WithGrantWrite(const char *value)
void SetGrantFullControl(Aws::String &&value)
const Aws::String & GetVersionId() const
void SetBucket(const Aws::String &value)
PutObjectAclRequest & WithContentMD5(const char *value)
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
PutObjectAclRequest & WithVersionId(const char *value)
void SetGrantWrite(const Aws::String &value)
PutObjectAclRequest & WithGrantFullControl(const Aws::String &value)
PutObjectAclRequest & WithGrantReadACP(const Aws::String &value)
PutObjectAclRequest & WithACL(ObjectCannedACL &&value)
PutObjectAclRequest & WithGrantRead(Aws::String &&value)
const Aws::String & GetGrantReadACP() const
void SetGrantReadACP(Aws::String &&value)
void SetGrantWrite(Aws::String &&value)
PutObjectAclRequest & WithBucket(Aws::String &&value)
PutObjectAclRequest & WithVersionId(const Aws::String &value)
const Aws::String & GetGrantRead() const
const Aws::String & GetContentMD5() const
PutObjectAclRequest & AddCustomizedAccessLogTag(const char *key, const char *value)
Aws::Endpoint::EndpointParameters EndpointParameters
Definition S3Request.h:22
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