1 /** 2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 * SPDX-License-Identifier: Apache-2.0. 4 */ 5 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 20 namespace Aws 21 { 22 namespace Http 23 { 24 class URI; 25 } //namespace Http 26 namespace S3 27 { 28 namespace Model 29 { 30 31 /** 32 * <p>Request to filter the contents of an Amazon S3 object based on a simple 33 * Structured Query Language (SQL) statement. In the request, along with the SQL 34 * expression, you must specify a data serialization format (JSON or CSV) of the 35 * object. Amazon S3 uses this to parse object data into records. It returns only 36 * records that match the specified SQL expression. You must also specify the data 37 * serialization format for the response. For more information, see <a 38 * href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html">S3Select 39 * API Documentation</a>.</p><p><h3>See Also:</h3> <a 40 * href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SelectObjectContentRequest">AWS 41 * API Reference</a></p> 42 */ 43 class AWS_S3_API SelectObjectContentRequest : public S3Request 44 { 45 public: 46 SelectObjectContentRequest(); 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. GetServiceRequestName()52 inline virtual const char* GetServiceRequestName() const override { return "SelectObjectContent"; } 53 54 Aws::String SerializePayload() const override; 55 56 void AddQueryStringParameters(Aws::Http::URI& uri) const override; 57 58 Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; 59 60 /** 61 * Underlying Event Stream Decoder. 62 */ GetEventStreamDecoder()63 inline Aws::Utils::Event::EventStreamDecoder& GetEventStreamDecoder() { return m_decoder; } 64 65 /** 66 * Underlying Event Stream Handler which is used to define callback functions. 67 */ GetEventStreamHandler()68 inline const SelectObjectContentHandler& GetEventStreamHandler() const { return m_handler; } 69 70 /** 71 * Underlying Event Stream Handler which is used to define callback functions. 72 */ SetEventStreamHandler(const SelectObjectContentHandler & value)73 inline void SetEventStreamHandler(const SelectObjectContentHandler& value) { m_handler = value; m_decoder.ResetEventStreamHandler(&m_handler); } 74 75 /** 76 * Underlying Event Stream Handler which is used to define callback functions. 77 */ WithEventStreamHandler(const SelectObjectContentHandler & value)78 inline SelectObjectContentRequest& WithEventStreamHandler(const SelectObjectContentHandler& value) { SetEventStreamHandler(value); return *this; } 79 80 81 /** 82 * <p>The S3 bucket.</p> 83 */ GetBucket()84 inline const Aws::String& GetBucket() const{ return m_bucket; } 85 86 /** 87 * <p>The S3 bucket.</p> 88 */ BucketHasBeenSet()89 inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; } 90 91 /** 92 * <p>The S3 bucket.</p> 93 */ SetBucket(const Aws::String & value)94 inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; } 95 96 /** 97 * <p>The S3 bucket.</p> 98 */ SetBucket(Aws::String && value)99 inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); } 100 101 /** 102 * <p>The S3 bucket.</p> 103 */ SetBucket(const char * value)104 inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); } 105 106 /** 107 * <p>The S3 bucket.</p> 108 */ WithBucket(const Aws::String & value)109 inline SelectObjectContentRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;} 110 111 /** 112 * <p>The S3 bucket.</p> 113 */ WithBucket(Aws::String && value)114 inline SelectObjectContentRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;} 115 116 /** 117 * <p>The S3 bucket.</p> 118 */ WithBucket(const char * value)119 inline SelectObjectContentRequest& WithBucket(const char* value) { SetBucket(value); return *this;} 120 121 122 /** 123 * <p>The object key.</p> 124 */ GetKey()125 inline const Aws::String& GetKey() const{ return m_key; } 126 127 /** 128 * <p>The object key.</p> 129 */ KeyHasBeenSet()130 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } 131 132 /** 133 * <p>The object key.</p> 134 */ SetKey(const Aws::String & value)135 inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; } 136 137 /** 138 * <p>The object key.</p> 139 */ SetKey(Aws::String && value)140 inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); } 141 142 /** 143 * <p>The object key.</p> 144 */ SetKey(const char * value)145 inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); } 146 147 /** 148 * <p>The object key.</p> 149 */ WithKey(const Aws::String & value)150 inline SelectObjectContentRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;} 151 152 /** 153 * <p>The object key.</p> 154 */ WithKey(Aws::String && value)155 inline SelectObjectContentRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;} 156 157 /** 158 * <p>The object key.</p> 159 */ WithKey(const char * value)160 inline SelectObjectContentRequest& WithKey(const char* value) { SetKey(value); return *this;} 161 162 163 /** 164 * <p>The SSE Algorithm used to encrypt the object. For more information, see <a 165 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 166 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 167 */ GetSSECustomerAlgorithm()168 inline const Aws::String& GetSSECustomerAlgorithm() const{ return m_sSECustomerAlgorithm; } 169 170 /** 171 * <p>The SSE Algorithm used to encrypt the object. For more information, see <a 172 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 173 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 174 */ SSECustomerAlgorithmHasBeenSet()175 inline bool SSECustomerAlgorithmHasBeenSet() const { return m_sSECustomerAlgorithmHasBeenSet; } 176 177 /** 178 * <p>The SSE Algorithm used to encrypt the object. For more information, see <a 179 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 180 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 181 */ SetSSECustomerAlgorithm(const Aws::String & value)182 inline void SetSSECustomerAlgorithm(const Aws::String& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = value; } 183 184 /** 185 * <p>The SSE Algorithm used to encrypt the object. For more information, see <a 186 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 187 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 188 */ SetSSECustomerAlgorithm(Aws::String && value)189 inline void SetSSECustomerAlgorithm(Aws::String&& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = std::move(value); } 190 191 /** 192 * <p>The SSE Algorithm used to encrypt the object. For more information, see <a 193 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 194 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 195 */ SetSSECustomerAlgorithm(const char * value)196 inline void SetSSECustomerAlgorithm(const char* value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm.assign(value); } 197 198 /** 199 * <p>The SSE Algorithm used to encrypt the object. For more information, see <a 200 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 201 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 202 */ WithSSECustomerAlgorithm(const Aws::String & value)203 inline SelectObjectContentRequest& WithSSECustomerAlgorithm(const Aws::String& value) { SetSSECustomerAlgorithm(value); return *this;} 204 205 /** 206 * <p>The SSE Algorithm used to encrypt the object. For more information, see <a 207 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 208 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 209 */ WithSSECustomerAlgorithm(Aws::String && value)210 inline SelectObjectContentRequest& WithSSECustomerAlgorithm(Aws::String&& value) { SetSSECustomerAlgorithm(std::move(value)); return *this;} 211 212 /** 213 * <p>The SSE Algorithm used to encrypt the object. For more information, see <a 214 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 215 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 216 */ WithSSECustomerAlgorithm(const char * value)217 inline SelectObjectContentRequest& WithSSECustomerAlgorithm(const char* value) { SetSSECustomerAlgorithm(value); return *this;} 218 219 220 /** 221 * <p>The SSE Customer Key. For more information, see <a 222 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 223 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 224 */ GetSSECustomerKey()225 inline const Aws::String& GetSSECustomerKey() const{ return m_sSECustomerKey; } 226 227 /** 228 * <p>The SSE Customer Key. For more information, see <a 229 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 230 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 231 */ SSECustomerKeyHasBeenSet()232 inline bool SSECustomerKeyHasBeenSet() const { return m_sSECustomerKeyHasBeenSet; } 233 234 /** 235 * <p>The SSE Customer Key. For more information, see <a 236 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 237 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 238 */ SetSSECustomerKey(const Aws::String & value)239 inline void SetSSECustomerKey(const Aws::String& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = value; } 240 241 /** 242 * <p>The SSE Customer Key. For more information, see <a 243 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 244 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 245 */ SetSSECustomerKey(Aws::String && value)246 inline void SetSSECustomerKey(Aws::String&& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = std::move(value); } 247 248 /** 249 * <p>The SSE Customer Key. For more information, see <a 250 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 251 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 252 */ SetSSECustomerKey(const char * value)253 inline void SetSSECustomerKey(const char* value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey.assign(value); } 254 255 /** 256 * <p>The SSE Customer Key. For more information, see <a 257 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 258 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 259 */ WithSSECustomerKey(const Aws::String & value)260 inline SelectObjectContentRequest& WithSSECustomerKey(const Aws::String& value) { SetSSECustomerKey(value); return *this;} 261 262 /** 263 * <p>The SSE Customer Key. For more information, see <a 264 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 265 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 266 */ WithSSECustomerKey(Aws::String && value)267 inline SelectObjectContentRequest& WithSSECustomerKey(Aws::String&& value) { SetSSECustomerKey(std::move(value)); return *this;} 268 269 /** 270 * <p>The SSE Customer Key. For more information, see <a 271 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 272 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 273 */ WithSSECustomerKey(const char * value)274 inline SelectObjectContentRequest& WithSSECustomerKey(const char* value) { SetSSECustomerKey(value); return *this;} 275 276 277 /** 278 * <p>The SSE Customer Key MD5. For more information, see <a 279 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 280 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 281 */ GetSSECustomerKeyMD5()282 inline const Aws::String& GetSSECustomerKeyMD5() const{ return m_sSECustomerKeyMD5; } 283 284 /** 285 * <p>The SSE Customer Key MD5. For more information, see <a 286 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 287 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 288 */ SSECustomerKeyMD5HasBeenSet()289 inline bool SSECustomerKeyMD5HasBeenSet() const { return m_sSECustomerKeyMD5HasBeenSet; } 290 291 /** 292 * <p>The SSE Customer Key MD5. For more information, see <a 293 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 294 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 295 */ SetSSECustomerKeyMD5(const Aws::String & value)296 inline void SetSSECustomerKeyMD5(const Aws::String& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = value; } 297 298 /** 299 * <p>The SSE Customer Key MD5. For more information, see <a 300 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 301 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 302 */ SetSSECustomerKeyMD5(Aws::String && value)303 inline void SetSSECustomerKeyMD5(Aws::String&& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = std::move(value); } 304 305 /** 306 * <p>The SSE Customer Key MD5. For more information, see <a 307 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 308 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 309 */ SetSSECustomerKeyMD5(const char * value)310 inline void SetSSECustomerKeyMD5(const char* value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5.assign(value); } 311 312 /** 313 * <p>The SSE Customer Key MD5. For more information, see <a 314 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 315 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 316 */ WithSSECustomerKeyMD5(const Aws::String & value)317 inline SelectObjectContentRequest& WithSSECustomerKeyMD5(const Aws::String& value) { SetSSECustomerKeyMD5(value); return *this;} 318 319 /** 320 * <p>The SSE Customer Key MD5. For more information, see <a 321 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 322 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 323 */ WithSSECustomerKeyMD5(Aws::String && value)324 inline SelectObjectContentRequest& WithSSECustomerKeyMD5(Aws::String&& value) { SetSSECustomerKeyMD5(std::move(value)); return *this;} 325 326 /** 327 * <p>The SSE Customer Key MD5. For more information, see <a 328 * href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side 329 * Encryption (Using Customer-Provided Encryption Keys</a>. </p> 330 */ WithSSECustomerKeyMD5(const char * value)331 inline SelectObjectContentRequest& WithSSECustomerKeyMD5(const char* value) { SetSSECustomerKeyMD5(value); return *this;} 332 333 334 /** 335 * <p>The expression that is used to query the object.</p> 336 */ GetExpression()337 inline const Aws::String& GetExpression() const{ return m_expression; } 338 339 /** 340 * <p>The expression that is used to query the object.</p> 341 */ ExpressionHasBeenSet()342 inline bool ExpressionHasBeenSet() const { return m_expressionHasBeenSet; } 343 344 /** 345 * <p>The expression that is used to query the object.</p> 346 */ SetExpression(const Aws::String & value)347 inline void SetExpression(const Aws::String& value) { m_expressionHasBeenSet = true; m_expression = value; } 348 349 /** 350 * <p>The expression that is used to query the object.</p> 351 */ SetExpression(Aws::String && value)352 inline void SetExpression(Aws::String&& value) { m_expressionHasBeenSet = true; m_expression = std::move(value); } 353 354 /** 355 * <p>The expression that is used to query the object.</p> 356 */ SetExpression(const char * value)357 inline void SetExpression(const char* value) { m_expressionHasBeenSet = true; m_expression.assign(value); } 358 359 /** 360 * <p>The expression that is used to query the object.</p> 361 */ WithExpression(const Aws::String & value)362 inline SelectObjectContentRequest& WithExpression(const Aws::String& value) { SetExpression(value); return *this;} 363 364 /** 365 * <p>The expression that is used to query the object.</p> 366 */ WithExpression(Aws::String && value)367 inline SelectObjectContentRequest& WithExpression(Aws::String&& value) { SetExpression(std::move(value)); return *this;} 368 369 /** 370 * <p>The expression that is used to query the object.</p> 371 */ WithExpression(const char * value)372 inline SelectObjectContentRequest& WithExpression(const char* value) { SetExpression(value); return *this;} 373 374 375 /** 376 * <p>The type of the provided expression (for example, SQL).</p> 377 */ GetExpressionType()378 inline const ExpressionType& GetExpressionType() const{ return m_expressionType; } 379 380 /** 381 * <p>The type of the provided expression (for example, SQL).</p> 382 */ ExpressionTypeHasBeenSet()383 inline bool ExpressionTypeHasBeenSet() const { return m_expressionTypeHasBeenSet; } 384 385 /** 386 * <p>The type of the provided expression (for example, SQL).</p> 387 */ SetExpressionType(const ExpressionType & value)388 inline void SetExpressionType(const ExpressionType& value) { m_expressionTypeHasBeenSet = true; m_expressionType = value; } 389 390 /** 391 * <p>The type of the provided expression (for example, SQL).</p> 392 */ SetExpressionType(ExpressionType && value)393 inline void SetExpressionType(ExpressionType&& value) { m_expressionTypeHasBeenSet = true; m_expressionType = std::move(value); } 394 395 /** 396 * <p>The type of the provided expression (for example, SQL).</p> 397 */ WithExpressionType(const ExpressionType & value)398 inline SelectObjectContentRequest& WithExpressionType(const ExpressionType& value) { SetExpressionType(value); return *this;} 399 400 /** 401 * <p>The type of the provided expression (for example, SQL).</p> 402 */ WithExpressionType(ExpressionType && value)403 inline SelectObjectContentRequest& WithExpressionType(ExpressionType&& value) { SetExpressionType(std::move(value)); return *this;} 404 405 406 /** 407 * <p>Specifies if periodic request progress information should be enabled.</p> 408 */ GetRequestProgress()409 inline const RequestProgress& GetRequestProgress() const{ return m_requestProgress; } 410 411 /** 412 * <p>Specifies if periodic request progress information should be enabled.</p> 413 */ RequestProgressHasBeenSet()414 inline bool RequestProgressHasBeenSet() const { return m_requestProgressHasBeenSet; } 415 416 /** 417 * <p>Specifies if periodic request progress information should be enabled.</p> 418 */ SetRequestProgress(const RequestProgress & value)419 inline void SetRequestProgress(const RequestProgress& value) { m_requestProgressHasBeenSet = true; m_requestProgress = value; } 420 421 /** 422 * <p>Specifies if periodic request progress information should be enabled.</p> 423 */ SetRequestProgress(RequestProgress && value)424 inline void SetRequestProgress(RequestProgress&& value) { m_requestProgressHasBeenSet = true; m_requestProgress = std::move(value); } 425 426 /** 427 * <p>Specifies if periodic request progress information should be enabled.</p> 428 */ WithRequestProgress(const RequestProgress & value)429 inline SelectObjectContentRequest& WithRequestProgress(const RequestProgress& value) { SetRequestProgress(value); return *this;} 430 431 /** 432 * <p>Specifies if periodic request progress information should be enabled.</p> 433 */ WithRequestProgress(RequestProgress && value)434 inline SelectObjectContentRequest& WithRequestProgress(RequestProgress&& value) { SetRequestProgress(std::move(value)); return *this;} 435 436 437 /** 438 * <p>Describes the format of the data in the object that is being queried.</p> 439 */ GetInputSerialization()440 inline const InputSerialization& GetInputSerialization() const{ return m_inputSerialization; } 441 442 /** 443 * <p>Describes the format of the data in the object that is being queried.</p> 444 */ InputSerializationHasBeenSet()445 inline bool InputSerializationHasBeenSet() const { return m_inputSerializationHasBeenSet; } 446 447 /** 448 * <p>Describes the format of the data in the object that is being queried.</p> 449 */ SetInputSerialization(const InputSerialization & value)450 inline void SetInputSerialization(const InputSerialization& value) { m_inputSerializationHasBeenSet = true; m_inputSerialization = value; } 451 452 /** 453 * <p>Describes the format of the data in the object that is being queried.</p> 454 */ SetInputSerialization(InputSerialization && value)455 inline void SetInputSerialization(InputSerialization&& value) { m_inputSerializationHasBeenSet = true; m_inputSerialization = std::move(value); } 456 457 /** 458 * <p>Describes the format of the data in the object that is being queried.</p> 459 */ WithInputSerialization(const InputSerialization & value)460 inline SelectObjectContentRequest& WithInputSerialization(const InputSerialization& value) { SetInputSerialization(value); return *this;} 461 462 /** 463 * <p>Describes the format of the data in the object that is being queried.</p> 464 */ WithInputSerialization(InputSerialization && value)465 inline SelectObjectContentRequest& WithInputSerialization(InputSerialization&& value) { SetInputSerialization(std::move(value)); return *this;} 466 467 468 /** 469 * <p>Describes the format of the data that you want Amazon S3 to return in 470 * response.</p> 471 */ GetOutputSerialization()472 inline const OutputSerialization& GetOutputSerialization() const{ return m_outputSerialization; } 473 474 /** 475 * <p>Describes the format of the data that you want Amazon S3 to return in 476 * response.</p> 477 */ OutputSerializationHasBeenSet()478 inline bool OutputSerializationHasBeenSet() const { return m_outputSerializationHasBeenSet; } 479 480 /** 481 * <p>Describes the format of the data that you want Amazon S3 to return in 482 * response.</p> 483 */ SetOutputSerialization(const OutputSerialization & value)484 inline void SetOutputSerialization(const OutputSerialization& value) { m_outputSerializationHasBeenSet = true; m_outputSerialization = value; } 485 486 /** 487 * <p>Describes the format of the data that you want Amazon S3 to return in 488 * response.</p> 489 */ SetOutputSerialization(OutputSerialization && value)490 inline void SetOutputSerialization(OutputSerialization&& value) { m_outputSerializationHasBeenSet = true; m_outputSerialization = std::move(value); } 491 492 /** 493 * <p>Describes the format of the data that you want Amazon S3 to return in 494 * response.</p> 495 */ WithOutputSerialization(const OutputSerialization & value)496 inline SelectObjectContentRequest& WithOutputSerialization(const OutputSerialization& value) { SetOutputSerialization(value); return *this;} 497 498 /** 499 * <p>Describes the format of the data that you want Amazon S3 to return in 500 * response.</p> 501 */ WithOutputSerialization(OutputSerialization && value)502 inline SelectObjectContentRequest& WithOutputSerialization(OutputSerialization&& value) { SetOutputSerialization(std::move(value)); return *this;} 503 504 505 /** 506 * <p>Specifies the byte range of the object to get the records from. A record is 507 * processed when its first byte is contained by the range. This parameter is 508 * optional, but when specified, it must not be empty. See RFC 2616, Section 509 * 14.35.1 about how to specify the start and end of the range.</p> <p> 510 * <code>ScanRange</code>may be used in the following ways:</p> <ul> <li> <p> 511 * <code><scanrange><start>50</start><end>100</end></scanrange></code> 512 * - process only the records starting between the bytes 50 and 100 (inclusive, 513 * counting from zero)</p> </li> <li> <p> 514 * <code><scanrange><start>50</start></scanrange></code> - 515 * process only the records starting after the byte 50</p> </li> <li> <p> 516 * <code><scanrange><end>50</end></scanrange></code> - 517 * process only the records within the last 50 bytes of the file.</p> </li> </ul> 518 */ GetScanRange()519 inline const ScanRange& GetScanRange() const{ return m_scanRange; } 520 521 /** 522 * <p>Specifies the byte range of the object to get the records from. A record is 523 * processed when its first byte is contained by the range. This parameter is 524 * optional, but when specified, it must not be empty. See RFC 2616, Section 525 * 14.35.1 about how to specify the start and end of the range.</p> <p> 526 * <code>ScanRange</code>may be used in the following ways:</p> <ul> <li> <p> 527 * <code><scanrange><start>50</start><end>100</end></scanrange></code> 528 * - process only the records starting between the bytes 50 and 100 (inclusive, 529 * counting from zero)</p> </li> <li> <p> 530 * <code><scanrange><start>50</start></scanrange></code> - 531 * process only the records starting after the byte 50</p> </li> <li> <p> 532 * <code><scanrange><end>50</end></scanrange></code> - 533 * process only the records within the last 50 bytes of the file.</p> </li> </ul> 534 */ ScanRangeHasBeenSet()535 inline bool ScanRangeHasBeenSet() const { return m_scanRangeHasBeenSet; } 536 537 /** 538 * <p>Specifies the byte range of the object to get the records from. A record is 539 * processed when its first byte is contained by the range. This parameter is 540 * optional, but when specified, it must not be empty. See RFC 2616, Section 541 * 14.35.1 about how to specify the start and end of the range.</p> <p> 542 * <code>ScanRange</code>may be used in the following ways:</p> <ul> <li> <p> 543 * <code><scanrange><start>50</start><end>100</end></scanrange></code> 544 * - process only the records starting between the bytes 50 and 100 (inclusive, 545 * counting from zero)</p> </li> <li> <p> 546 * <code><scanrange><start>50</start></scanrange></code> - 547 * process only the records starting after the byte 50</p> </li> <li> <p> 548 * <code><scanrange><end>50</end></scanrange></code> - 549 * process only the records within the last 50 bytes of the file.</p> </li> </ul> 550 */ SetScanRange(const ScanRange & value)551 inline void SetScanRange(const ScanRange& value) { m_scanRangeHasBeenSet = true; m_scanRange = value; } 552 553 /** 554 * <p>Specifies the byte range of the object to get the records from. A record is 555 * processed when its first byte is contained by the range. This parameter is 556 * optional, but when specified, it must not be empty. See RFC 2616, Section 557 * 14.35.1 about how to specify the start and end of the range.</p> <p> 558 * <code>ScanRange</code>may be used in the following ways:</p> <ul> <li> <p> 559 * <code><scanrange><start>50</start><end>100</end></scanrange></code> 560 * - process only the records starting between the bytes 50 and 100 (inclusive, 561 * counting from zero)</p> </li> <li> <p> 562 * <code><scanrange><start>50</start></scanrange></code> - 563 * process only the records starting after the byte 50</p> </li> <li> <p> 564 * <code><scanrange><end>50</end></scanrange></code> - 565 * process only the records within the last 50 bytes of the file.</p> </li> </ul> 566 */ SetScanRange(ScanRange && value)567 inline void SetScanRange(ScanRange&& value) { m_scanRangeHasBeenSet = true; m_scanRange = std::move(value); } 568 569 /** 570 * <p>Specifies the byte range of the object to get the records from. A record is 571 * processed when its first byte is contained by the range. This parameter is 572 * optional, but when specified, it must not be empty. See RFC 2616, Section 573 * 14.35.1 about how to specify the start and end of the range.</p> <p> 574 * <code>ScanRange</code>may be used in the following ways:</p> <ul> <li> <p> 575 * <code><scanrange><start>50</start><end>100</end></scanrange></code> 576 * - process only the records starting between the bytes 50 and 100 (inclusive, 577 * counting from zero)</p> </li> <li> <p> 578 * <code><scanrange><start>50</start></scanrange></code> - 579 * process only the records starting after the byte 50</p> </li> <li> <p> 580 * <code><scanrange><end>50</end></scanrange></code> - 581 * process only the records within the last 50 bytes of the file.</p> </li> </ul> 582 */ WithScanRange(const ScanRange & value)583 inline SelectObjectContentRequest& WithScanRange(const ScanRange& value) { SetScanRange(value); return *this;} 584 585 /** 586 * <p>Specifies the byte range of the object to get the records from. A record is 587 * processed when its first byte is contained by the range. This parameter is 588 * optional, but when specified, it must not be empty. See RFC 2616, Section 589 * 14.35.1 about how to specify the start and end of the range.</p> <p> 590 * <code>ScanRange</code>may be used in the following ways:</p> <ul> <li> <p> 591 * <code><scanrange><start>50</start><end>100</end></scanrange></code> 592 * - process only the records starting between the bytes 50 and 100 (inclusive, 593 * counting from zero)</p> </li> <li> <p> 594 * <code><scanrange><start>50</start></scanrange></code> - 595 * process only the records starting after the byte 50</p> </li> <li> <p> 596 * <code><scanrange><end>50</end></scanrange></code> - 597 * process only the records within the last 50 bytes of the file.</p> </li> </ul> 598 */ WithScanRange(ScanRange && value)599 inline SelectObjectContentRequest& WithScanRange(ScanRange&& value) { SetScanRange(std::move(value)); return *this;} 600 601 602 /** 603 * <p>The account ID of the expected bucket owner. If the bucket is owned by a 604 * different account, the request will fail with an HTTP <code>403 (Access 605 * Denied)</code> error.</p> 606 */ GetExpectedBucketOwner()607 inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; } 608 609 /** 610 * <p>The account ID of the expected bucket owner. If the bucket is owned by a 611 * different account, the request will fail with an HTTP <code>403 (Access 612 * Denied)</code> error.</p> 613 */ ExpectedBucketOwnerHasBeenSet()614 inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; } 615 616 /** 617 * <p>The account ID of the expected bucket owner. If the bucket is owned by a 618 * different account, the request will fail with an HTTP <code>403 (Access 619 * Denied)</code> error.</p> 620 */ SetExpectedBucketOwner(const Aws::String & value)621 inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; } 622 623 /** 624 * <p>The account ID of the expected bucket owner. If the bucket is owned by a 625 * different account, the request will fail with an HTTP <code>403 (Access 626 * Denied)</code> error.</p> 627 */ SetExpectedBucketOwner(Aws::String && value)628 inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); } 629 630 /** 631 * <p>The account ID of the expected bucket owner. If the bucket is owned by a 632 * different account, the request will fail with an HTTP <code>403 (Access 633 * Denied)</code> error.</p> 634 */ SetExpectedBucketOwner(const char * value)635 inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); } 636 637 /** 638 * <p>The account ID of the expected bucket owner. If the bucket is owned by a 639 * different account, the request will fail with an HTTP <code>403 (Access 640 * Denied)</code> error.</p> 641 */ WithExpectedBucketOwner(const Aws::String & value)642 inline SelectObjectContentRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;} 643 644 /** 645 * <p>The account ID of the expected bucket owner. If the bucket is owned by a 646 * different account, the request will fail with an HTTP <code>403 (Access 647 * Denied)</code> error.</p> 648 */ WithExpectedBucketOwner(Aws::String && value)649 inline SelectObjectContentRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;} 650 651 /** 652 * <p>The account ID of the expected bucket owner. If the bucket is owned by a 653 * different account, the request will fail with an HTTP <code>403 (Access 654 * Denied)</code> error.</p> 655 */ WithExpectedBucketOwner(const char * value)656 inline SelectObjectContentRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;} 657 658 659 GetCustomizedAccessLogTag()660 inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; } 661 662 CustomizedAccessLogTagHasBeenSet()663 inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; } 664 665 SetCustomizedAccessLogTag(const Aws::Map<Aws::String,Aws::String> & value)666 inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; } 667 668 SetCustomizedAccessLogTag(Aws::Map<Aws::String,Aws::String> && value)669 inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); } 670 671 WithCustomizedAccessLogTag(const Aws::Map<Aws::String,Aws::String> & value)672 inline SelectObjectContentRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;} 673 674 WithCustomizedAccessLogTag(Aws::Map<Aws::String,Aws::String> && value)675 inline SelectObjectContentRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;} 676 677 AddCustomizedAccessLogTag(const Aws::String & key,const Aws::String & value)678 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } 679 680 AddCustomizedAccessLogTag(Aws::String && key,const Aws::String & value)681 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } 682 683 AddCustomizedAccessLogTag(const Aws::String & key,Aws::String && value)684 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } 685 686 AddCustomizedAccessLogTag(Aws::String && key,Aws::String && value)687 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; } 688 689 AddCustomizedAccessLogTag(const char * key,Aws::String && value)690 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } 691 692 AddCustomizedAccessLogTag(Aws::String && key,const char * value)693 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } 694 695 AddCustomizedAccessLogTag(const char * key,const char * value)696 inline SelectObjectContentRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } 697 698 private: 699 700 Aws::String m_bucket; 701 bool m_bucketHasBeenSet; 702 703 Aws::String m_key; 704 bool m_keyHasBeenSet; 705 706 Aws::String m_sSECustomerAlgorithm; 707 bool m_sSECustomerAlgorithmHasBeenSet; 708 709 Aws::String m_sSECustomerKey; 710 bool m_sSECustomerKeyHasBeenSet; 711 712 Aws::String m_sSECustomerKeyMD5; 713 bool m_sSECustomerKeyMD5HasBeenSet; 714 715 Aws::String m_expression; 716 bool m_expressionHasBeenSet; 717 718 ExpressionType m_expressionType; 719 bool m_expressionTypeHasBeenSet; 720 721 RequestProgress m_requestProgress; 722 bool m_requestProgressHasBeenSet; 723 724 InputSerialization m_inputSerialization; 725 bool m_inputSerializationHasBeenSet; 726 727 OutputSerialization m_outputSerialization; 728 bool m_outputSerializationHasBeenSet; 729 730 ScanRange m_scanRange; 731 bool m_scanRangeHasBeenSet; 732 733 Aws::String m_expectedBucketOwner; 734 bool m_expectedBucketOwnerHasBeenSet; 735 736 Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag; 737 bool m_customizedAccessLogTagHasBeenSet; 738 Aws::Utils::Event::EventStreamDecoder m_decoder; 739 SelectObjectContentHandler m_handler; 740 741 }; 742 743 } // namespace Model 744 } // namespace S3 745 } // namespace Aws 746