AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
GetObjectAttributesRequest.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/RequestPayer.h>
11#include <aws/core/utils/memory/stl/AWSVector.h>
12#include <aws/core/utils/memory/stl/AWSMap.h>
13#include <aws/s3/model/ObjectAttributes.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 "GetObjectAttributes"; }
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;
50 AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
51
53
86 inline const Aws::String& GetBucket() const{ return m_bucket; }
87 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
88 inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
89 inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
90 inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
91 inline GetObjectAttributesRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
92 inline GetObjectAttributesRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
93 inline GetObjectAttributesRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
95
97
100 inline const Aws::String& GetKey() const{ return m_key; }
101 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
102 inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; }
103 inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); }
104 inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); }
105 inline GetObjectAttributesRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;}
106 inline GetObjectAttributesRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;}
107 inline GetObjectAttributesRequest& WithKey(const char* value) { SetKey(value); return *this;}
109
111
118 inline const Aws::String& GetVersionId() const{ return m_versionId; }
119 inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
120 inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; }
121 inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); }
122 inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); }
123 inline GetObjectAttributesRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;}
124 inline GetObjectAttributesRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;}
125 inline GetObjectAttributesRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;}
127
129
132 inline int GetMaxParts() const{ return m_maxParts; }
133 inline bool MaxPartsHasBeenSet() const { return m_maxPartsHasBeenSet; }
134 inline void SetMaxParts(int value) { m_maxPartsHasBeenSet = true; m_maxParts = value; }
135 inline GetObjectAttributesRequest& WithMaxParts(int value) { SetMaxParts(value); return *this;}
137
139
143 inline int GetPartNumberMarker() const{ return m_partNumberMarker; }
144 inline bool PartNumberMarkerHasBeenSet() const { return m_partNumberMarkerHasBeenSet; }
145 inline void SetPartNumberMarker(int value) { m_partNumberMarkerHasBeenSet = true; m_partNumberMarker = value; }
146 inline GetObjectAttributesRequest& WithPartNumberMarker(int value) { SetPartNumberMarker(value); return *this;}
148
150
155 inline const Aws::String& GetSSECustomerAlgorithm() const{ return m_sSECustomerAlgorithm; }
156 inline bool SSECustomerAlgorithmHasBeenSet() const { return m_sSECustomerAlgorithmHasBeenSet; }
157 inline void SetSSECustomerAlgorithm(const Aws::String& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = value; }
158 inline void SetSSECustomerAlgorithm(Aws::String&& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = std::move(value); }
159 inline void SetSSECustomerAlgorithm(const char* value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm.assign(value); }
162 inline GetObjectAttributesRequest& WithSSECustomerAlgorithm(const char* value) { SetSSECustomerAlgorithm(value); return *this;}
164
166
174 inline const Aws::String& GetSSECustomerKey() const{ return m_sSECustomerKey; }
175 inline bool SSECustomerKeyHasBeenSet() const { return m_sSECustomerKeyHasBeenSet; }
176 inline void SetSSECustomerKey(const Aws::String& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = value; }
177 inline void SetSSECustomerKey(Aws::String&& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = std::move(value); }
178 inline void SetSSECustomerKey(const char* value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey.assign(value); }
179 inline GetObjectAttributesRequest& WithSSECustomerKey(const Aws::String& value) { SetSSECustomerKey(value); return *this;}
180 inline GetObjectAttributesRequest& WithSSECustomerKey(Aws::String&& value) { SetSSECustomerKey(std::move(value)); return *this;}
181 inline GetObjectAttributesRequest& WithSSECustomerKey(const char* value) { SetSSECustomerKey(value); return *this;}
183
185
191 inline const Aws::String& GetSSECustomerKeyMD5() const{ return m_sSECustomerKeyMD5; }
192 inline bool SSECustomerKeyMD5HasBeenSet() const { return m_sSECustomerKeyMD5HasBeenSet; }
193 inline void SetSSECustomerKeyMD5(const Aws::String& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = value; }
194 inline void SetSSECustomerKeyMD5(Aws::String&& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = std::move(value); }
195 inline void SetSSECustomerKeyMD5(const char* value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5.assign(value); }
197 inline GetObjectAttributesRequest& WithSSECustomerKeyMD5(Aws::String&& value) { SetSSECustomerKeyMD5(std::move(value)); return *this;}
198 inline GetObjectAttributesRequest& WithSSECustomerKeyMD5(const char* value) { SetSSECustomerKeyMD5(value); return *this;}
200
202
203 inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
204 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
205 inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
206 inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
207 inline GetObjectAttributesRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
208 inline GetObjectAttributesRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
210
212
217 inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
218 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
219 inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
220 inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
221 inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
224 inline GetObjectAttributesRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
226
228
232 inline const Aws::Vector<ObjectAttributes>& GetObjectAttributes() const{ return m_objectAttributes; }
233 inline bool ObjectAttributesHasBeenSet() const { return m_objectAttributesHasBeenSet; }
234 inline void SetObjectAttributes(const Aws::Vector<ObjectAttributes>& value) { m_objectAttributesHasBeenSet = true; m_objectAttributes = value; }
235 inline void SetObjectAttributes(Aws::Vector<ObjectAttributes>&& value) { m_objectAttributesHasBeenSet = true; m_objectAttributes = std::move(value); }
238 inline GetObjectAttributesRequest& AddObjectAttributes(const ObjectAttributes& value) { m_objectAttributesHasBeenSet = true; m_objectAttributes.push_back(value); return *this; }
239 inline GetObjectAttributesRequest& AddObjectAttributes(ObjectAttributes&& value) { m_objectAttributesHasBeenSet = true; m_objectAttributes.push_back(std::move(value)); return *this; }
241
243
244 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
245 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
246 inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
247 inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
250 inline GetObjectAttributesRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
251 inline GetObjectAttributesRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
252 inline GetObjectAttributesRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
253 inline GetObjectAttributesRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
254 inline GetObjectAttributesRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
255 inline GetObjectAttributesRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
256 inline GetObjectAttributesRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
258 private:
259
260 Aws::String m_bucket;
261 bool m_bucketHasBeenSet = false;
262
263 Aws::String m_key;
264 bool m_keyHasBeenSet = false;
265
266 Aws::String m_versionId;
267 bool m_versionIdHasBeenSet = false;
268
269 int m_maxParts;
270 bool m_maxPartsHasBeenSet = false;
271
272 int m_partNumberMarker;
273 bool m_partNumberMarkerHasBeenSet = false;
274
275 Aws::String m_sSECustomerAlgorithm;
276 bool m_sSECustomerAlgorithmHasBeenSet = false;
277
278 Aws::String m_sSECustomerKey;
279 bool m_sSECustomerKeyHasBeenSet = false;
280
281 Aws::String m_sSECustomerKeyMD5;
282 bool m_sSECustomerKeyMD5HasBeenSet = false;
283
284 RequestPayer m_requestPayer;
285 bool m_requestPayerHasBeenSet = false;
286
287 Aws::String m_expectedBucketOwner;
288 bool m_expectedBucketOwnerHasBeenSet = false;
289
290 Aws::Vector<ObjectAttributes> m_objectAttributes;
291 bool m_objectAttributesHasBeenSet = false;
292
293 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
294 bool m_customizedAccessLogTagHasBeenSet = false;
295 };
296
297} // namespace Model
298} // namespace S3
299} // namespace Aws
GetObjectAttributesRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
virtual const char * GetServiceRequestName() const override
GetObjectAttributesRequest & AddObjectAttributes(const ObjectAttributes &value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
GetObjectAttributesRequest & AddCustomizedAccessLogTag(const char *key, const char *value)
const Aws::Vector< ObjectAttributes > & GetObjectAttributes() const
GetObjectAttributesRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
GetObjectAttributesRequest & WithBucket(const char *value)
GetObjectAttributesRequest & WithObjectAttributes(const Aws::Vector< ObjectAttributes > &value)
GetObjectAttributesRequest & WithBucket(const Aws::String &value)
GetObjectAttributesRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
GetObjectAttributesRequest & WithBucket(Aws::String &&value)
GetObjectAttributesRequest & WithSSECustomerKeyMD5(Aws::String &&value)
void SetObjectAttributes(Aws::Vector< ObjectAttributes > &&value)
GetObjectAttributesRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
GetObjectAttributesRequest & WithRequestPayer(const RequestPayer &value)
GetObjectAttributesRequest & WithSSECustomerAlgorithm(const Aws::String &value)
GetObjectAttributesRequest & WithKey(Aws::String &&value)
GetObjectAttributesRequest & WithSSECustomerAlgorithm(const char *value)
GetObjectAttributesRequest & WithSSECustomerKey(const char *value)
void SetObjectAttributes(const Aws::Vector< ObjectAttributes > &value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
GetObjectAttributesRequest & WithSSECustomerKeyMD5(const char *value)
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
GetObjectAttributesRequest & WithExpectedBucketOwner(Aws::String &&value)
GetObjectAttributesRequest & WithSSECustomerKeyMD5(const Aws::String &value)
GetObjectAttributesRequest & WithExpectedBucketOwner(const char *value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
GetObjectAttributesRequest & WithMaxParts(int value)
AWS_S3_API Aws::String SerializePayload() const override
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
GetObjectAttributesRequest & WithVersionId(const Aws::String &value)
GetObjectAttributesRequest & AddObjectAttributes(ObjectAttributes &&value)
GetObjectAttributesRequest & WithSSECustomerKey(Aws::String &&value)
GetObjectAttributesRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
GetObjectAttributesRequest & WithKey(const char *value)
GetObjectAttributesRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
GetObjectAttributesRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
GetObjectAttributesRequest & WithExpectedBucketOwner(const Aws::String &value)
GetObjectAttributesRequest & WithSSECustomerAlgorithm(Aws::String &&value)
GetObjectAttributesRequest & WithVersionId(Aws::String &&value)
GetObjectAttributesRequest & WithSSECustomerKey(const Aws::String &value)
GetObjectAttributesRequest & WithVersionId(const char *value)
GetObjectAttributesRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
GetObjectAttributesRequest & WithRequestPayer(RequestPayer &&value)
GetObjectAttributesRequest & WithPartNumberMarker(int value)
GetObjectAttributesRequest & WithKey(const Aws::String &value)
GetObjectAttributesRequest & WithObjectAttributes(Aws::Vector< ObjectAttributes > &&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
std::vector< T, Aws::Allocator< T > > Vector