AWS SDK for C++  1.9.15
AWS SDK for C++
DeleteObjectsRequest.h
Go to the documentation of this file.
1 
6 #pragma once
7 #include <aws/s3/S3_EXPORTS.h>
8 #include <aws/s3/S3Request.h>
10 #include <aws/s3/model/Delete.h>
13 #include <utility>
14 
15 namespace Aws
16 {
17 namespace Http
18 {
19  class URI;
20 } //namespace Http
21 namespace S3
22 {
23 namespace Model
24 {
25 
29  {
30  public:
32 
33  // Service request name is the Operation name which will send this request out,
34  // each operation should has unique request name, so that we can get operation's name from this request.
35  // Note: this is not true for response, multiple operations may have the same response name,
36  // so we can not get operation's name from response.
37  inline virtual const char* GetServiceRequestName() const override { return "DeleteObjects"; }
38 
39  Aws::String SerializePayload() const override;
40 
41  void AddQueryStringParameters(Aws::Http::URI& uri) const override;
42 
44 
45  inline bool ShouldComputeContentMd5() const override { return true; }
46 
47 
67  inline const Aws::String& GetBucket() const{ return m_bucket; }
68 
88  inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
89 
109  inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
110 
130  inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
131 
151  inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
152 
172  inline DeleteObjectsRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
173 
193  inline DeleteObjectsRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
194 
214  inline DeleteObjectsRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
215 
216 
220  inline const Delete& GetDelete() const{ return m_delete; }
221 
225  inline bool DeleteHasBeenSet() const { return m_deleteHasBeenSet; }
226 
230  inline void SetDelete(const Delete& value) { m_deleteHasBeenSet = true; m_delete = value; }
231 
235  inline void SetDelete(Delete&& value) { m_deleteHasBeenSet = true; m_delete = std::move(value); }
236 
240  inline DeleteObjectsRequest& WithDelete(const Delete& value) { SetDelete(value); return *this;}
241 
245  inline DeleteObjectsRequest& WithDelete(Delete&& value) { SetDelete(std::move(value)); return *this;}
246 
247 
254  inline const Aws::String& GetMFA() const{ return m_mFA; }
255 
262  inline bool MFAHasBeenSet() const { return m_mFAHasBeenSet; }
263 
270  inline void SetMFA(const Aws::String& value) { m_mFAHasBeenSet = true; m_mFA = value; }
271 
278  inline void SetMFA(Aws::String&& value) { m_mFAHasBeenSet = true; m_mFA = std::move(value); }
279 
286  inline void SetMFA(const char* value) { m_mFAHasBeenSet = true; m_mFA.assign(value); }
287 
294  inline DeleteObjectsRequest& WithMFA(const Aws::String& value) { SetMFA(value); return *this;}
295 
302  inline DeleteObjectsRequest& WithMFA(Aws::String&& value) { SetMFA(std::move(value)); return *this;}
303 
310  inline DeleteObjectsRequest& WithMFA(const char* value) { SetMFA(value); return *this;}
311 
312 
313 
314  inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
315 
316 
317  inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
318 
319 
320  inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
321 
322 
323  inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
324 
325 
326  inline DeleteObjectsRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
327 
328 
329  inline DeleteObjectsRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
330 
331 
337  inline bool GetBypassGovernanceRetention() const{ return m_bypassGovernanceRetention; }
338 
344  inline bool BypassGovernanceRetentionHasBeenSet() const { return m_bypassGovernanceRetentionHasBeenSet; }
345 
351  inline void SetBypassGovernanceRetention(bool value) { m_bypassGovernanceRetentionHasBeenSet = true; m_bypassGovernanceRetention = value; }
352 
358  inline DeleteObjectsRequest& WithBypassGovernanceRetention(bool value) { SetBypassGovernanceRetention(value); return *this;}
359 
360 
366  inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
367 
373  inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
374 
380  inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
381 
387  inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
388 
394  inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
395 
401  inline DeleteObjectsRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;}
402 
408  inline DeleteObjectsRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
409 
415  inline DeleteObjectsRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
416 
417 
418 
419  inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
420 
421 
422  inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
423 
424 
425  inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
426 
427 
428  inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
429 
430 
431  inline DeleteObjectsRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;}
432 
433 
434  inline DeleteObjectsRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;}
435 
436 
437  inline DeleteObjectsRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
438 
439 
440  inline DeleteObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
441 
442 
443  inline DeleteObjectsRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
444 
445 
446  inline DeleteObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
447 
448 
449  inline DeleteObjectsRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
450 
451 
452  inline DeleteObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
453 
454 
455  inline DeleteObjectsRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
456 
457  private:
458 
459  Aws::String m_bucket;
460  bool m_bucketHasBeenSet;
461 
462  Delete m_delete;
463  bool m_deleteHasBeenSet;
464 
465  Aws::String m_mFA;
466  bool m_mFAHasBeenSet;
467 
468  RequestPayer m_requestPayer;
469  bool m_requestPayerHasBeenSet;
470 
471  bool m_bypassGovernanceRetention;
472  bool m_bypassGovernanceRetentionHasBeenSet;
473 
474  Aws::String m_expectedBucketOwner;
475  bool m_expectedBucketOwnerHasBeenSet;
476 
477  Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
478  bool m_customizedAccessLogTagHasBeenSet;
479  };
480 
481 } // namespace Model
482 } // namespace S3
483 } // namespace Aws
Aws::S3::Model::DeleteObjectsRequest::BucketHasBeenSet
bool BucketHasBeenSet() const
Definition: DeleteObjectsRequest.h:88
Aws::S3::Model::DeleteObjectsRequest::GetCustomizedAccessLogTag
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
Definition: DeleteObjectsRequest.h:419
Aws::S3::Model::DeleteObjectsRequest::WithDelete
DeleteObjectsRequest & WithDelete(const Delete &value)
Definition: DeleteObjectsRequest.h:240
Aws::S3::Model::DeleteObjectsRequest::ShouldComputeContentMd5
bool ShouldComputeContentMd5() const override
Definition: DeleteObjectsRequest.h:45
Aws::Http::URI
Definition: URI.h:32
Aws::S3::Model::DeleteObjectsRequest::SetExpectedBucketOwner
void SetExpectedBucketOwner(const char *value)
Definition: DeleteObjectsRequest.h:394
Aws::S3::Model::DeleteObjectsRequest
Definition: DeleteObjectsRequest.h:29
Aws::S3::Model::DeleteObjectsRequest::SetCustomizedAccessLogTag
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
Definition: DeleteObjectsRequest.h:428
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
S3Request.h
Aws::S3::Model::DeleteObjectsRequest::AddCustomizedAccessLogTag
DeleteObjectsRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
Definition: DeleteObjectsRequest.h:443
Aws::S3::Model::DeleteObjectsRequest::AddCustomizedAccessLogTag
DeleteObjectsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
Definition: DeleteObjectsRequest.h:452
Aws::S3::Model::DeleteObjectsRequest::AddCustomizedAccessLogTag
DeleteObjectsRequest & AddCustomizedAccessLogTag(const char *key, const char *value)
Definition: DeleteObjectsRequest.h:455
Aws::S3::Model::DeleteObjectsRequest::SetExpectedBucketOwner
void SetExpectedBucketOwner(Aws::String &&value)
Definition: DeleteObjectsRequest.h:387
Aws::S3::Model::DeleteObjectsRequest::WithMFA
DeleteObjectsRequest & WithMFA(const char *value)
Definition: DeleteObjectsRequest.h:310
Aws::S3::Model::DeleteObjectsRequest::SetRequestPayer
void SetRequestPayer(RequestPayer &&value)
Definition: DeleteObjectsRequest.h:323
Aws::S3::Model::DeleteObjectsRequest::WithDelete
DeleteObjectsRequest & WithDelete(Delete &&value)
Definition: DeleteObjectsRequest.h:245
Aws::S3::Model::DeleteObjectsRequest::SetBucket
void SetBucket(const char *value)
Definition: DeleteObjectsRequest.h:151
Aws::S3::Model::DeleteObjectsRequest::WithBucket
DeleteObjectsRequest & WithBucket(Aws::String &&value)
Definition: DeleteObjectsRequest.h:193
Aws::S3::Model::DeleteObjectsRequest::SetMFA
void SetMFA(const char *value)
Definition: DeleteObjectsRequest.h:286
Aws::S3::Model::DeleteObjectsRequest::BypassGovernanceRetentionHasBeenSet
bool BypassGovernanceRetentionHasBeenSet() const
Definition: DeleteObjectsRequest.h:344
S3_EXPORTS.h
AWS_S3_API
#define AWS_S3_API
Definition: S3_EXPORTS.h:28
Delete.h
Aws::S3::Model::DeleteObjectsRequest::AddCustomizedAccessLogTag
DeleteObjectsRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
Definition: DeleteObjectsRequest.h:446
Aws::S3::Model::DeleteObjectsRequest::WithBucket
DeleteObjectsRequest & WithBucket(const char *value)
Definition: DeleteObjectsRequest.h:214
Aws::S3::Model::RequestPayer
RequestPayer
Definition: RequestPayer.h:17
Aws::S3::S3Request
Definition: S3Request.h:18
Aws::S3::Model::DeleteObjectsRequest::RequestPayerHasBeenSet
bool RequestPayerHasBeenSet() const
Definition: DeleteObjectsRequest.h:317
Aws::S3::Model::DeleteObjectsRequest::SetBucket
void SetBucket(const Aws::String &value)
Definition: DeleteObjectsRequest.h:109
Aws::S3::Model::DeleteObjectsRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: DeleteObjectsRequest.h:37
Aws::S3::Model::DeleteObjectsRequest::WithBypassGovernanceRetention
DeleteObjectsRequest & WithBypassGovernanceRetention(bool value)
Definition: DeleteObjectsRequest.h:358
Aws::S3::Model::DeleteObjectsRequest::GetMFA
const Aws::String & GetMFA() const
Definition: DeleteObjectsRequest.h:254
Aws::S3::Model::DeleteObjectsRequest::GetBucket
const Aws::String & GetBucket() const
Definition: DeleteObjectsRequest.h:67
Aws::S3::Model::DeleteObjectsRequest::GetExpectedBucketOwner
const Aws::String & GetExpectedBucketOwner() const
Definition: DeleteObjectsRequest.h:366
Aws::S3::Model::DeleteObjectsRequest::WithRequestPayer
DeleteObjectsRequest & WithRequestPayer(const RequestPayer &value)
Definition: DeleteObjectsRequest.h:326
Aws::S3::Model::DeleteObjectsRequest::SetExpectedBucketOwner
void SetExpectedBucketOwner(const Aws::String &value)
Definition: DeleteObjectsRequest.h:380
Aws::S3::Model::DeleteObjectsRequest::GetBypassGovernanceRetention
bool GetBypassGovernanceRetention() const
Definition: DeleteObjectsRequest.h:337
Aws::S3::Model::DeleteObjectsRequest::WithCustomizedAccessLogTag
DeleteObjectsRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
Definition: DeleteObjectsRequest.h:431
Aws::S3::Model::DeleteObjectsRequest::SetBypassGovernanceRetention
void SetBypassGovernanceRetention(bool value)
Definition: DeleteObjectsRequest.h:351
Aws::S3::Model::DeleteObjectsRequest::SetDelete
void SetDelete(Delete &&value)
Definition: DeleteObjectsRequest.h:235
Aws::S3::Model::DeleteObjectsRequest::WithExpectedBucketOwner
DeleteObjectsRequest & WithExpectedBucketOwner(const Aws::String &value)
Definition: DeleteObjectsRequest.h:401
AWSString.h
Aws::S3::Model::DeleteObjectsRequest::AddCustomizedAccessLogTag
DeleteObjectsRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
Definition: DeleteObjectsRequest.h:449
Aws::S3::Model::DeleteObjectsRequest::DeleteHasBeenSet
bool DeleteHasBeenSet() const
Definition: DeleteObjectsRequest.h:225
Aws::S3::Model::DeleteObjectsRequest::GetRequestPayer
const RequestPayer & GetRequestPayer() const
Definition: DeleteObjectsRequest.h:314
Aws::S3::Model::DeleteObjectsRequest::AddCustomizedAccessLogTag
DeleteObjectsRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
Definition: DeleteObjectsRequest.h:437
Aws::S3::Model::DeleteObjectsRequest::AddQueryStringParameters
void AddQueryStringParameters(Aws::Http::URI &uri) const override
RequestPayer.h
Aws::S3::Model::DeleteObjectsRequest::GetDelete
const Delete & GetDelete() const
Definition: DeleteObjectsRequest.h:220
Aws::S3::Model::DeleteObjectsRequest::WithExpectedBucketOwner
DeleteObjectsRequest & WithExpectedBucketOwner(const char *value)
Definition: DeleteObjectsRequest.h:415
Aws::S3::Model::DeleteObjectsRequest::CustomizedAccessLogTagHasBeenSet
bool CustomizedAccessLogTagHasBeenSet() const
Definition: DeleteObjectsRequest.h:422
Aws::S3::Model::DeleteObjectsRequest::WithRequestPayer
DeleteObjectsRequest & WithRequestPayer(RequestPayer &&value)
Definition: DeleteObjectsRequest.h:329
Aws::S3::Model::DeleteObjectsRequest::DeleteObjectsRequest
DeleteObjectsRequest()
Aws::S3::Model::DeleteObjectsRequest::SetMFA
void SetMFA(const Aws::String &value)
Definition: DeleteObjectsRequest.h:270
Aws::S3::Model::DeleteObjectsRequest::SetRequestPayer
void SetRequestPayer(const RequestPayer &value)
Definition: DeleteObjectsRequest.h:320
Aws::S3::Model::Delete
Definition: Delete.h:32
Aws
Definition: AccessManagementClient.h:15
Aws::S3::Model::DeleteObjectsRequest::WithMFA
DeleteObjectsRequest & WithMFA(const Aws::String &value)
Definition: DeleteObjectsRequest.h:294
Aws::S3::Model::DeleteObjectsRequest::WithExpectedBucketOwner
DeleteObjectsRequest & WithExpectedBucketOwner(Aws::String &&value)
Definition: DeleteObjectsRequest.h:408
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::S3::Model::DeleteObjectsRequest::SetMFA
void SetMFA(Aws::String &&value)
Definition: DeleteObjectsRequest.h:278
Aws::S3::Model::DeleteObjectsRequest::MFAHasBeenSet
bool MFAHasBeenSet() const
Definition: DeleteObjectsRequest.h:262
Aws::S3::Model::DeleteObjectsRequest::WithBucket
DeleteObjectsRequest & WithBucket(const Aws::String &value)
Definition: DeleteObjectsRequest.h:172
Aws::S3::Model::DeleteObjectsRequest::WithCustomizedAccessLogTag
DeleteObjectsRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
Definition: DeleteObjectsRequest.h:434
Aws::S3::Model::DeleteObjectsRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::S3::Model::DeleteObjectsRequest::WithMFA
DeleteObjectsRequest & WithMFA(Aws::String &&value)
Definition: DeleteObjectsRequest.h:302
Aws::S3::Model::DeleteObjectsRequest::AddCustomizedAccessLogTag
DeleteObjectsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
Definition: DeleteObjectsRequest.h:440
Aws::S3::Model::DeleteObjectsRequest::SetCustomizedAccessLogTag
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
Definition: DeleteObjectsRequest.h:425
AWSMap.h
Aws::S3::Model::DeleteObjectsRequest::ExpectedBucketOwnerHasBeenSet
bool ExpectedBucketOwnerHasBeenSet() const
Definition: DeleteObjectsRequest.h:373
Aws::S3::ARNService::S3
static const char S3[]
Definition: S3ARN.h:25
Aws::S3::Model::DeleteObjectsRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::Map
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
Definition: AWSMap.h:19
Aws::S3::Model::DeleteObjectsRequest::SetBucket
void SetBucket(Aws::String &&value)
Definition: DeleteObjectsRequest.h:130
Aws::S3::Model::DeleteObjectsRequest::SetDelete
void SetDelete(const Delete &value)
Definition: DeleteObjectsRequest.h:230