AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
DeleteObjectsRequest.h
1
6#pragma once
7#include <aws/s3/S3_EXPORTS.h>
8#include <aws/s3/S3Request.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/s3/model/Delete.h>
11#include <aws/s3/model/RequestPayer.h>
12#include <aws/s3/model/ChecksumAlgorithm.h>
13#include <aws/core/utils/memory/stl/AWSMap.h>
14#include <utility>
15
16namespace Aws
17{
18namespace Http
19{
20 class URI;
21} //namespace Http
22namespace S3
23{
24namespace Model
25{
26
30 {
31 public:
33
34 // Service request name is the Operation name which will send this request out,
35 // each operation should has unique request name, so that we can get operation's name from this request.
36 // Note: this is not true for response, multiple operations may have the same response name,
37 // so we can not get operation's name from response.
38 inline virtual const char* GetServiceRequestName() const override { return "DeleteObjects"; }
39
40 AWS_S3_API Aws::String SerializePayload() const override;
41
42 AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
43
45
46 AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override;
47 AWS_S3_API Aws::String GetChecksumAlgorithmName() const override;
48
52 AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
53
55
88 inline const Aws::String& GetBucket() const{ return m_bucket; }
89 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
90 inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
91 inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
92 inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
93 inline DeleteObjectsRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
94 inline DeleteObjectsRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
95 inline DeleteObjectsRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
97
99
102 inline const Delete& GetDelete() const{ return m_delete; }
103 inline bool DeleteHasBeenSet() const { return m_deleteHasBeenSet; }
104 inline void SetDelete(const Delete& value) { m_deleteHasBeenSet = true; m_delete = value; }
105 inline void SetDelete(Delete&& value) { m_deleteHasBeenSet = true; m_delete = std::move(value); }
106 inline DeleteObjectsRequest& WithDelete(const Delete& value) { SetDelete(value); return *this;}
107 inline DeleteObjectsRequest& WithDelete(Delete&& value) { SetDelete(std::move(value)); return *this;}
109
111
126 inline const Aws::String& GetMFA() const{ return m_mFA; }
127 inline bool MFAHasBeenSet() const { return m_mFAHasBeenSet; }
128 inline void SetMFA(const Aws::String& value) { m_mFAHasBeenSet = true; m_mFA = value; }
129 inline void SetMFA(Aws::String&& value) { m_mFAHasBeenSet = true; m_mFA = std::move(value); }
130 inline void SetMFA(const char* value) { m_mFAHasBeenSet = true; m_mFA.assign(value); }
131 inline DeleteObjectsRequest& WithMFA(const Aws::String& value) { SetMFA(value); return *this;}
132 inline DeleteObjectsRequest& WithMFA(Aws::String&& value) { SetMFA(std::move(value)); return *this;}
133 inline DeleteObjectsRequest& WithMFA(const char* value) { SetMFA(value); return *this;}
135
137
138 inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
139 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
140 inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
141 inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
142 inline DeleteObjectsRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
143 inline DeleteObjectsRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
145
147
153 inline bool GetBypassGovernanceRetention() const{ return m_bypassGovernanceRetention; }
154 inline bool BypassGovernanceRetentionHasBeenSet() const { return m_bypassGovernanceRetentionHasBeenSet; }
155 inline void SetBypassGovernanceRetention(bool value) { m_bypassGovernanceRetentionHasBeenSet = true; m_bypassGovernanceRetention = value; }
158
160
165 inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
166 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
167 inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
168 inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
169 inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
171 inline DeleteObjectsRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
172 inline DeleteObjectsRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
174
176
199 inline const ChecksumAlgorithm& GetChecksumAlgorithm() const{ return m_checksumAlgorithm; }
200 inline bool ChecksumAlgorithmHasBeenSet() const { return m_checksumAlgorithmHasBeenSet; }
201 inline void SetChecksumAlgorithm(const ChecksumAlgorithm& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = value; }
202 inline void SetChecksumAlgorithm(ChecksumAlgorithm&& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = std::move(value); }
204 inline DeleteObjectsRequest& WithChecksumAlgorithm(ChecksumAlgorithm&& value) { SetChecksumAlgorithm(std::move(value)); return *this;}
206
208
209 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
210 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
211 inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
212 inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
215 inline DeleteObjectsRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
216 inline DeleteObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
217 inline DeleteObjectsRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
218 inline DeleteObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
219 inline DeleteObjectsRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
220 inline DeleteObjectsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
221 inline DeleteObjectsRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
223 private:
224
225 Aws::String m_bucket;
226 bool m_bucketHasBeenSet = false;
227
228 Delete m_delete;
229 bool m_deleteHasBeenSet = false;
230
231 Aws::String m_mFA;
232 bool m_mFAHasBeenSet = false;
233
234 RequestPayer m_requestPayer;
235 bool m_requestPayerHasBeenSet = false;
236
237 bool m_bypassGovernanceRetention;
238 bool m_bypassGovernanceRetentionHasBeenSet = false;
239
240 Aws::String m_expectedBucketOwner;
241 bool m_expectedBucketOwnerHasBeenSet = false;
242
243 ChecksumAlgorithm m_checksumAlgorithm;
244 bool m_checksumAlgorithmHasBeenSet = false;
245
246 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
247 bool m_customizedAccessLogTagHasBeenSet = false;
248 };
249
250} // namespace Model
251} // namespace S3
252} // namespace Aws
DeleteObjectsRequest & WithExpectedBucketOwner(const Aws::String &value)
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
DeleteObjectsRequest & WithBucket(Aws::String &&value)
void SetExpectedBucketOwner(const Aws::String &value)
void SetBucket(const Aws::String &value)
DeleteObjectsRequest & WithExpectedBucketOwner(const char *value)
const RequestPayer & GetRequestPayer() const
DeleteObjectsRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
DeleteObjectsRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
DeleteObjectsRequest & WithChecksumAlgorithm(ChecksumAlgorithm &&value)
DeleteObjectsRequest & WithMFA(Aws::String &&value)
DeleteObjectsRequest & WithChecksumAlgorithm(const ChecksumAlgorithm &value)
DeleteObjectsRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
virtual const char * GetServiceRequestName() const override
const Aws::String & GetBucket() const
AWS_S3_API Aws::String GetChecksumAlgorithmName() const override
void SetRequestPayer(const RequestPayer &value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
DeleteObjectsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
DeleteObjectsRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
AWS_S3_API Aws::String SerializePayload() const override
DeleteObjectsRequest & WithExpectedBucketOwner(Aws::String &&value)
DeleteObjectsRequest & WithBucket(const Aws::String &value)
DeleteObjectsRequest & WithBypassGovernanceRetention(bool value)
const ChecksumAlgorithm & GetChecksumAlgorithm() const
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
DeleteObjectsRequest & WithMFA(const char *value)
void SetChecksumAlgorithm(const ChecksumAlgorithm &value)
DeleteObjectsRequest & WithBucket(const char *value)
DeleteObjectsRequest & WithDelete(const Delete &value)
DeleteObjectsRequest & WithRequestPayer(const RequestPayer &value)
const Aws::String & GetExpectedBucketOwner() const
void SetChecksumAlgorithm(ChecksumAlgorithm &&value)
DeleteObjectsRequest & WithDelete(Delete &&value)
void SetRequestPayer(RequestPayer &&value)
void SetMFA(const Aws::String &value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
DeleteObjectsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
DeleteObjectsRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
void SetExpectedBucketOwner(Aws::String &&value)
DeleteObjectsRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
DeleteObjectsRequest & WithRequestPayer(RequestPayer &&value)
DeleteObjectsRequest & WithMFA(const Aws::String &value)
DeleteObjectsRequest & 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