AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
ListObjectVersionsRequest.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/EncodingType.h>
11#include <aws/s3/model/RequestPayer.h>
12#include <aws/core/utils/memory/stl/AWSVector.h>
13#include <aws/core/utils/memory/stl/AWSMap.h>
14#include <aws/s3/model/OptionalObjectAttributes.h>
15#include <utility>
16
17namespace Aws
18{
19namespace Http
20{
21 class URI;
22} //namespace Http
23namespace S3
24{
25namespace Model
26{
27
31 {
32 public:
34
35 // Service request name is the Operation name which will send this request out,
36 // each operation should has unique request name, so that we can get operation's name from this request.
37 // Note: this is not true for response, multiple operations may have the same response name,
38 // so we can not get operation's name from response.
39 inline virtual const char* GetServiceRequestName() const override { return "ListObjectVersions"; }
40
41 AWS_S3_API Aws::String SerializePayload() const override;
42
43 AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
44
46
47 AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override;
51 AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
52
54
57 inline const Aws::String& GetBucket() const{ return m_bucket; }
58 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
59 inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
60 inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
61 inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
62 inline ListObjectVersionsRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
63 inline ListObjectVersionsRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
64 inline ListObjectVersionsRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
66
68
76 inline const Aws::String& GetDelimiter() const{ return m_delimiter; }
77 inline bool DelimiterHasBeenSet() const { return m_delimiterHasBeenSet; }
78 inline void SetDelimiter(const Aws::String& value) { m_delimiterHasBeenSet = true; m_delimiter = value; }
79 inline void SetDelimiter(Aws::String&& value) { m_delimiterHasBeenSet = true; m_delimiter = std::move(value); }
80 inline void SetDelimiter(const char* value) { m_delimiterHasBeenSet = true; m_delimiter.assign(value); }
81 inline ListObjectVersionsRequest& WithDelimiter(const Aws::String& value) { SetDelimiter(value); return *this;}
82 inline ListObjectVersionsRequest& WithDelimiter(Aws::String&& value) { SetDelimiter(std::move(value)); return *this;}
83 inline ListObjectVersionsRequest& WithDelimiter(const char* value) { SetDelimiter(value); return *this;}
85
87
88 inline const EncodingType& GetEncodingType() const{ return m_encodingType; }
89 inline bool EncodingTypeHasBeenSet() const { return m_encodingTypeHasBeenSet; }
90 inline void SetEncodingType(const EncodingType& value) { m_encodingTypeHasBeenSet = true; m_encodingType = value; }
91 inline void SetEncodingType(EncodingType&& value) { m_encodingTypeHasBeenSet = true; m_encodingType = std::move(value); }
92 inline ListObjectVersionsRequest& WithEncodingType(const EncodingType& value) { SetEncodingType(value); return *this;}
93 inline ListObjectVersionsRequest& WithEncodingType(EncodingType&& value) { SetEncodingType(std::move(value)); return *this;}
95
97
100 inline const Aws::String& GetKeyMarker() const{ return m_keyMarker; }
101 inline bool KeyMarkerHasBeenSet() const { return m_keyMarkerHasBeenSet; }
102 inline void SetKeyMarker(const Aws::String& value) { m_keyMarkerHasBeenSet = true; m_keyMarker = value; }
103 inline void SetKeyMarker(Aws::String&& value) { m_keyMarkerHasBeenSet = true; m_keyMarker = std::move(value); }
104 inline void SetKeyMarker(const char* value) { m_keyMarkerHasBeenSet = true; m_keyMarker.assign(value); }
105 inline ListObjectVersionsRequest& WithKeyMarker(const Aws::String& value) { SetKeyMarker(value); return *this;}
106 inline ListObjectVersionsRequest& WithKeyMarker(Aws::String&& value) { SetKeyMarker(std::move(value)); return *this;}
107 inline ListObjectVersionsRequest& WithKeyMarker(const char* value) { SetKeyMarker(value); return *this;}
109
111
120 inline int GetMaxKeys() const{ return m_maxKeys; }
121 inline bool MaxKeysHasBeenSet() const { return m_maxKeysHasBeenSet; }
122 inline void SetMaxKeys(int value) { m_maxKeysHasBeenSet = true; m_maxKeys = value; }
123 inline ListObjectVersionsRequest& WithMaxKeys(int value) { SetMaxKeys(value); return *this;}
125
127
135 inline const Aws::String& GetPrefix() const{ return m_prefix; }
136 inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; }
137 inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; }
138 inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = std::move(value); }
139 inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); }
140 inline ListObjectVersionsRequest& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;}
141 inline ListObjectVersionsRequest& WithPrefix(Aws::String&& value) { SetPrefix(std::move(value)); return *this;}
142 inline ListObjectVersionsRequest& WithPrefix(const char* value) { SetPrefix(value); return *this;}
144
146
149 inline const Aws::String& GetVersionIdMarker() const{ return m_versionIdMarker; }
150 inline bool VersionIdMarkerHasBeenSet() const { return m_versionIdMarkerHasBeenSet; }
151 inline void SetVersionIdMarker(const Aws::String& value) { m_versionIdMarkerHasBeenSet = true; m_versionIdMarker = value; }
152 inline void SetVersionIdMarker(Aws::String&& value) { m_versionIdMarkerHasBeenSet = true; m_versionIdMarker = std::move(value); }
153 inline void SetVersionIdMarker(const char* value) { m_versionIdMarkerHasBeenSet = true; m_versionIdMarker.assign(value); }
155 inline ListObjectVersionsRequest& WithVersionIdMarker(Aws::String&& value) { SetVersionIdMarker(std::move(value)); return *this;}
156 inline ListObjectVersionsRequest& WithVersionIdMarker(const char* value) { SetVersionIdMarker(value); return *this;}
158
160
165 inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
166 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
167 inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
168 inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
169 inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
171 inline ListObjectVersionsRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
172 inline ListObjectVersionsRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
174
176
177 inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; }
178 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
179 inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
180 inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); }
181 inline ListObjectVersionsRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;}
182 inline ListObjectVersionsRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;}
184
186
190 inline const Aws::Vector<OptionalObjectAttributes>& GetOptionalObjectAttributes() const{ return m_optionalObjectAttributes; }
191 inline bool OptionalObjectAttributesHasBeenSet() const { return m_optionalObjectAttributesHasBeenSet; }
192 inline void SetOptionalObjectAttributes(const Aws::Vector<OptionalObjectAttributes>& value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes = value; }
193 inline void SetOptionalObjectAttributes(Aws::Vector<OptionalObjectAttributes>&& value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes = std::move(value); }
196 inline ListObjectVersionsRequest& AddOptionalObjectAttributes(const OptionalObjectAttributes& value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes.push_back(value); return *this; }
197 inline ListObjectVersionsRequest& AddOptionalObjectAttributes(OptionalObjectAttributes&& value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes.push_back(std::move(value)); return *this; }
199
201
202 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
203 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
204 inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
205 inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
208 inline ListObjectVersionsRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
209 inline ListObjectVersionsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
210 inline ListObjectVersionsRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
211 inline ListObjectVersionsRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
212 inline ListObjectVersionsRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
213 inline ListObjectVersionsRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
214 inline ListObjectVersionsRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
216 private:
217
218 Aws::String m_bucket;
219 bool m_bucketHasBeenSet = false;
220
221 Aws::String m_delimiter;
222 bool m_delimiterHasBeenSet = false;
223
224 EncodingType m_encodingType;
225 bool m_encodingTypeHasBeenSet = false;
226
227 Aws::String m_keyMarker;
228 bool m_keyMarkerHasBeenSet = false;
229
230 int m_maxKeys;
231 bool m_maxKeysHasBeenSet = false;
232
233 Aws::String m_prefix;
234 bool m_prefixHasBeenSet = false;
235
236 Aws::String m_versionIdMarker;
237 bool m_versionIdMarkerHasBeenSet = false;
238
239 Aws::String m_expectedBucketOwner;
240 bool m_expectedBucketOwnerHasBeenSet = false;
241
242 RequestPayer m_requestPayer;
243 bool m_requestPayerHasBeenSet = false;
244
245 Aws::Vector<OptionalObjectAttributes> m_optionalObjectAttributes;
246 bool m_optionalObjectAttributesHasBeenSet = false;
247
248 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
249 bool m_customizedAccessLogTagHasBeenSet = false;
250 };
251
252} // namespace Model
253} // namespace S3
254} // namespace Aws
AWS_S3_API Aws::String SerializePayload() const override
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
ListObjectVersionsRequest & WithVersionIdMarker(const char *value)
ListObjectVersionsRequest & AddCustomizedAccessLogTag(const char *key, const char *value)
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
ListObjectVersionsRequest & WithPrefix(const char *value)
ListObjectVersionsRequest & WithRequestPayer(const RequestPayer &value)
virtual const char * GetServiceRequestName() const override
ListObjectVersionsRequest & WithEncodingType(const EncodingType &value)
ListObjectVersionsRequest & WithKeyMarker(const Aws::String &value)
ListObjectVersionsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
const Aws::Vector< OptionalObjectAttributes > & GetOptionalObjectAttributes() const
ListObjectVersionsRequest & WithPrefix(Aws::String &&value)
ListObjectVersionsRequest & WithRequestPayer(RequestPayer &&value)
ListObjectVersionsRequest & WithBucket(Aws::String &&value)
ListObjectVersionsRequest & WithBucket(const char *value)
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
ListObjectVersionsRequest & WithKeyMarker(Aws::String &&value)
ListObjectVersionsRequest & WithExpectedBucketOwner(const char *value)
ListObjectVersionsRequest & WithVersionIdMarker(const Aws::String &value)
ListObjectVersionsRequest & AddOptionalObjectAttributes(const OptionalObjectAttributes &value)
void SetOptionalObjectAttributes(const Aws::Vector< OptionalObjectAttributes > &value)
ListObjectVersionsRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
ListObjectVersionsRequest & WithPrefix(const Aws::String &value)
ListObjectVersionsRequest & WithVersionIdMarker(Aws::String &&value)
ListObjectVersionsRequest & WithEncodingType(EncodingType &&value)
ListObjectVersionsRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
ListObjectVersionsRequest & WithExpectedBucketOwner(const Aws::String &value)
ListObjectVersionsRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
ListObjectVersionsRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
ListObjectVersionsRequest & WithKeyMarker(const char *value)
ListObjectVersionsRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
ListObjectVersionsRequest & WithMaxKeys(int value)
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
ListObjectVersionsRequest & WithOptionalObjectAttributes(const Aws::Vector< OptionalObjectAttributes > &value)
ListObjectVersionsRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
ListObjectVersionsRequest & WithOptionalObjectAttributes(Aws::Vector< OptionalObjectAttributes > &&value)
ListObjectVersionsRequest & WithDelimiter(const char *value)
void SetExpectedBucketOwner(const Aws::String &value)
ListObjectVersionsRequest & WithExpectedBucketOwner(Aws::String &&value)
ListObjectVersionsRequest & WithDelimiter(Aws::String &&value)
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
ListObjectVersionsRequest & AddOptionalObjectAttributes(OptionalObjectAttributes &&value)
ListObjectVersionsRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
ListObjectVersionsRequest & WithDelimiter(const Aws::String &value)
void SetOptionalObjectAttributes(Aws::Vector< OptionalObjectAttributes > &&value)
ListObjectVersionsRequest & WithBucket(const 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
std::vector< T, Aws::Allocator< T > > Vector