AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
ListPartsRequest.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/AWSMap.h>
12#include <utility>
13
14namespace Aws
15{
16namespace Http
17{
18 class URI;
19} //namespace Http
20namespace S3
21{
22namespace Model
23{
24
28 {
29 public:
30 AWS_S3_API ListPartsRequest();
31
32 // Service request name is the Operation name which will send this request out,
33 // each operation should has unique request name, so that we can get operation's name from this request.
34 // Note: this is not true for response, multiple operations may have the same response name,
35 // so we can not get operation's name from response.
36 inline virtual const char* GetServiceRequestName() const override { return "ListParts"; }
37
38 AWS_S3_API Aws::String SerializePayload() const override;
39
40 AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
41
43
44 AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override;
48 AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
49
51
84 inline const Aws::String& GetBucket() const{ return m_bucket; }
85 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
86 inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
87 inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
88 inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
89 inline ListPartsRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
90 inline ListPartsRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
91 inline ListPartsRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
93
95
98 inline const Aws::String& GetKey() const{ return m_key; }
99 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
100 inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; }
101 inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); }
102 inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); }
103 inline ListPartsRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;}
104 inline ListPartsRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;}
105 inline ListPartsRequest& WithKey(const char* value) { SetKey(value); return *this;}
107
109
112 inline int GetMaxParts() const{ return m_maxParts; }
113 inline bool MaxPartsHasBeenSet() const { return m_maxPartsHasBeenSet; }
114 inline void SetMaxParts(int value) { m_maxPartsHasBeenSet = true; m_maxParts = value; }
115 inline ListPartsRequest& WithMaxParts(int value) { SetMaxParts(value); return *this;}
117
119
123 inline int GetPartNumberMarker() const{ return m_partNumberMarker; }
124 inline bool PartNumberMarkerHasBeenSet() const { return m_partNumberMarkerHasBeenSet; }
125 inline void SetPartNumberMarker(int value) { m_partNumberMarkerHasBeenSet = true; m_partNumberMarker = value; }
126 inline ListPartsRequest& WithPartNumberMarker(int value) { SetPartNumberMarker(value); return *this;}
128
130
133 inline const Aws::String& GetUploadId() const{ return m_uploadId; }
134 inline bool UploadIdHasBeenSet() const { return m_uploadIdHasBeenSet; }
135 inline void SetUploadId(const Aws::String& value) { m_uploadIdHasBeenSet = true; m_uploadId = value; }
136 inline void SetUploadId(Aws::String&& value) { m_uploadIdHasBeenSet = true; m_uploadId = std::move(value); }
137 inline void SetUploadId(const char* value) { m_uploadIdHasBeenSet = true; m_uploadId.assign(value); }
138 inline ListPartsRequest& WithUploadId(const Aws::String& value) { SetUploadId(value); return *this;}
139 inline ListPartsRequest& WithUploadId(Aws::String&& value) { SetUploadId(std::move(value)); return *this;}
140 inline ListPartsRequest& WithUploadId(const char* value) { SetUploadId(value); return *this;}
142
144
145 inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
146 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
147 inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
148 inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
149 inline ListPartsRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
150 inline ListPartsRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
152
154
159 inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
160 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
161 inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
162 inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
163 inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
164 inline ListPartsRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;}
165 inline ListPartsRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
166 inline ListPartsRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
168
170
178 inline const Aws::String& GetSSECustomerAlgorithm() const{ return m_sSECustomerAlgorithm; }
179 inline bool SSECustomerAlgorithmHasBeenSet() const { return m_sSECustomerAlgorithmHasBeenSet; }
180 inline void SetSSECustomerAlgorithm(const Aws::String& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = value; }
181 inline void SetSSECustomerAlgorithm(Aws::String&& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = std::move(value); }
182 inline void SetSSECustomerAlgorithm(const char* value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm.assign(value); }
184 inline ListPartsRequest& WithSSECustomerAlgorithm(Aws::String&& value) { SetSSECustomerAlgorithm(std::move(value)); return *this;}
185 inline ListPartsRequest& WithSSECustomerAlgorithm(const char* value) { SetSSECustomerAlgorithm(value); return *this;}
187
189
197 inline const Aws::String& GetSSECustomerKey() const{ return m_sSECustomerKey; }
198 inline bool SSECustomerKeyHasBeenSet() const { return m_sSECustomerKeyHasBeenSet; }
199 inline void SetSSECustomerKey(const Aws::String& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = value; }
200 inline void SetSSECustomerKey(Aws::String&& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = std::move(value); }
201 inline void SetSSECustomerKey(const char* value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey.assign(value); }
202 inline ListPartsRequest& WithSSECustomerKey(const Aws::String& value) { SetSSECustomerKey(value); return *this;}
203 inline ListPartsRequest& WithSSECustomerKey(Aws::String&& value) { SetSSECustomerKey(std::move(value)); return *this;}
204 inline ListPartsRequest& WithSSECustomerKey(const char* value) { SetSSECustomerKey(value); return *this;}
206
208
216 inline const Aws::String& GetSSECustomerKeyMD5() const{ return m_sSECustomerKeyMD5; }
217 inline bool SSECustomerKeyMD5HasBeenSet() const { return m_sSECustomerKeyMD5HasBeenSet; }
218 inline void SetSSECustomerKeyMD5(const Aws::String& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = value; }
219 inline void SetSSECustomerKeyMD5(Aws::String&& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = std::move(value); }
220 inline void SetSSECustomerKeyMD5(const char* value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5.assign(value); }
221 inline ListPartsRequest& WithSSECustomerKeyMD5(const Aws::String& value) { SetSSECustomerKeyMD5(value); return *this;}
222 inline ListPartsRequest& WithSSECustomerKeyMD5(Aws::String&& value) { SetSSECustomerKeyMD5(std::move(value)); return *this;}
223 inline ListPartsRequest& WithSSECustomerKeyMD5(const char* value) { SetSSECustomerKeyMD5(value); return *this;}
225
227
228 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
229 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
230 inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
231 inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
234 inline ListPartsRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
235 inline ListPartsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
236 inline ListPartsRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
237 inline ListPartsRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
238 inline ListPartsRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
239 inline ListPartsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
240 inline ListPartsRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
242 private:
243
244 Aws::String m_bucket;
245 bool m_bucketHasBeenSet = false;
246
247 Aws::String m_key;
248 bool m_keyHasBeenSet = false;
249
250 int m_maxParts;
251 bool m_maxPartsHasBeenSet = false;
252
253 int m_partNumberMarker;
254 bool m_partNumberMarkerHasBeenSet = false;
255
256 Aws::String m_uploadId;
257 bool m_uploadIdHasBeenSet = false;
258
259 RequestPayer m_requestPayer;
260 bool m_requestPayerHasBeenSet = false;
261
262 Aws::String m_expectedBucketOwner;
263 bool m_expectedBucketOwnerHasBeenSet = false;
264
265 Aws::String m_sSECustomerAlgorithm;
266 bool m_sSECustomerAlgorithmHasBeenSet = false;
267
268 Aws::String m_sSECustomerKey;
269 bool m_sSECustomerKeyHasBeenSet = false;
270
271 Aws::String m_sSECustomerKeyMD5;
272 bool m_sSECustomerKeyMD5HasBeenSet = false;
273
274 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
275 bool m_customizedAccessLogTagHasBeenSet = false;
276 };
277
278} // namespace Model
279} // namespace S3
280} // namespace Aws
ListPartsRequest & WithSSECustomerKey(const char *value)
const Aws::String & GetSSECustomerKey() const
void SetUploadId(Aws::String &&value)
void SetRequestPayer(RequestPayer &&value)
ListPartsRequest & AddCustomizedAccessLogTag(const char *key, const char *value)
ListPartsRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
ListPartsRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
ListPartsRequest & WithSSECustomerKeyMD5(const Aws::String &value)
void SetSSECustomerAlgorithm(Aws::String &&value)
ListPartsRequest & WithBucket(const Aws::String &value)
ListPartsRequest & WithUploadId(const Aws::String &value)
const Aws::String & GetBucket() const
ListPartsRequest & WithBucket(Aws::String &&value)
const RequestPayer & GetRequestPayer() const
ListPartsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
ListPartsRequest & WithRequestPayer(RequestPayer &&value)
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
ListPartsRequest & WithSSECustomerAlgorithm(const char *value)
const Aws::String & GetUploadId() const
const Aws::String & GetExpectedBucketOwner() const
void SetSSECustomerKeyMD5(Aws::String &&value)
ListPartsRequest & WithSSECustomerKey(Aws::String &&value)
ListPartsRequest & WithKey(Aws::String &&value)
ListPartsRequest & WithRequestPayer(const RequestPayer &value)
void SetSSECustomerAlgorithm(const char *value)
void SetBucket(const Aws::String &value)
void SetRequestPayer(const RequestPayer &value)
ListPartsRequest & WithSSECustomerAlgorithm(const Aws::String &value)
virtual const char * GetServiceRequestName() const override
void SetSSECustomerKeyMD5(const char *value)
void SetBucket(const char *value)
void SetSSECustomerKey(Aws::String &&value)
ListPartsRequest & WithSSECustomerKeyMD5(const char *value)
ListPartsRequest & WithExpectedBucketOwner(Aws::String &&value)
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
ListPartsRequest & WithSSECustomerAlgorithm(Aws::String &&value)
void SetKey(const Aws::String &value)
void SetBucket(Aws::String &&value)
void SetUploadId(const char *value)
ListPartsRequest & WithBucket(const char *value)
ListPartsRequest & WithKey(const Aws::String &value)
void SetExpectedBucketOwner(const char *value)
void SetSSECustomerKeyMD5(const Aws::String &value)
ListPartsRequest & WithUploadId(Aws::String &&value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
AWS_S3_API Aws::String SerializePayload() const override
void SetExpectedBucketOwner(const Aws::String &value)
ListPartsRequest & WithUploadId(const char *value)
ListPartsRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
const Aws::String & GetKey() const
void SetExpectedBucketOwner(Aws::String &&value)
ListPartsRequest & WithExpectedBucketOwner(const Aws::String &value)
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
ListPartsRequest & WithSSECustomerKeyMD5(Aws::String &&value)
ListPartsRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
void SetSSECustomerKey(const char *value)
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
ListPartsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
ListPartsRequest & WithExpectedBucketOwner(const char *value)
void SetSSECustomerAlgorithm(const Aws::String &value)
void SetSSECustomerKey(const Aws::String &value)
ListPartsRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
void SetKey(Aws::String &&value)
ListPartsRequest & WithMaxParts(int value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
void SetUploadId(const Aws::String &value)
const Aws::String & GetSSECustomerAlgorithm() const
const Aws::String & GetSSECustomerKeyMD5() const
ListPartsRequest & WithPartNumberMarker(int value)
ListPartsRequest & WithKey(const char *value)
ListPartsRequest & WithSSECustomerKey(const Aws::String &value)
ListPartsRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &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