AWS SDK for C++

AWS SDK for C++ Version 1.11.695

Loading...
Searching...
No Matches
GetObjectAttributesRequest.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/core/utils/memory/stl/AWSVector.h>
10#include <aws/s3/S3Request.h>
11#include <aws/s3/S3_EXPORTS.h>
12#include <aws/s3/model/ObjectAttributes.h>
13#include <aws/s3/model/RequestPayer.h>
14
15#include <utility>
16
17namespace Aws {
18namespace Http {
19class URI;
20} // namespace Http
21namespace S3 {
22namespace Model {
23
27 public:
28 AWS_S3_API GetObjectAttributesRequest() = 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 "GetObjectAttributes"; }
35
36 AWS_S3_API Aws::String SerializePayload() const override;
37
38 AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
39
41
42 AWS_S3_API bool HasEmbeddedError(IOStream& body, const Http::HeaderValueCollection& header) const override;
46 AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
47
49
84 inline const Aws::String& GetBucket() const { return m_bucket; }
85 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
86 template <typename BucketT = Aws::String>
87 void SetBucket(BucketT&& value) {
88 m_bucketHasBeenSet = true;
89 m_bucket = std::forward<BucketT>(value);
90 }
91 template <typename BucketT = Aws::String>
93 SetBucket(std::forward<BucketT>(value));
94 return *this;
95 }
97
99
102 inline const Aws::String& GetKey() const { return m_key; }
103 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
104 template <typename KeyT = Aws::String>
105 void SetKey(KeyT&& value) {
106 m_keyHasBeenSet = true;
107 m_key = std::forward<KeyT>(value);
108 }
109 template <typename KeyT = Aws::String>
111 SetKey(std::forward<KeyT>(value));
112 return *this;
113 }
115
117
124 inline const Aws::String& GetVersionId() const { return m_versionId; }
125 inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
126 template <typename VersionIdT = Aws::String>
127 void SetVersionId(VersionIdT&& value) {
128 m_versionIdHasBeenSet = true;
129 m_versionId = std::forward<VersionIdT>(value);
130 }
131 template <typename VersionIdT = Aws::String>
133 SetVersionId(std::forward<VersionIdT>(value));
134 return *this;
135 }
137
139
145 inline int GetMaxParts() const { return m_maxParts; }
146 inline bool MaxPartsHasBeenSet() const { return m_maxPartsHasBeenSet; }
147 inline void SetMaxParts(int value) {
148 m_maxPartsHasBeenSet = true;
149 m_maxParts = value;
150 }
152 SetMaxParts(value);
153 return *this;
154 }
156
158
165 inline int GetPartNumberMarker() const { return m_partNumberMarker; }
166 inline bool PartNumberMarkerHasBeenSet() const { return m_partNumberMarkerHasBeenSet; }
167 inline void SetPartNumberMarker(int value) {
168 m_partNumberMarkerHasBeenSet = true;
169 m_partNumberMarker = value;
170 }
172 SetPartNumberMarker(value);
173 return *this;
174 }
176
178
183 inline const Aws::String& GetSSECustomerAlgorithm() const { return m_sSECustomerAlgorithm; }
184 inline bool SSECustomerAlgorithmHasBeenSet() const { return m_sSECustomerAlgorithmHasBeenSet; }
185 template <typename SSECustomerAlgorithmT = Aws::String>
186 void SetSSECustomerAlgorithm(SSECustomerAlgorithmT&& value) {
187 m_sSECustomerAlgorithmHasBeenSet = true;
188 m_sSECustomerAlgorithm = std::forward<SSECustomerAlgorithmT>(value);
189 }
190 template <typename SSECustomerAlgorithmT = Aws::String>
191 GetObjectAttributesRequest& WithSSECustomerAlgorithm(SSECustomerAlgorithmT&& value) {
192 SetSSECustomerAlgorithm(std::forward<SSECustomerAlgorithmT>(value));
193 return *this;
194 }
196
198
206 inline const Aws::String& GetSSECustomerKey() const { return m_sSECustomerKey; }
207 inline bool SSECustomerKeyHasBeenSet() const { return m_sSECustomerKeyHasBeenSet; }
208 template <typename SSECustomerKeyT = Aws::String>
209 void SetSSECustomerKey(SSECustomerKeyT&& value) {
210 m_sSECustomerKeyHasBeenSet = true;
211 m_sSECustomerKey = std::forward<SSECustomerKeyT>(value);
212 }
213 template <typename SSECustomerKeyT = Aws::String>
215 SetSSECustomerKey(std::forward<SSECustomerKeyT>(value));
216 return *this;
217 }
219
221
227 inline const Aws::String& GetSSECustomerKeyMD5() const { return m_sSECustomerKeyMD5; }
228 inline bool SSECustomerKeyMD5HasBeenSet() const { return m_sSECustomerKeyMD5HasBeenSet; }
229 template <typename SSECustomerKeyMD5T = Aws::String>
230 void SetSSECustomerKeyMD5(SSECustomerKeyMD5T&& value) {
231 m_sSECustomerKeyMD5HasBeenSet = true;
232 m_sSECustomerKeyMD5 = std::forward<SSECustomerKeyMD5T>(value);
233 }
234 template <typename SSECustomerKeyMD5T = Aws::String>
236 SetSSECustomerKeyMD5(std::forward<SSECustomerKeyMD5T>(value));
237 return *this;
238 }
240
242
243 inline RequestPayer GetRequestPayer() const { return m_requestPayer; }
244 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
245 inline void SetRequestPayer(RequestPayer value) {
246 m_requestPayerHasBeenSet = true;
247 m_requestPayer = value;
248 }
250 SetRequestPayer(value);
251 return *this;
252 }
254
256
261 inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; }
262 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
263 template <typename ExpectedBucketOwnerT = Aws::String>
264 void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) {
265 m_expectedBucketOwnerHasBeenSet = true;
266 m_expectedBucketOwner = std::forward<ExpectedBucketOwnerT>(value);
267 }
268 template <typename ExpectedBucketOwnerT = Aws::String>
270 SetExpectedBucketOwner(std::forward<ExpectedBucketOwnerT>(value));
271 return *this;
272 }
274
276
280 inline const Aws::Vector<ObjectAttributes>& GetObjectAttributes() const { return m_objectAttributes; }
281 inline bool ObjectAttributesHasBeenSet() const { return m_objectAttributesHasBeenSet; }
282 template <typename ObjectAttributesT = Aws::Vector<ObjectAttributes>>
283 void SetObjectAttributes(ObjectAttributesT&& value) {
284 m_objectAttributesHasBeenSet = true;
285 m_objectAttributes = std::forward<ObjectAttributesT>(value);
286 }
287 template <typename ObjectAttributesT = Aws::Vector<ObjectAttributes>>
289 SetObjectAttributes(std::forward<ObjectAttributesT>(value));
290 return *this;
291 }
293 m_objectAttributesHasBeenSet = true;
294 m_objectAttributes.push_back(value);
295 return *this;
296 }
298
300
301 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
302 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
303 template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
304 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
305 m_customizedAccessLogTagHasBeenSet = true;
306 m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value);
307 }
308 template <typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
309 GetObjectAttributesRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) {
310 SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value));
311 return *this;
312 }
313 template <typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
314 GetObjectAttributesRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
315 m_customizedAccessLogTagHasBeenSet = true;
316 m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value));
317 return *this;
318 }
320 private:
321 Aws::String m_bucket;
322 bool m_bucketHasBeenSet = false;
323
324 Aws::String m_key;
325 bool m_keyHasBeenSet = false;
326
327 Aws::String m_versionId;
328 bool m_versionIdHasBeenSet = false;
329
330 int m_maxParts{0};
331 bool m_maxPartsHasBeenSet = false;
332
333 int m_partNumberMarker{0};
334 bool m_partNumberMarkerHasBeenSet = false;
335
336 Aws::String m_sSECustomerAlgorithm;
337 bool m_sSECustomerAlgorithmHasBeenSet = false;
338
339 Aws::String m_sSECustomerKey;
340 bool m_sSECustomerKeyHasBeenSet = false;
341
342 Aws::String m_sSECustomerKeyMD5;
343 bool m_sSECustomerKeyMD5HasBeenSet = false;
344
345 RequestPayer m_requestPayer{RequestPayer::NOT_SET};
346 bool m_requestPayerHasBeenSet = false;
347
348 Aws::String m_expectedBucketOwner;
349 bool m_expectedBucketOwnerHasBeenSet = false;
350
351 Aws::Vector<ObjectAttributes> m_objectAttributes;
352 bool m_objectAttributesHasBeenSet = false;
353
354 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
355 bool m_customizedAccessLogTagHasBeenSet = false;
356};
357
358} // namespace Model
359} // namespace S3
360} // namespace Aws
GetObjectAttributesRequest & WithObjectAttributes(ObjectAttributesT &&value)
virtual const char * GetServiceRequestName() const override
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
GetObjectAttributesRequest & AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT &&key, CustomizedAccessLogTagValueT &&value)
const Aws::Vector< ObjectAttributes > & GetObjectAttributes() const
GetObjectAttributesRequest & WithBucket(BucketT &&value)
GetObjectAttributesRequest & AddObjectAttributes(ObjectAttributes value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
void SetExpectedBucketOwner(ExpectedBucketOwnerT &&value)
GetObjectAttributesRequest & WithSSECustomerKey(SSECustomerKeyT &&value)
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
GetObjectAttributesRequest & WithSSECustomerAlgorithm(SSECustomerAlgorithmT &&value)
GetObjectAttributesRequest & WithExpectedBucketOwner(ExpectedBucketOwnerT &&value)
GetObjectAttributesRequest & WithKey(KeyT &&value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
GetObjectAttributesRequest & WithMaxParts(int value)
AWS_S3_API Aws::String SerializePayload() const override
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
GetObjectAttributesRequest & WithRequestPayer(RequestPayer value)
void SetSSECustomerKeyMD5(SSECustomerKeyMD5T &&value)
GetObjectAttributesRequest & WithSSECustomerKeyMD5(SSECustomerKeyMD5T &&value)
GetObjectAttributesRequest & WithCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
AWS_S3_API GetObjectAttributesRequest()=default
void SetCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
GetObjectAttributesRequest & WithVersionId(VersionIdT &&value)
void SetSSECustomerAlgorithm(SSECustomerAlgorithmT &&value)
GetObjectAttributesRequest & WithPartNumberMarker(int value)
Aws::Endpoint::EndpointParameters EndpointParameters
Definition S3Request.h:19
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
std::vector< T, Aws::Allocator< T > > Vector