AWS SDK for C++

AWS SDK for C++ Version 1.11.606

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:
32 AWS_S3_API GetObjectAttributesRequest() = 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 "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
88 inline const Aws::String& GetBucket() const { return m_bucket; }
89 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
90 template<typename BucketT = Aws::String>
91 void SetBucket(BucketT&& value) { m_bucketHasBeenSet = true; m_bucket = std::forward<BucketT>(value); }
92 template<typename BucketT = Aws::String>
93 GetObjectAttributesRequest& WithBucket(BucketT&& value) { SetBucket(std::forward<BucketT>(value)); return *this;}
95
97
100 inline const Aws::String& GetKey() const { return m_key; }
101 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
102 template<typename KeyT = Aws::String>
103 void SetKey(KeyT&& value) { m_keyHasBeenSet = true; m_key = std::forward<KeyT>(value); }
104 template<typename KeyT = Aws::String>
105 GetObjectAttributesRequest& WithKey(KeyT&& value) { SetKey(std::forward<KeyT>(value)); return *this;}
107
109
116 inline const Aws::String& GetVersionId() const { return m_versionId; }
117 inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; }
118 template<typename VersionIdT = Aws::String>
119 void SetVersionId(VersionIdT&& value) { m_versionIdHasBeenSet = true; m_versionId = std::forward<VersionIdT>(value); }
120 template<typename VersionIdT = Aws::String>
121 GetObjectAttributesRequest& WithVersionId(VersionIdT&& value) { SetVersionId(std::forward<VersionIdT>(value)); return *this;}
123
125
131 inline int GetMaxParts() const { return m_maxParts; }
132 inline bool MaxPartsHasBeenSet() const { return m_maxPartsHasBeenSet; }
133 inline void SetMaxParts(int value) { m_maxPartsHasBeenSet = true; m_maxParts = value; }
134 inline GetObjectAttributesRequest& WithMaxParts(int value) { SetMaxParts(value); return *this;}
136
138
145 inline int GetPartNumberMarker() const { return m_partNumberMarker; }
146 inline bool PartNumberMarkerHasBeenSet() const { return m_partNumberMarkerHasBeenSet; }
147 inline void SetPartNumberMarker(int value) { m_partNumberMarkerHasBeenSet = true; m_partNumberMarker = value; }
148 inline GetObjectAttributesRequest& WithPartNumberMarker(int value) { SetPartNumberMarker(value); return *this;}
150
152
157 inline const Aws::String& GetSSECustomerAlgorithm() const { return m_sSECustomerAlgorithm; }
158 inline bool SSECustomerAlgorithmHasBeenSet() const { return m_sSECustomerAlgorithmHasBeenSet; }
159 template<typename SSECustomerAlgorithmT = Aws::String>
160 void SetSSECustomerAlgorithm(SSECustomerAlgorithmT&& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = std::forward<SSECustomerAlgorithmT>(value); }
161 template<typename SSECustomerAlgorithmT = Aws::String>
162 GetObjectAttributesRequest& WithSSECustomerAlgorithm(SSECustomerAlgorithmT&& value) { SetSSECustomerAlgorithm(std::forward<SSECustomerAlgorithmT>(value)); return *this;}
164
166
174 inline const Aws::String& GetSSECustomerKey() const { return m_sSECustomerKey; }
175 inline bool SSECustomerKeyHasBeenSet() const { return m_sSECustomerKeyHasBeenSet; }
176 template<typename SSECustomerKeyT = Aws::String>
177 void SetSSECustomerKey(SSECustomerKeyT&& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = std::forward<SSECustomerKeyT>(value); }
178 template<typename SSECustomerKeyT = Aws::String>
179 GetObjectAttributesRequest& WithSSECustomerKey(SSECustomerKeyT&& value) { SetSSECustomerKey(std::forward<SSECustomerKeyT>(value)); return *this;}
181
183
189 inline const Aws::String& GetSSECustomerKeyMD5() const { return m_sSECustomerKeyMD5; }
190 inline bool SSECustomerKeyMD5HasBeenSet() const { return m_sSECustomerKeyMD5HasBeenSet; }
191 template<typename SSECustomerKeyMD5T = Aws::String>
192 void SetSSECustomerKeyMD5(SSECustomerKeyMD5T&& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = std::forward<SSECustomerKeyMD5T>(value); }
193 template<typename SSECustomerKeyMD5T = Aws::String>
194 GetObjectAttributesRequest& WithSSECustomerKeyMD5(SSECustomerKeyMD5T&& value) { SetSSECustomerKeyMD5(std::forward<SSECustomerKeyMD5T>(value)); return *this;}
196
198
199 inline RequestPayer GetRequestPayer() const { return m_requestPayer; }
200 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
201 inline void SetRequestPayer(RequestPayer value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
204
206
211 inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; }
212 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
213 template<typename ExpectedBucketOwnerT = Aws::String>
214 void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::forward<ExpectedBucketOwnerT>(value); }
215 template<typename ExpectedBucketOwnerT = Aws::String>
216 GetObjectAttributesRequest& WithExpectedBucketOwner(ExpectedBucketOwnerT&& value) { SetExpectedBucketOwner(std::forward<ExpectedBucketOwnerT>(value)); return *this;}
218
220
224 inline const Aws::Vector<ObjectAttributes>& GetObjectAttributes() const { return m_objectAttributes; }
225 inline bool ObjectAttributesHasBeenSet() const { return m_objectAttributesHasBeenSet; }
226 template<typename ObjectAttributesT = Aws::Vector<ObjectAttributes>>
227 void SetObjectAttributes(ObjectAttributesT&& value) { m_objectAttributesHasBeenSet = true; m_objectAttributes = std::forward<ObjectAttributesT>(value); }
228 template<typename ObjectAttributesT = Aws::Vector<ObjectAttributes>>
229 GetObjectAttributesRequest& WithObjectAttributes(ObjectAttributesT&& value) { SetObjectAttributes(std::forward<ObjectAttributesT>(value)); return *this;}
230 inline GetObjectAttributesRequest& AddObjectAttributes(ObjectAttributes value) { m_objectAttributesHasBeenSet = true; m_objectAttributes.push_back(value); return *this; }
232
234
235 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
236 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
237 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
238 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value); }
239 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
240 GetObjectAttributesRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value)); return *this;}
241 template<typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
242 GetObjectAttributesRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
243 m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value)); return *this;
244 }
246 private:
247
248 Aws::String m_bucket;
249 bool m_bucketHasBeenSet = false;
250
251 Aws::String m_key;
252 bool m_keyHasBeenSet = false;
253
254 Aws::String m_versionId;
255 bool m_versionIdHasBeenSet = false;
256
257 int m_maxParts{0};
258 bool m_maxPartsHasBeenSet = false;
259
260 int m_partNumberMarker{0};
261 bool m_partNumberMarkerHasBeenSet = false;
262
263 Aws::String m_sSECustomerAlgorithm;
264 bool m_sSECustomerAlgorithmHasBeenSet = false;
265
266 Aws::String m_sSECustomerKey;
267 bool m_sSECustomerKeyHasBeenSet = false;
268
269 Aws::String m_sSECustomerKeyMD5;
270 bool m_sSECustomerKeyMD5HasBeenSet = false;
271
272 RequestPayer m_requestPayer{RequestPayer::NOT_SET};
273 bool m_requestPayerHasBeenSet = false;
274
275 Aws::String m_expectedBucketOwner;
276 bool m_expectedBucketOwnerHasBeenSet = false;
277
278 Aws::Vector<ObjectAttributes> m_objectAttributes;
279 bool m_objectAttributesHasBeenSet = false;
280
281 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
282 bool m_customizedAccessLogTagHasBeenSet = false;
283 };
284
285} // namespace Model
286} // namespace S3
287} // 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: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