AWS SDK for C++  0.14.3
AWS SDK for C++
ListObjectVersionsResult.h
Go to the documentation of this file.
1 /*
2 * Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License").
5 * You may not use this file except in compliance with the License.
6 * A copy of the License is located at
7 *
8 * http://aws.amazon.com/apache2.0
9 *
10 * or in the "license" file accompanying this file. This file is distributed
11 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12 * express or implied. See the License for the specific language governing
13 * permissions and limitations under the License.
14 */
15 #pragma once
16 #include <aws/s3/S3_EXPORTS.h>
23 
24 namespace Aws
25 {
26 template<typename RESULT_TYPE>
27 class AmazonWebServiceResult;
28 
29 namespace Utils
30 {
31 namespace Xml
32 {
33  class XmlDocument;
34 } // namespace Xml
35 } // namespace Utils
36 namespace S3
37 {
38 namespace Model
39 {
41  {
42  public:
46 
54  inline bool GetIsTruncated() const{ return m_isTruncated; }
55 
63  inline void SetIsTruncated(bool value) { m_isTruncated = value; }
64 
72  inline ListObjectVersionsResult& WithIsTruncated(bool value) { SetIsTruncated(value); return *this;}
73 
77  inline const Aws::String& GetKeyMarker() const{ return m_keyMarker; }
78 
82  inline void SetKeyMarker(const Aws::String& value) { m_keyMarker = value; }
83 
87  inline void SetKeyMarker(Aws::String&& value) { m_keyMarker = value; }
88 
92  inline void SetKeyMarker(const char* value) { m_keyMarker.assign(value); }
93 
97  inline ListObjectVersionsResult& WithKeyMarker(const Aws::String& value) { SetKeyMarker(value); return *this;}
98 
102  inline ListObjectVersionsResult& WithKeyMarker(Aws::String&& value) { SetKeyMarker(value); return *this;}
103 
107  inline ListObjectVersionsResult& WithKeyMarker(const char* value) { SetKeyMarker(value); return *this;}
108 
109 
110  inline const Aws::String& GetVersionIdMarker() const{ return m_versionIdMarker; }
111 
112 
113  inline void SetVersionIdMarker(const Aws::String& value) { m_versionIdMarker = value; }
114 
115 
116  inline void SetVersionIdMarker(Aws::String&& value) { m_versionIdMarker = value; }
117 
118 
119  inline void SetVersionIdMarker(const char* value) { m_versionIdMarker.assign(value); }
120 
121 
122  inline ListObjectVersionsResult& WithVersionIdMarker(const Aws::String& value) { SetVersionIdMarker(value); return *this;}
123 
124 
125  inline ListObjectVersionsResult& WithVersionIdMarker(Aws::String&& value) { SetVersionIdMarker(value); return *this;}
126 
127 
128  inline ListObjectVersionsResult& WithVersionIdMarker(const char* value) { SetVersionIdMarker(value); return *this;}
129 
133  inline const Aws::String& GetNextKeyMarker() const{ return m_nextKeyMarker; }
134 
138  inline void SetNextKeyMarker(const Aws::String& value) { m_nextKeyMarker = value; }
139 
143  inline void SetNextKeyMarker(Aws::String&& value) { m_nextKeyMarker = value; }
144 
148  inline void SetNextKeyMarker(const char* value) { m_nextKeyMarker.assign(value); }
149 
153  inline ListObjectVersionsResult& WithNextKeyMarker(const Aws::String& value) { SetNextKeyMarker(value); return *this;}
154 
158  inline ListObjectVersionsResult& WithNextKeyMarker(Aws::String&& value) { SetNextKeyMarker(value); return *this;}
159 
163  inline ListObjectVersionsResult& WithNextKeyMarker(const char* value) { SetNextKeyMarker(value); return *this;}
164 
168  inline const Aws::String& GetNextVersionIdMarker() const{ return m_nextVersionIdMarker; }
169 
173  inline void SetNextVersionIdMarker(const Aws::String& value) { m_nextVersionIdMarker = value; }
174 
178  inline void SetNextVersionIdMarker(Aws::String&& value) { m_nextVersionIdMarker = value; }
179 
183  inline void SetNextVersionIdMarker(const char* value) { m_nextVersionIdMarker.assign(value); }
184 
188  inline ListObjectVersionsResult& WithNextVersionIdMarker(const Aws::String& value) { SetNextVersionIdMarker(value); return *this;}
189 
193  inline ListObjectVersionsResult& WithNextVersionIdMarker(Aws::String&& value) { SetNextVersionIdMarker(value); return *this;}
194 
198  inline ListObjectVersionsResult& WithNextVersionIdMarker(const char* value) { SetNextVersionIdMarker(value); return *this;}
199 
200 
201  inline const Aws::Vector<ObjectVersion>& GetVersions() const{ return m_versions; }
202 
203 
204  inline void SetVersions(const Aws::Vector<ObjectVersion>& value) { m_versions = value; }
205 
206 
207  inline void SetVersions(Aws::Vector<ObjectVersion>&& value) { m_versions = value; }
208 
209 
210  inline ListObjectVersionsResult& WithVersions(const Aws::Vector<ObjectVersion>& value) { SetVersions(value); return *this;}
211 
212 
213  inline ListObjectVersionsResult& WithVersions(Aws::Vector<ObjectVersion>&& value) { SetVersions(value); return *this;}
214 
215 
216  inline ListObjectVersionsResult& AddVersions(const ObjectVersion& value) { m_versions.push_back(value); return *this; }
217 
218 
219  inline ListObjectVersionsResult& AddVersions(ObjectVersion&& value) { m_versions.push_back(value); return *this; }
220 
221 
222  inline const Aws::Vector<DeleteMarkerEntry>& GetDeleteMarkers() const{ return m_deleteMarkers; }
223 
224 
225  inline void SetDeleteMarkers(const Aws::Vector<DeleteMarkerEntry>& value) { m_deleteMarkers = value; }
226 
227 
228  inline void SetDeleteMarkers(Aws::Vector<DeleteMarkerEntry>&& value) { m_deleteMarkers = value; }
229 
230 
231  inline ListObjectVersionsResult& WithDeleteMarkers(const Aws::Vector<DeleteMarkerEntry>& value) { SetDeleteMarkers(value); return *this;}
232 
233 
234  inline ListObjectVersionsResult& WithDeleteMarkers(Aws::Vector<DeleteMarkerEntry>&& value) { SetDeleteMarkers(value); return *this;}
235 
236 
237  inline ListObjectVersionsResult& AddDeleteMarkers(const DeleteMarkerEntry& value) { m_deleteMarkers.push_back(value); return *this; }
238 
239 
240  inline ListObjectVersionsResult& AddDeleteMarkers(DeleteMarkerEntry&& value) { m_deleteMarkers.push_back(value); return *this; }
241 
242 
243  inline const Aws::String& GetName() const{ return m_name; }
244 
245 
246  inline void SetName(const Aws::String& value) { m_name = value; }
247 
248 
249  inline void SetName(Aws::String&& value) { m_name = value; }
250 
251 
252  inline void SetName(const char* value) { m_name.assign(value); }
253 
254 
255  inline ListObjectVersionsResult& WithName(const Aws::String& value) { SetName(value); return *this;}
256 
257 
258  inline ListObjectVersionsResult& WithName(Aws::String&& value) { SetName(value); return *this;}
259 
260 
261  inline ListObjectVersionsResult& WithName(const char* value) { SetName(value); return *this;}
262 
263 
264  inline const Aws::String& GetPrefix() const{ return m_prefix; }
265 
266 
267  inline void SetPrefix(const Aws::String& value) { m_prefix = value; }
268 
269 
270  inline void SetPrefix(Aws::String&& value) { m_prefix = value; }
271 
272 
273  inline void SetPrefix(const char* value) { m_prefix.assign(value); }
274 
275 
276  inline ListObjectVersionsResult& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;}
277 
278 
279  inline ListObjectVersionsResult& WithPrefix(Aws::String&& value) { SetPrefix(value); return *this;}
280 
281 
282  inline ListObjectVersionsResult& WithPrefix(const char* value) { SetPrefix(value); return *this;}
283 
284 
285  inline const Aws::String& GetDelimiter() const{ return m_delimiter; }
286 
287 
288  inline void SetDelimiter(const Aws::String& value) { m_delimiter = value; }
289 
290 
291  inline void SetDelimiter(Aws::String&& value) { m_delimiter = value; }
292 
293 
294  inline void SetDelimiter(const char* value) { m_delimiter.assign(value); }
295 
296 
297  inline ListObjectVersionsResult& WithDelimiter(const Aws::String& value) { SetDelimiter(value); return *this;}
298 
299 
300  inline ListObjectVersionsResult& WithDelimiter(Aws::String&& value) { SetDelimiter(value); return *this;}
301 
302 
303  inline ListObjectVersionsResult& WithDelimiter(const char* value) { SetDelimiter(value); return *this;}
304 
305 
306  inline int GetMaxKeys() const{ return m_maxKeys; }
307 
308 
309  inline void SetMaxKeys(int value) { m_maxKeys = value; }
310 
311 
312  inline ListObjectVersionsResult& WithMaxKeys(int value) { SetMaxKeys(value); return *this;}
313 
314 
315  inline const Aws::Vector<CommonPrefix>& GetCommonPrefixes() const{ return m_commonPrefixes; }
316 
317 
318  inline void SetCommonPrefixes(const Aws::Vector<CommonPrefix>& value) { m_commonPrefixes = value; }
319 
320 
321  inline void SetCommonPrefixes(Aws::Vector<CommonPrefix>&& value) { m_commonPrefixes = value; }
322 
323 
324  inline ListObjectVersionsResult& WithCommonPrefixes(const Aws::Vector<CommonPrefix>& value) { SetCommonPrefixes(value); return *this;}
325 
326 
327  inline ListObjectVersionsResult& WithCommonPrefixes(Aws::Vector<CommonPrefix>&& value) { SetCommonPrefixes(value); return *this;}
328 
329 
330  inline ListObjectVersionsResult& AddCommonPrefixes(const CommonPrefix& value) { m_commonPrefixes.push_back(value); return *this; }
331 
332 
333  inline ListObjectVersionsResult& AddCommonPrefixes(CommonPrefix&& value) { m_commonPrefixes.push_back(value); return *this; }
334 
338  inline const EncodingType& GetEncodingType() const{ return m_encodingType; }
339 
343  inline void SetEncodingType(const EncodingType& value) { m_encodingType = value; }
344 
348  inline void SetEncodingType(EncodingType&& value) { m_encodingType = value; }
349 
353  inline ListObjectVersionsResult& WithEncodingType(const EncodingType& value) { SetEncodingType(value); return *this;}
354 
358  inline ListObjectVersionsResult& WithEncodingType(EncodingType&& value) { SetEncodingType(value); return *this;}
359 
360  private:
361  bool m_isTruncated;
362  Aws::String m_keyMarker;
363  Aws::String m_versionIdMarker;
364  Aws::String m_nextKeyMarker;
365  Aws::String m_nextVersionIdMarker;
366  Aws::Vector<ObjectVersion> m_versions;
367  Aws::Vector<DeleteMarkerEntry> m_deleteMarkers;
368  Aws::String m_name;
369  Aws::String m_prefix;
370  Aws::String m_delimiter;
371  int m_maxKeys;
372  Aws::Vector<CommonPrefix> m_commonPrefixes;
373  EncodingType m_encodingType;
374  };
375 
376 } // namespace Model
377 } // namespace S3
378 } // namespace Aws
ListObjectVersionsResult & WithVersionIdMarker(const Aws::String &value)
ListObjectVersionsResult & WithDeleteMarkers(Aws::Vector< DeleteMarkerEntry > &&value)
ListObjectVersionsResult & AddVersions(ObjectVersion &&value)
void SetVersions(Aws::Vector< ObjectVersion > &&value)
ListObjectVersionsResult & WithKeyMarker(const Aws::String &value)
ListObjectVersionsResult & WithNextKeyMarker(const char *value)
ListObjectVersionsResult & AddCommonPrefixes(CommonPrefix &&value)
ListObjectVersionsResult & WithVersions(Aws::Vector< ObjectVersion > &&value)
ListObjectVersionsResult & AddDeleteMarkers(DeleteMarkerEntry &&value)
void SetEncodingType(const EncodingType &value)
ListObjectVersionsResult & WithName(Aws::String &&value)
void SetVersions(const Aws::Vector< ObjectVersion > &value)
ListObjectVersionsResult & WithDelimiter(const Aws::String &value)
ListObjectVersionsResult & WithMaxKeys(int value)
ListObjectVersionsResult & WithPrefix(Aws::String &&value)
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:27
ListObjectVersionsResult & WithNextVersionIdMarker(Aws::String &&value)
void SetNextVersionIdMarker(const Aws::String &value)
#define AWS_S3_API
Definition: S3_EXPORTS.h:37
ListObjectVersionsResult & WithKeyMarker(const char *value)
ListObjectVersionsResult & WithVersionIdMarker(Aws::String &&value)
void SetNextKeyMarker(const Aws::String &value)
ListObjectVersionsResult & WithVersionIdMarker(const char *value)
ListObjectVersionsResult & WithPrefix(const char *value)
ListObjectVersionsResult & WithDelimiter(Aws::String &&value)
ListObjectVersionsResult & WithCommonPrefixes(Aws::Vector< CommonPrefix > &&value)
ListObjectVersionsResult & AddCommonPrefixes(const CommonPrefix &value)
ListObjectVersionsResult & WithNextKeyMarker(const Aws::String &value)
ListObjectVersionsResult & WithName(const char *value)
const Aws::Vector< ObjectVersion > & GetVersions() const
void SetCommonPrefixes(const Aws::Vector< CommonPrefix > &value)
ListObjectVersionsResult & WithName(const Aws::String &value)
ListObjectVersionsResult & WithEncodingType(const EncodingType &value)
ListObjectVersionsResult & WithCommonPrefixes(const Aws::Vector< CommonPrefix > &value)
ListObjectVersionsResult & WithKeyMarker(Aws::String &&value)
ListObjectVersionsResult & WithDeleteMarkers(const Aws::Vector< DeleteMarkerEntry > &value)
ListObjectVersionsResult & WithVersions(const Aws::Vector< ObjectVersion > &value)
ListObjectVersionsResult & WithDelimiter(const char *value)
const Aws::Vector< CommonPrefix > & GetCommonPrefixes() const
void SetDeleteMarkers(const Aws::Vector< DeleteMarkerEntry > &value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
const Aws::String & GetNextVersionIdMarker() const
ListObjectVersionsResult & WithPrefix(const Aws::String &value)
ListObjectVersionsResult & WithNextVersionIdMarker(const char *value)
void SetVersionIdMarker(const Aws::String &value)
ListObjectVersionsResult & AddDeleteMarkers(const DeleteMarkerEntry &value)
ListObjectVersionsResult & WithIsTruncated(bool value)
ListObjectVersionsResult & WithNextVersionIdMarker(const Aws::String &value)
ListObjectVersionsResult & WithNextKeyMarker(Aws::String &&value)
const Aws::Vector< DeleteMarkerEntry > & GetDeleteMarkers() const
void SetDeleteMarkers(Aws::Vector< DeleteMarkerEntry > &&value)
ListObjectVersionsResult & AddVersions(const ObjectVersion &value)
JSON (JavaScript Object Notation).
void SetCommonPrefixes(Aws::Vector< CommonPrefix > &&value)
ListObjectVersionsResult & WithEncodingType(EncodingType &&value)