AWS SDK for C++

AWS SDK for C++ Version 1.11.606

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:
33 AWS_S3_API ListObjectVersionsRequest() = default;
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 template<typename BucketT = Aws::String>
60 void SetBucket(BucketT&& value) { m_bucketHasBeenSet = true; m_bucket = std::forward<BucketT>(value); }
61 template<typename BucketT = Aws::String>
62 ListObjectVersionsRequest& WithBucket(BucketT&& value) { SetBucket(std::forward<BucketT>(value)); return *this;}
64
66
75 inline const Aws::String& GetDelimiter() const { return m_delimiter; }
76 inline bool DelimiterHasBeenSet() const { return m_delimiterHasBeenSet; }
77 template<typename DelimiterT = Aws::String>
78 void SetDelimiter(DelimiterT&& value) { m_delimiterHasBeenSet = true; m_delimiter = std::forward<DelimiterT>(value); }
79 template<typename DelimiterT = Aws::String>
80 ListObjectVersionsRequest& WithDelimiter(DelimiterT&& value) { SetDelimiter(std::forward<DelimiterT>(value)); return *this;}
82
84
85 inline EncodingType GetEncodingType() const { return m_encodingType; }
86 inline bool EncodingTypeHasBeenSet() const { return m_encodingTypeHasBeenSet; }
87 inline void SetEncodingType(EncodingType value) { m_encodingTypeHasBeenSet = true; m_encodingType = value; }
90
92
95 inline const Aws::String& GetKeyMarker() const { return m_keyMarker; }
96 inline bool KeyMarkerHasBeenSet() const { return m_keyMarkerHasBeenSet; }
97 template<typename KeyMarkerT = Aws::String>
98 void SetKeyMarker(KeyMarkerT&& value) { m_keyMarkerHasBeenSet = true; m_keyMarker = std::forward<KeyMarkerT>(value); }
99 template<typename KeyMarkerT = Aws::String>
100 ListObjectVersionsRequest& WithKeyMarker(KeyMarkerT&& value) { SetKeyMarker(std::forward<KeyMarkerT>(value)); return *this;}
102
104
113 inline int GetMaxKeys() const { return m_maxKeys; }
114 inline bool MaxKeysHasBeenSet() const { return m_maxKeysHasBeenSet; }
115 inline void SetMaxKeys(int value) { m_maxKeysHasBeenSet = true; m_maxKeys = value; }
116 inline ListObjectVersionsRequest& WithMaxKeys(int value) { SetMaxKeys(value); return *this;}
118
120
128 inline const Aws::String& GetPrefix() const { return m_prefix; }
129 inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; }
130 template<typename PrefixT = Aws::String>
131 void SetPrefix(PrefixT&& value) { m_prefixHasBeenSet = true; m_prefix = std::forward<PrefixT>(value); }
132 template<typename PrefixT = Aws::String>
133 ListObjectVersionsRequest& WithPrefix(PrefixT&& value) { SetPrefix(std::forward<PrefixT>(value)); return *this;}
135
137
140 inline const Aws::String& GetVersionIdMarker() const { return m_versionIdMarker; }
141 inline bool VersionIdMarkerHasBeenSet() const { return m_versionIdMarkerHasBeenSet; }
142 template<typename VersionIdMarkerT = Aws::String>
143 void SetVersionIdMarker(VersionIdMarkerT&& value) { m_versionIdMarkerHasBeenSet = true; m_versionIdMarker = std::forward<VersionIdMarkerT>(value); }
144 template<typename VersionIdMarkerT = Aws::String>
145 ListObjectVersionsRequest& WithVersionIdMarker(VersionIdMarkerT&& value) { SetVersionIdMarker(std::forward<VersionIdMarkerT>(value)); return *this;}
147
149
154 inline const Aws::String& GetExpectedBucketOwner() const { return m_expectedBucketOwner; }
155 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
156 template<typename ExpectedBucketOwnerT = Aws::String>
157 void SetExpectedBucketOwner(ExpectedBucketOwnerT&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::forward<ExpectedBucketOwnerT>(value); }
158 template<typename ExpectedBucketOwnerT = Aws::String>
159 ListObjectVersionsRequest& WithExpectedBucketOwner(ExpectedBucketOwnerT&& value) { SetExpectedBucketOwner(std::forward<ExpectedBucketOwnerT>(value)); return *this;}
161
163
164 inline RequestPayer GetRequestPayer() const { return m_requestPayer; }
165 inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; }
166 inline void SetRequestPayer(RequestPayer value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; }
169
171
175 inline const Aws::Vector<OptionalObjectAttributes>& GetOptionalObjectAttributes() const { return m_optionalObjectAttributes; }
176 inline bool OptionalObjectAttributesHasBeenSet() const { return m_optionalObjectAttributesHasBeenSet; }
177 template<typename OptionalObjectAttributesT = Aws::Vector<OptionalObjectAttributes>>
178 void SetOptionalObjectAttributes(OptionalObjectAttributesT&& value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes = std::forward<OptionalObjectAttributesT>(value); }
179 template<typename OptionalObjectAttributesT = Aws::Vector<OptionalObjectAttributes>>
180 ListObjectVersionsRequest& WithOptionalObjectAttributes(OptionalObjectAttributesT&& value) { SetOptionalObjectAttributes(std::forward<OptionalObjectAttributesT>(value)); return *this;}
181 inline ListObjectVersionsRequest& AddOptionalObjectAttributes(OptionalObjectAttributes value) { m_optionalObjectAttributesHasBeenSet = true; m_optionalObjectAttributes.push_back(value); return *this; }
183
185
186 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const { return m_customizedAccessLogTag; }
187 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
188 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
189 void SetCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::forward<CustomizedAccessLogTagT>(value); }
190 template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>
191 ListObjectVersionsRequest& WithCustomizedAccessLogTag(CustomizedAccessLogTagT&& value) { SetCustomizedAccessLogTag(std::forward<CustomizedAccessLogTagT>(value)); return *this;}
192 template<typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>
193 ListObjectVersionsRequest& AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT&& key, CustomizedAccessLogTagValueT&& value) {
194 m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::forward<CustomizedAccessLogTagKeyT>(key), std::forward<CustomizedAccessLogTagValueT>(value)); return *this;
195 }
197 private:
198
199 Aws::String m_bucket;
200 bool m_bucketHasBeenSet = false;
201
202 Aws::String m_delimiter;
203 bool m_delimiterHasBeenSet = false;
204
205 EncodingType m_encodingType{EncodingType::NOT_SET};
206 bool m_encodingTypeHasBeenSet = false;
207
208 Aws::String m_keyMarker;
209 bool m_keyMarkerHasBeenSet = false;
210
211 int m_maxKeys{0};
212 bool m_maxKeysHasBeenSet = false;
213
214 Aws::String m_prefix;
215 bool m_prefixHasBeenSet = false;
216
217 Aws::String m_versionIdMarker;
218 bool m_versionIdMarkerHasBeenSet = false;
219
220 Aws::String m_expectedBucketOwner;
221 bool m_expectedBucketOwnerHasBeenSet = false;
222
223 RequestPayer m_requestPayer{RequestPayer::NOT_SET};
224 bool m_requestPayerHasBeenSet = false;
225
226 Aws::Vector<OptionalObjectAttributes> m_optionalObjectAttributes;
227 bool m_optionalObjectAttributesHasBeenSet = false;
228
229 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
230 bool m_customizedAccessLogTagHasBeenSet = false;
231 };
232
233} // namespace Model
234} // namespace S3
235} // namespace Aws
AWS_S3_API Aws::String SerializePayload() const override
ListObjectVersionsRequest & WithEncodingType(EncodingType value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
void SetCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
virtual const char * GetServiceRequestName() const override
const Aws::Vector< OptionalObjectAttributes > & GetOptionalObjectAttributes() const
ListObjectVersionsRequest & WithBucket(BucketT &&value)
ListObjectVersionsRequest & WithKeyMarker(KeyMarkerT &&value)
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
void SetExpectedBucketOwner(ExpectedBucketOwnerT &&value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
ListObjectVersionsRequest & WithPrefix(PrefixT &&value)
AWS_S3_API ListObjectVersionsRequest()=default
ListObjectVersionsRequest & AddCustomizedAccessLogTag(CustomizedAccessLogTagKeyT &&key, CustomizedAccessLogTagValueT &&value)
ListObjectVersionsRequest & WithCustomizedAccessLogTag(CustomizedAccessLogTagT &&value)
ListObjectVersionsRequest & WithOptionalObjectAttributes(OptionalObjectAttributesT &&value)
void SetOptionalObjectAttributes(OptionalObjectAttributesT &&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 & WithExpectedBucketOwner(ExpectedBucketOwnerT &&value)
ListObjectVersionsRequest & WithRequestPayer(RequestPayer value)
ListObjectVersionsRequest & AddOptionalObjectAttributes(OptionalObjectAttributes value)
ListObjectVersionsRequest & WithVersionIdMarker(VersionIdMarkerT &&value)
ListObjectVersionsRequest & WithDelimiter(DelimiterT &&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