AWS SDK for C++

AWS SDK for C++ Version 1.11.606

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() = default;
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
86 inline const Aws::String& GetBucket() const { return m_bucket; }
87 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
88 template<typename BucketT = Aws::String>
89 void SetBucket(BucketT&& value) { m_bucketHasBeenSet = true; m_bucket = std::forward<BucketT>(value); }
90 template<typename BucketT = Aws::String>
91 ListPartsRequest& WithBucket(BucketT&& value) { SetBucket(std::forward<BucketT>(value)); return *this;}
93
95
98 inline const Aws::String& GetKey() const { return m_key; }
99 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
100 template<typename KeyT = Aws::String>
101 void SetKey(KeyT&& value) { m_keyHasBeenSet = true; m_key = std::forward<KeyT>(value); }
102 template<typename KeyT = Aws::String>
103 ListPartsRequest& WithKey(KeyT&& value) { SetKey(std::forward<KeyT>(value)); return *this;}
105
107
110 inline int GetMaxParts() const { return m_maxParts; }
111 inline bool MaxPartsHasBeenSet() const { return m_maxPartsHasBeenSet; }
112 inline void SetMaxParts(int value) { m_maxPartsHasBeenSet = true; m_maxParts = value; }
113 inline ListPartsRequest& WithMaxParts(int value) { SetMaxParts(value); return *this;}
115
117
121 inline int GetPartNumberMarker() const { return m_partNumberMarker; }
122 inline bool PartNumberMarkerHasBeenSet() const { return m_partNumberMarkerHasBeenSet; }
123 inline void SetPartNumberMarker(int value) { m_partNumberMarkerHasBeenSet = true; m_partNumberMarker = value; }
124 inline ListPartsRequest& WithPartNumberMarker(int value) { SetPartNumberMarker(value); return *this;}
126
128
131 inline const Aws::String& GetUploadId() const { return m_uploadId; }
132 inline bool UploadIdHasBeenSet() const { return m_uploadIdHasBeenSet; }
133 template<typename UploadIdT = Aws::String>
134 void SetUploadId(UploadIdT&& value) { m_uploadIdHasBeenSet = true; m_uploadId = std::forward<UploadIdT>(value); }
135 template<typename UploadIdT = Aws::String>
136 ListPartsRequest& WithUploadId(UploadIdT&& value) { SetUploadId(std::forward<UploadIdT>(value)); return *this;}
138
140
141 inline RequestPayer GetRequestPayer() const { return m_requestPayer; }
142 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
143 inline void SetRequestPayer(RequestPayer value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
144 inline ListPartsRequest& WithRequestPayer(RequestPayer value) { SetRequestPayer(value); return *this;}
146
148
153 inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; }
154 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
155 template<typename ExpectedBucketOwnerT = Aws::String>
156 void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::forward<ExpectedBucketOwnerT>(value); }
157 template<typename ExpectedBucketOwnerT = Aws::String>
158 ListPartsRequest& WithExpectedBucketOwner(ExpectedBucketOwnerT&& value) { SetExpectedBucketOwner(std::forward<ExpectedBucketOwnerT>(value)); return *this;}
160
162
170 inline const Aws::String& GetSSECustomerAlgorithm() const { return m_sSECustomerAlgorithm; }
171 inline bool SSECustomerAlgorithmHasBeenSet() const { return m_sSECustomerAlgorithmHasBeenSet; }
172 template<typename SSECustomerAlgorithmT = Aws::String>
173 void SetSSECustomerAlgorithm(SSECustomerAlgorithmT&& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = std::forward<SSECustomerAlgorithmT>(value); }
174 template<typename SSECustomerAlgorithmT = Aws::String>
175 ListPartsRequest& WithSSECustomerAlgorithm(SSECustomerAlgorithmT&& value) { SetSSECustomerAlgorithm(std::forward<SSECustomerAlgorithmT>(value)); return *this;}
177
179
187 inline const Aws::String& GetSSECustomerKey() const { return m_sSECustomerKey; }
188 inline bool SSECustomerKeyHasBeenSet() const { return m_sSECustomerKeyHasBeenSet; }
189 template<typename SSECustomerKeyT = Aws::String>
190 void SetSSECustomerKey(SSECustomerKeyT&& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = std::forward<SSECustomerKeyT>(value); }
191 template<typename SSECustomerKeyT = Aws::String>
192 ListPartsRequest& WithSSECustomerKey(SSECustomerKeyT&& value) { SetSSECustomerKey(std::forward<SSECustomerKeyT>(value)); return *this;}
194
196
204 inline const Aws::String& GetSSECustomerKeyMD5() const { return m_sSECustomerKeyMD5; }
205 inline bool SSECustomerKeyMD5HasBeenSet() const { return m_sSECustomerKeyMD5HasBeenSet; }
206 template<typename SSECustomerKeyMD5T = Aws::String>
207 void SetSSECustomerKeyMD5(SSECustomerKeyMD5T&& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = std::forward<SSECustomerKeyMD5T>(value); }
208 template<typename SSECustomerKeyMD5T = Aws::String>
209 ListPartsRequest& WithSSECustomerKeyMD5(SSECustomerKeyMD5T&& value) { SetSSECustomerKeyMD5(std::forward<SSECustomerKeyMD5T>(value)); return *this;}
211
213
214 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
215 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
216 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
217 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value); }
218 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
219 ListPartsRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value)); return *this;}
220 template<typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
221 ListPartsRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
222 m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value)); return *this;
223 }
225 private:
226
227 Aws::String m_bucket;
228 bool m_bucketHasBeenSet = false;
229
230 Aws::String m_key;
231 bool m_keyHasBeenSet = false;
232
233 int m_maxParts{0};
234 bool m_maxPartsHasBeenSet = false;
235
236 int m_partNumberMarker{0};
237 bool m_partNumberMarkerHasBeenSet = false;
238
239 Aws::String m_uploadId;
240 bool m_uploadIdHasBeenSet = false;
241
242 RequestPayer m_requestPayer{RequestPayer::NOT_SET};
243 bool m_requestPayerHasBeenSet = false;
244
245 Aws::String m_expectedBucketOwner;
246 bool m_expectedBucketOwnerHasBeenSet = false;
247
248 Aws::String m_sSECustomerAlgorithm;
249 bool m_sSECustomerAlgorithmHasBeenSet = false;
250
251 Aws::String m_sSECustomerKey;
252 bool m_sSECustomerKeyHasBeenSet = false;
253
254 Aws::String m_sSECustomerKeyMD5;
255 bool m_sSECustomerKeyMD5HasBeenSet = false;
256
257 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
258 bool m_customizedAccessLogTagHasBeenSet = false;
259 };
260
261} // namespace Model
262} // namespace S3
263} // namespace Aws
const Aws::String & GetSSECustomerKey() const
void SetUploadId(UploadIdT &&value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
const Aws::String & GetBucket() const
void SetSSECustomerKeyMD5(SSECustomerKeyMD5T &&value)
ListPartsRequest & WithSSECustomerKey(SSECustomerKeyT &&value)
void SetExpectedBucketOwner(ExpectedBucketOwnerT &&value)
ListPartsRequest & WithUploadId(UploadIdT &&value)
ListPartsRequest & WithSSECustomerKeyMD5(SSECustomerKeyMD5T &&value)
const Aws::String & GetUploadId() const
const Aws::String & GetExpectedBucketOwner() const
void SetRequestPayer(RequestPayer value)
virtual const char * GetServiceRequestName() const override
void SetSSECustomerAlgorithm(SSECustomerAlgorithmT &&value)
void SetCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
AWS_S3_API Aws::String SerializePayload() const override
const Aws::String & GetKey() const
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
ListPartsRequest & WithKey(KeyT &&value)
ListPartsRequest & WithCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
ListPartsRequest & WithRequestPayer(RequestPayer value)
AWS_S3_API ListPartsRequest()=default
ListPartsRequest & WithExpectedBucketOwner(ExpectedBucketOwnerT &&value)
ListPartsRequest & WithSSECustomerAlgorithm(SSECustomerAlgorithmT &&value)
ListPartsRequest & WithBucket(BucketT &&value)
ListPartsRequest & WithMaxParts(int value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
ListPartsRequest & AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT &&key, CustomizedAccessLogTagValueT &&value)
const Aws::String & GetSSECustomerAlgorithm() const
void SetSSECustomerKey(SSECustomerKeyT &&value)
const Aws::String & GetSSECustomerKeyMD5() const
ListPartsRequest & 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