AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
SelectObjectContentRequest.h
1
6#pragma once
7#include <aws/s3/S3_EXPORTS.h>
8#include <aws/s3/S3Request.h>
9#include <aws/s3/model/SelectObjectContentHandler.h>
10#include <aws/core/utils/event/EventStreamDecoder.h>
11#include <aws/core/utils/memory/stl/AWSString.h>
12#include <aws/s3/model/ExpressionType.h>
13#include <aws/s3/model/RequestProgress.h>
14#include <aws/s3/model/InputSerialization.h>
15#include <aws/s3/model/OutputSerialization.h>
16#include <aws/s3/model/ScanRange.h>
17#include <aws/core/utils/memory/stl/AWSMap.h>
18#include <utility>
19
20namespace Aws
21{
22namespace Http
23{
24 class URI;
25} //namespace Http
26namespace S3
27{
28namespace Model
29{
30
44 {
45 public:
47
48 // Service request name is the Operation name which will send this request out,
49 // each operation should has unique request name, so that we can get operation's name from this request.
50 // Note: this is not true for response, multiple operations may have the same response name,
51 // so we can not get operation's name from response.
52 inline virtual const char* GetServiceRequestName() const override { return "SelectObjectContent"; }
53
54 AWS_S3_API Aws::String SerializePayload() const override;
55
56 AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
57
59
60 AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override;
65
69 inline const SelectObjectContentHandler& GetEventStreamHandler() const { return m_handler; }
70
74 inline void SetEventStreamHandler(const SelectObjectContentHandler& value) { m_handler = value; m_decoder.ResetEventStreamHandler(&m_handler); }
75
80
84 AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
85
87
90 inline const Aws::String& GetBucket() const{ return m_bucket; }
91 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
92 inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
93 inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
94 inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
95 inline SelectObjectContentRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
96 inline SelectObjectContentRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
97 inline SelectObjectContentRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
99
101
104 inline const Aws::String& GetKey() const{ return m_key; }
105 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
106 inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; }
107 inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); }
108 inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); }
109 inline SelectObjectContentRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;}
110 inline SelectObjectContentRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;}
111 inline SelectObjectContentRequest& WithKey(const char* value) { SetKey(value); return *this;}
113
115
122 inline const Aws::String& GetSSECustomerAlgorithm() const{ return m_sSECustomerAlgorithm; }
123 inline bool SSECustomerAlgorithmHasBeenSet() const { return m_sSECustomerAlgorithmHasBeenSet; }
124 inline void SetSSECustomerAlgorithm(const Aws::String& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = value; }
125 inline void SetSSECustomerAlgorithm(Aws::String&& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = std::move(value); }
126 inline void SetSSECustomerAlgorithm(const char* value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm.assign(value); }
129 inline SelectObjectContentRequest& WithSSECustomerAlgorithm(const char* value) { SetSSECustomerAlgorithm(value); return *this;}
131
133
140 inline const Aws::String& GetSSECustomerKey() const{ return m_sSECustomerKey; }
141 inline bool SSECustomerKeyHasBeenSet() const { return m_sSECustomerKeyHasBeenSet; }
142 inline void SetSSECustomerKey(const Aws::String& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = value; }
143 inline void SetSSECustomerKey(Aws::String&& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = std::move(value); }
144 inline void SetSSECustomerKey(const char* value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey.assign(value); }
145 inline SelectObjectContentRequest& WithSSECustomerKey(const Aws::String& value) { SetSSECustomerKey(value); return *this;}
146 inline SelectObjectContentRequest& WithSSECustomerKey(Aws::String&& value) { SetSSECustomerKey(std::move(value)); return *this;}
147 inline SelectObjectContentRequest& WithSSECustomerKey(const char* value) { SetSSECustomerKey(value); return *this;}
149
151
158 inline const Aws::String& GetSSECustomerKeyMD5() const{ return m_sSECustomerKeyMD5; }
159 inline bool SSECustomerKeyMD5HasBeenSet() const { return m_sSECustomerKeyMD5HasBeenSet; }
160 inline void SetSSECustomerKeyMD5(const Aws::String& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = value; }
161 inline void SetSSECustomerKeyMD5(Aws::String&& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = std::move(value); }
162 inline void SetSSECustomerKeyMD5(const char* value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5.assign(value); }
164 inline SelectObjectContentRequest& WithSSECustomerKeyMD5(Aws::String&& value) { SetSSECustomerKeyMD5(std::move(value)); return *this;}
165 inline SelectObjectContentRequest& WithSSECustomerKeyMD5(const char* value) { SetSSECustomerKeyMD5(value); return *this;}
167
169
172 inline const Aws::String& GetExpression() const{ return m_expression; }
173 inline bool ExpressionHasBeenSet() const { return m_expressionHasBeenSet; }
174 inline void SetExpression(const Aws::String& value) { m_expressionHasBeenSet = true; m_expression = value; }
175 inline void SetExpression(Aws::String&& value) { m_expressionHasBeenSet = true; m_expression = std::move(value); }
176 inline void SetExpression(const char* value) { m_expressionHasBeenSet = true; m_expression.assign(value); }
177 inline SelectObjectContentRequest& WithExpression(const Aws::String& value) { SetExpression(value); return *this;}
178 inline SelectObjectContentRequest& WithExpression(Aws::String&& value) { SetExpression(std::move(value)); return *this;}
179 inline SelectObjectContentRequest& WithExpression(const char* value) { SetExpression(value); return *this;}
181
183
186 inline const ExpressionType& GetExpressionType() const{ return m_expressionType; }
187 inline bool ExpressionTypeHasBeenSet() const { return m_expressionTypeHasBeenSet; }
188 inline void SetExpressionType(const ExpressionType& value) { m_expressionTypeHasBeenSet = true; m_expressionType = value; }
189 inline void SetExpressionType(ExpressionType&& value) { m_expressionTypeHasBeenSet = true; m_expressionType = std::move(value); }
191 inline SelectObjectContentRequest& WithExpressionType(ExpressionType&& value) { SetExpressionType(std::move(value)); return *this;}
193
195
198 inline const RequestProgress& GetRequestProgress() const{ return m_requestProgress; }
199 inline bool RequestProgressHasBeenSet() const { return m_requestProgressHasBeenSet; }
200 inline void SetRequestProgress(const RequestProgress& value) { m_requestProgressHasBeenSet = true; m_requestProgress = value; }
201 inline void SetRequestProgress(RequestProgress&& value) { m_requestProgressHasBeenSet = true; m_requestProgress = std::move(value); }
203 inline SelectObjectContentRequest& WithRequestProgress(RequestProgress&& value) { SetRequestProgress(std::move(value)); return *this;}
205
207
210 inline const InputSerialization& GetInputSerialization() const{ return m_inputSerialization; }
211 inline bool InputSerializationHasBeenSet() const { return m_inputSerializationHasBeenSet; }
212 inline void SetInputSerialization(const InputSerialization& value) { m_inputSerializationHasBeenSet = true; m_inputSerialization = value; }
213 inline void SetInputSerialization(InputSerialization&& value) { m_inputSerializationHasBeenSet = true; m_inputSerialization = std::move(value); }
217
219
223 inline const OutputSerialization& GetOutputSerialization() const{ return m_outputSerialization; }
224 inline bool OutputSerializationHasBeenSet() const { return m_outputSerializationHasBeenSet; }
225 inline void SetOutputSerialization(const OutputSerialization& value) { m_outputSerializationHasBeenSet = true; m_outputSerialization = value; }
226 inline void SetOutputSerialization(OutputSerialization&& value) { m_outputSerializationHasBeenSet = true; m_outputSerialization = std::move(value); }
230
232
246 inline const ScanRange& GetScanRange() const{ return m_scanRange; }
247 inline bool ScanRangeHasBeenSet() const { return m_scanRangeHasBeenSet; }
248 inline void SetScanRange(const ScanRange& value) { m_scanRangeHasBeenSet = true; m_scanRange = value; }
249 inline void SetScanRange(ScanRange&& value) { m_scanRangeHasBeenSet = true; m_scanRange = std::move(value); }
250 inline SelectObjectContentRequest& WithScanRange(const ScanRange& value) { SetScanRange(value); return *this;}
251 inline SelectObjectContentRequest& WithScanRange(ScanRange&& value) { SetScanRange(std::move(value)); return *this;}
253
255
260 inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
261 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
262 inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
263 inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
264 inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
267 inline SelectObjectContentRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
269
271
272 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
273 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
274 inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
275 inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
278 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
279 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
280 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
281 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
282 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
283 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
284 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
286 private:
287
288 Aws::String m_bucket;
289 bool m_bucketHasBeenSet = false;
290
291 Aws::String m_key;
292 bool m_keyHasBeenSet = false;
293
294 Aws::String m_sSECustomerAlgorithm;
295 bool m_sSECustomerAlgorithmHasBeenSet = false;
296
297 Aws::String m_sSECustomerKey;
298 bool m_sSECustomerKeyHasBeenSet = false;
299
300 Aws::String m_sSECustomerKeyMD5;
301 bool m_sSECustomerKeyMD5HasBeenSet = false;
302
303 Aws::String m_expression;
304 bool m_expressionHasBeenSet = false;
305
306 ExpressionType m_expressionType;
307 bool m_expressionTypeHasBeenSet = false;
308
309 RequestProgress m_requestProgress;
310 bool m_requestProgressHasBeenSet = false;
311
312 InputSerialization m_inputSerialization;
313 bool m_inputSerializationHasBeenSet = false;
314
315 OutputSerialization m_outputSerialization;
316 bool m_outputSerializationHasBeenSet = false;
317
318 ScanRange m_scanRange;
319 bool m_scanRangeHasBeenSet = false;
320
321 Aws::String m_expectedBucketOwner;
322 bool m_expectedBucketOwnerHasBeenSet = false;
323
324 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
325 bool m_customizedAccessLogTagHasBeenSet = false;
328
329 };
330
331} // namespace Model
332} // namespace S3
333} // namespace Aws
SelectObjectContentRequest & WithSSECustomerAlgorithm(Aws::String &&value)
SelectObjectContentRequest & WithSSECustomerKey(const Aws::String &value)
SelectObjectContentRequest & AddCustomizedAccessLogTag(Aws::String &&key, Aws::String &&value)
SelectObjectContentRequest & AddCustomizedAccessLogTag(const char *key, Aws::String &&value)
SelectObjectContentRequest & AddCustomizedAccessLogTag(Aws::String &&key, const Aws::String &value)
SelectObjectContentRequest & WithKey(const Aws::String &value)
SelectObjectContentRequest & WithCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
void SetInputSerialization(const InputSerialization &value)
SelectObjectContentRequest & WithInputSerialization(const InputSerialization &value)
SelectObjectContentRequest & WithExpression(Aws::String &&value)
SelectObjectContentRequest & AddCustomizedAccessLogTag(const Aws::String &key, Aws::String &&value)
SelectObjectContentRequest & WithSSECustomerAlgorithm(const char *value)
SelectObjectContentRequest & WithSSECustomerKeyMD5(const char *value)
const OutputSerialization & GetOutputSerialization() const
virtual const char * GetServiceRequestName() const override
void SetRequestProgress(const RequestProgress &value)
SelectObjectContentRequest & WithExpression(const char *value)
SelectObjectContentRequest & WithExpectedBucketOwner(Aws::String &&value)
SelectObjectContentRequest & WithBucket(Aws::String &&value)
SelectObjectContentRequest & WithInputSerialization(InputSerialization &&value)
SelectObjectContentRequest & WithSSECustomerKeyMD5(const Aws::String &value)
void SetExpressionType(const ExpressionType &value)
SelectObjectContentRequest & WithSSECustomerAlgorithm(const Aws::String &value)
SelectObjectContentRequest & WithOutputSerialization(OutputSerialization &&value)
SelectObjectContentRequest & WithSSECustomerKey(const char *value)
SelectObjectContentRequest & AddCustomizedAccessLogTag(const char *key, const char *value)
SelectObjectContentRequest & WithScanRange(const ScanRange &value)
AWS_S3_API EndpointParameters GetEndpointContextParams() const override
SelectObjectContentRequest & AddCustomizedAccessLogTag(Aws::String &&key, const char *value)
SelectObjectContentRequest & WithExpressionType(const ExpressionType &value)
SelectObjectContentRequest & WithBucket(const Aws::String &value)
void SetCustomizedAccessLogTag(Aws::Map< Aws::String, Aws::String > &&value)
SelectObjectContentRequest & AddCustomizedAccessLogTag(const Aws::String &key, const Aws::String &value)
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag() const
SelectObjectContentRequest & WithKey(Aws::String &&value)
void SetInputSerialization(InputSerialization &&value)
SelectObjectContentRequest & WithSSECustomerKey(Aws::String &&value)
const InputSerialization & GetInputSerialization() const
AWS_S3_API Aws::String SerializePayload() const override
SelectObjectContentRequest & WithExpectedBucketOwner(const char *value)
SelectObjectContentRequest & WithSSECustomerKeyMD5(Aws::String &&value)
SelectObjectContentRequest & WithScanRange(ScanRange &&value)
SelectObjectContentRequest & WithExpectedBucketOwner(const Aws::String &value)
SelectObjectContentRequest & WithRequestProgress(RequestProgress &&value)
SelectObjectContentRequest & WithKey(const char *value)
const SelectObjectContentHandler & GetEventStreamHandler() const
SelectObjectContentRequest & WithEventStreamHandler(const SelectObjectContentHandler &value)
Aws::Utils::Event::EventStreamDecoder & GetEventStreamDecoder()
SelectObjectContentRequest & WithRequestProgress(const RequestProgress &value)
SelectObjectContentRequest & WithOutputSerialization(const OutputSerialization &value)
SelectObjectContentRequest & WithExpressionType(ExpressionType &&value)
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
void SetEventStreamHandler(const SelectObjectContentHandler &value)
void SetOutputSerialization(OutputSerialization &&value)
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override
SelectObjectContentRequest & WithBucket(const char *value)
void SetOutputSerialization(const OutputSerialization &value)
SelectObjectContentRequest & WithExpression(const Aws::String &value)
SelectObjectContentRequest & WithCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
void SetCustomizedAccessLogTag(const Aws::Map< Aws::String, Aws::String > &value)
Aws::Endpoint::EndpointParameters EndpointParameters
Definition S3Request.h:22
void ResetEventStreamHandler(EventStreamHandler *handler)
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