AWS SDK for C++

AWS SDK for C++ Version 1.11.606

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:
32 AWS_S3_API DeleteObjectsRequest() = default;
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 inline bool RequestChecksumRequired() const override { return true; };
49
53 AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
54
56
91 inline const Aws::String& GetBucket() const { return m_bucket; }
92 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
93 template<typename BucketT = Aws::String>
94 void SetBucket(BucketT&& value) { m_bucketHasBeenSet = true; m_bucket = std::forward<BucketT>(value); }
95 template<typename BucketT = Aws::String>
96 DeleteObjectsRequest& WithBucket(BucketT&& value) { SetBucket(std::forward<BucketT>(value)); return *this;}
98
100
103 inline const Delete& GetDelete() const { return m_delete; }
104 inline bool DeleteHasBeenSet() const { return m_deleteHasBeenSet; }
105 template<typename DeleteT = Delete>
106 void SetDelete(DeleteT&& value) { m_deleteHasBeenSet = true; m_delete = std::forward<DeleteT>(value); }
107 template<typename DeleteT = Delete>
108 DeleteObjectsRequest& WithDelete(DeleteT&& value) { SetDelete(std::forward<DeleteT>(value)); return *this;}
110
112
127 inline const Aws::String& GetMFA() const { return m_mFA; }
128 inline bool MFAHasBeenSet() const { return m_mFAHasBeenSet; }
129 template<typename MFAT = Aws::String>
130 void SetMFA(MFAT&& value) { m_mFAHasBeenSet = true; m_mFA = std::forward<MFAT>(value); }
131 template<typename MFAT = Aws::String>
132 DeleteObjectsRequest& WithMFA(MFAT&& value) { SetMFA(std::forward<MFAT>(value)); return *this;}
134
136
137 inline RequestPayer GetRequestPayer() const { return m_requestPayer; }
138 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
139 inline void SetRequestPayer(RequestPayer value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
142
144
150 inline bool GetBypassGovernanceRetention() const { return m_bypassGovernanceRetention; }
151 inline bool BypassGovernanceRetentionHasBeenSet() const { return m_bypassGovernanceRetentionHasBeenSet; }
152 inline void SetBypassGovernanceRetention(bool value) { m_bypassGovernanceRetentionHasBeenSet = true; m_bypassGovernanceRetention = value; }
155
157
162 inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; }
163 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
164 template<typename ExpectedBucketOwnerT = Aws::String>
165 void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::forward<ExpectedBucketOwnerT>(value); }
166 template<typename ExpectedBucketOwnerT = Aws::String>
167 DeleteObjectsRequest& WithExpectedBucketOwner(ExpectedBucketOwnerT&& value) { SetExpectedBucketOwner(std::forward<ExpectedBucketOwnerT>(value)); return *this;}
169
171
193 inline ChecksumAlgorithm GetChecksumAlgorithm() const { return m_checksumAlgorithm; }
194 inline bool ChecksumAlgorithmHasBeenSet() const { return m_checksumAlgorithmHasBeenSet; }
195 inline void SetChecksumAlgorithm(ChecksumAlgorithm value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = value; }
198
200
201 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
202 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
203 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
204 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value); }
205 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
206 DeleteObjectsRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value)); return *this;}
207 template<typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
208 DeleteObjectsRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
209 m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value)); return *this;
210 }
212 private:
213
214 Aws::String m_bucket;
215 bool m_bucketHasBeenSet = false;
216
217 Delete m_delete;
218 bool m_deleteHasBeenSet = false;
219
220 Aws::String m_mFA;
221 bool m_mFAHasBeenSet = false;
222
223 RequestPayer m_requestPayer{RequestPayer::NOT_SET};
224 bool m_requestPayerHasBeenSet = false;
225
226 bool m_bypassGovernanceRetention{false};
227 bool m_bypassGovernanceRetentionHasBeenSet = false;
228
229 Aws::String m_expectedBucketOwner;
230 bool m_expectedBucketOwnerHasBeenSet = false;
231
233 bool m_checksumAlgorithmHasBeenSet = false;
234
235 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
236 bool m_customizedAccessLogTagHasBeenSet = false;
237 };
238
239} // namespace Model
240} // namespace S3
241} // namespace Aws
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
DeleteObjectsRequest & WithDelete(DeleteT &&value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
void SetCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
DeleteObjectsRequest & WithMFA(MFAT &&value)
DeleteObjectsRequest & WithCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
void SetExpectedBucketOwner(ExpectedBucketOwnerT &&value)
DeleteObjectsRequest & WithExpectedBucketOwner(ExpectedBucketOwnerT &&value)
ChecksumAlgorithm GetChecksumAlgorithm() const
virtual const char * GetServiceRequestName() const override
const Aws::String & GetBucket() const
AWS_S3_API Aws::String GetChecksumAlgorithmName() const override
DeleteObjectsRequest & WithRequestPayer(RequestPayer value)
DeleteObjectsRequest & WithBucket(BucketT &&value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
AWS_S3_API Aws::String SerializePayload() const override
DeleteObjectsRequest & AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT &&key, CustomizedAccessLogTagValueT &&value)
DeleteObjectsRequest & WithBypassGovernanceRetention(bool value)
DeleteObjectsRequest & WithChecksumAlgorithm(ChecksumAlgorithm value)
AWS_S3_API DeleteObjectsRequest()=default
const Aws::String & GetExpectedBucketOwner() const
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
void SetChecksumAlgorithm(ChecksumAlgorithm 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