AWS SDK for C++

AWS SDK for C++ Version 1.11.717

Loading...
Searching...
No Matches
DeleteObjectsRequest.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSMap.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/s3-crt/S3CrtRequest.h>
10#include <aws/s3-crt/S3Crt_EXPORTS.h>
11#include <aws/s3-crt/model/ChecksumAlgorithm.h>
12#include <aws/s3-crt/model/Delete.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 DeleteObjectsRequest() = 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 "DeleteObjects"; }
35
36 AWS_S3CRT_API Aws::String SerializePayload() const override;
37
38 AWS_S3CRT_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
39
41
42 AWS_S3CRT_API bool HasEmbeddedError(IOStream& body, const Http::HeaderValueCollection& header) const override;
43 AWS_S3CRT_API Aws::String GetChecksumAlgorithmName() const override;
44 inline bool RequestChecksumRequired() const override { return true; };
45
49 AWS_S3CRT_API EndpointParameters GetEndpointContextParams() const override;
50
52
87 inline const Aws::String& GetBucket() const { return m_bucket; }
88 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
89 template <typename BucketT = Aws::String>
90 void SetBucket(BucketT&& value) {
91 m_bucketHasBeenSet = true;
92 m_bucket = std::forward<BucketT>(value);
93 }
94 template <typename BucketT = Aws::String>
95 DeleteObjectsRequest& WithBucket(BucketT&& value) {
96 SetBucket(std::forward<BucketT>(value));
97 return *this;
98 }
100
102
105 inline const Delete& GetDelete() const { return m_delete; }
106 inline bool DeleteHasBeenSet() const { return m_deleteHasBeenSet; }
107 template <typename DeleteT = Delete>
108 void SetDelete(DeleteT&& value) {
109 m_deleteHasBeenSet = true;
110 m_delete = std::forward<DeleteT>(value);
111 }
112 template <typename DeleteT = Delete>
114 SetDelete(std::forward<DeleteT>(value));
115 return *this;
116 }
118
120
135 inline const Aws::String& GetMFA() const { return m_mFA; }
136 inline bool MFAHasBeenSet() const { return m_mFAHasBeenSet; }
137 template <typename MFAT = Aws::String>
138 void SetMFA(MFAT&& value) {
139 m_mFAHasBeenSet = true;
140 m_mFA = std::forward<MFAT>(value);
141 }
142 template <typename MFAT = Aws::String>
144 SetMFA(std::forward<MFAT>(value));
145 return *this;
146 }
148
150
151 inline RequestPayer GetRequestPayer() const { return m_requestPayer; }
152 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
153 inline void SetRequestPayer(RequestPayer value) {
154 m_requestPayerHasBeenSet = true;
155 m_requestPayer = value;
156 }
158 SetRequestPayer(value);
159 return *this;
160 }
162
164
170 inline bool GetBypassGovernanceRetention() const { return m_bypassGovernanceRetention; }
171 inline bool BypassGovernanceRetentionHasBeenSet() const { return m_bypassGovernanceRetentionHasBeenSet; }
172 inline void SetBypassGovernanceRetention(bool value) {
173 m_bypassGovernanceRetentionHasBeenSet = true;
174 m_bypassGovernanceRetention = value;
175 }
178 return *this;
179 }
181
183
188 inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; }
189 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
190 template <typename ExpectedBucketOwnerT = Aws::String>
191 void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) {
192 m_expectedBucketOwnerHasBeenSet = true;
193 m_expectedBucketOwner = std::forward<ExpectedBucketOwnerT>(value);
194 }
195 template <typename ExpectedBucketOwnerT = Aws::String>
196 DeleteObjectsRequest& WithExpectedBucketOwner(ExpectedBucketOwnerT&& value) {
197 SetExpectedBucketOwner(std::forward<ExpectedBucketOwnerT>(value));
198 return *this;
199 }
201
203
225 inline ChecksumAlgorithm GetChecksumAlgorithm() const { return m_checksumAlgorithm; }
226 inline bool ChecksumAlgorithmHasBeenSet() const { return m_checksumAlgorithmHasBeenSet; }
228 m_checksumAlgorithmHasBeenSet = true;
229 m_checksumAlgorithm = value;
230 }
233 return *this;
234 }
236
238
239 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
240 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
241 template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
242 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
243 m_customizedAccessLogTagHasBeenSet = true;
244 m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value);
245 }
246 template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
247 DeleteObjectsRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
248 SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value));
249 return *this;
250 }
251 template <typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
252 DeleteObjectsRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
253 m_customizedAccessLogTagHasBeenSet = true;
254 m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value));
255 return *this;
256 }
258 private:
259 Aws::String m_bucket;
260
261 Delete m_delete;
262
263 Aws::String m_mFA;
264
265 RequestPayer m_requestPayer{RequestPayer::NOT_SET};
266
267 bool m_bypassGovernanceRetention{false};
268
269 Aws::String m_expectedBucketOwner;
270
272
273 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
274 bool m_bucketHasBeenSet = false;
275 bool m_deleteHasBeenSet = false;
276 bool m_mFAHasBeenSet = false;
277 bool m_requestPayerHasBeenSet = false;
278 bool m_bypassGovernanceRetentionHasBeenSet = false;
279 bool m_expectedBucketOwnerHasBeenSet = false;
280 bool m_checksumAlgorithmHasBeenSet = false;
281 bool m_customizedAccessLogTagHasBeenSet = false;
282};
283
284} // namespace Model
285} // namespace S3Crt
286} // namespace Aws
DeleteObjectsRequest & WithChecksumAlgorithm(ChecksumAlgorithm value)
DeleteObjectsRequest & WithExpectedBucketOwner(ExpectedBucketOwnerT &&value)
DeleteObjectsRequest & WithDelete(DeleteT &&value)
void SetChecksumAlgorithm(ChecksumAlgorithm value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
void SetExpectedBucketOwner(ExpectedBucketOwnerT &&value)
AWS_S3CRT_API EndpointParameters GetEndpointContextParams() const override
void SetCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
AWS_S3CRT_API DeleteObjectsRequest()=default
const Aws::String & GetExpectedBucketOwner() const
DeleteObjectsRequest & WithRequestPayer(RequestPayer value)
AWS_S3CRT_API Aws::String GetChecksumAlgorithmName() const override
DeleteObjectsRequest & WithBucket(BucketT &&value)
AWS_S3CRT_API Aws::String SerializePayload() const override
AWS_S3CRT_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
DeleteObjectsRequest & AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT &&key, CustomizedAccessLogTagValueT &&value)
AWS_S3CRT_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
virtual const char * GetServiceRequestName() const override
DeleteObjectsRequest & WithCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
DeleteObjectsRequest & WithBypassGovernanceRetention(bool value)
DeleteObjectsRequest & WithMFA(MFAT &&value)
AWS_S3CRT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::Endpoint::EndpointParameters EndpointParameters
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