/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace S3Crt { namespace Model { /** *

Request to filter the contents of an Amazon S3 object based on a simple * Structured Query Language (SQL) statement. In the request, along with the SQL * expression, you must specify a data serialization format (JSON or CSV) of the * object. Amazon S3 uses this to parse object data into records. It returns only * records that match the specified SQL expression. You must also specify the data * serialization format for the response. For more information, see S3Select * API Documentation.

*/ class SelectObjectContentRequest : public S3CrtRequest { public: AWS_S3CRT_API SelectObjectContentRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "SelectObjectContent"; } AWS_S3CRT_API Aws::String SerializePayload() const override; AWS_S3CRT_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; AWS_S3CRT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** * Underlying Event Stream Decoder. */ inline Aws::Utils::Event::EventStreamDecoder& GetEventStreamDecoder() { return m_decoder; } /** * Underlying Event Stream Handler which is used to define callback functions. */ inline const SelectObjectContentHandler& GetEventStreamHandler() const { return m_handler; } /** * Underlying Event Stream Handler which is used to define callback functions. */ inline void SetEventStreamHandler(const SelectObjectContentHandler& value) { m_handler = value; m_decoder.ResetEventStreamHandler(&m_handler); } /** * Underlying Event Stream Handler which is used to define callback functions. */ inline SelectObjectContentRequest& WithEventStreamHandler(const SelectObjectContentHandler& value) { SetEventStreamHandler(value); return *this; } /** * Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation. */ AWS_S3CRT_API EndpointParameters GetEndpointContextParams() const override; /** *

The S3 bucket.

*/ inline const Aws::String& GetBucket() const{ return m_bucket; } /** *

The S3 bucket.

*/ inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; } /** *

The S3 bucket.

*/ inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; } /** *

The S3 bucket.

*/ inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); } /** *

The S3 bucket.

*/ inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); } /** *

The S3 bucket.

*/ inline SelectObjectContentRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;} /** *

The S3 bucket.

*/ inline SelectObjectContentRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;} /** *

The S3 bucket.

*/ inline SelectObjectContentRequest& WithBucket(const char* value) { SetBucket(value); return *this;} /** *

The object key.

*/ inline const Aws::String& GetKey() const{ return m_key; } /** *

The object key.

*/ inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } /** *

The object key.

*/ inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; } /** *

The object key.

*/ inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); } /** *

The object key.

*/ inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); } /** *

The object key.

*/ inline SelectObjectContentRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;} /** *

The object key.

*/ inline SelectObjectContentRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;} /** *

The object key.

*/ inline SelectObjectContentRequest& WithKey(const char* value) { SetKey(value); return *this;} /** *

The server-side encryption (SSE) algorithm used to encrypt the object. This * parameter is needed only when the object was created using a checksum algorithm. * For more information, see Protecting * data using SSE-C keys in the Amazon S3 User Guide.

*/ inline const Aws::String& GetSSECustomerAlgorithm() const{ return m_sSECustomerAlgorithm; } /** *

*/ inline bool SSECustomerAlgorithmHasBeenSet() const { return m_sSECustomerAlgorithmHasBeenSet; } /** *

*/ inline void SetSSECustomerAlgorithm(const Aws::String& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = value; } /** *

*/ inline void SetSSECustomerAlgorithm(Aws::String&& value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm = std::move(value); } /** *

*/ inline void SetSSECustomerAlgorithm(const char* value) { m_sSECustomerAlgorithmHasBeenSet = true; m_sSECustomerAlgorithm.assign(value); } /** *

*/ inline SelectObjectContentRequest& WithSSECustomerAlgorithm(const Aws::String& value) { SetSSECustomerAlgorithm(value); return *this;} /** *

*/ inline SelectObjectContentRequest& WithSSECustomerAlgorithm(Aws::String&& value) { SetSSECustomerAlgorithm(std::move(value)); return *this;} /** *

*/ inline SelectObjectContentRequest& WithSSECustomerAlgorithm(const char* value) { SetSSECustomerAlgorithm(value); return *this;} /** *

The server-side encryption (SSE) customer managed key. This parameter is * needed only when the object was created using a checksum algorithm. For more * information, see Protecting * data using SSE-C keys in the Amazon S3 User Guide.

*/ inline const Aws::String& GetSSECustomerKey() const{ return m_sSECustomerKey; } /** *

*/ inline bool SSECustomerKeyHasBeenSet() const { return m_sSECustomerKeyHasBeenSet; } /** *

*/ inline void SetSSECustomerKey(const Aws::String& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = value; } /** *

*/ inline void SetSSECustomerKey(Aws::String&& value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey = std::move(value); } /** *

*/ inline void SetSSECustomerKey(const char* value) { m_sSECustomerKeyHasBeenSet = true; m_sSECustomerKey.assign(value); } /** *

*/ inline SelectObjectContentRequest& WithSSECustomerKey(const Aws::String& value) { SetSSECustomerKey(value); return *this;} /** *

*/ inline SelectObjectContentRequest& WithSSECustomerKey(Aws::String&& value) { SetSSECustomerKey(std::move(value)); return *this;} /** *

*/ inline SelectObjectContentRequest& WithSSECustomerKey(const char* value) { SetSSECustomerKey(value); return *this;} /** *

The MD5 server-side encryption (SSE) customer managed key. This parameter is * needed only when the object was created using a checksum algorithm. For more * information, see Protecting * data using SSE-C keys in the Amazon S3 User Guide.

*/ inline const Aws::String& GetSSECustomerKeyMD5() const{ return m_sSECustomerKeyMD5; } /** *

*/ inline bool SSECustomerKeyMD5HasBeenSet() const { return m_sSECustomerKeyMD5HasBeenSet; } /** *

*/ inline void SetSSECustomerKeyMD5(const Aws::String& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = value; } /** *

*/ inline void SetSSECustomerKeyMD5(Aws::String&& value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5 = std::move(value); } /** *

*/ inline void SetSSECustomerKeyMD5(const char* value) { m_sSECustomerKeyMD5HasBeenSet = true; m_sSECustomerKeyMD5.assign(value); } /** *

*/ inline SelectObjectContentRequest& WithSSECustomerKeyMD5(const Aws::String& value) { SetSSECustomerKeyMD5(value); return *this;} /** *

*/ inline SelectObjectContentRequest& WithSSECustomerKeyMD5(Aws::String&& value) { SetSSECustomerKeyMD5(std::move(value)); return *this;} /** *

*/ inline SelectObjectContentRequest& WithSSECustomerKeyMD5(const char* value) { SetSSECustomerKeyMD5(value); return *this;} /** *

The expression that is used to query the object.

*/ inline const Aws::String& GetExpression() const{ return m_expression; } /** *

The expression that is used to query the object.

*/ inline bool ExpressionHasBeenSet() const { return m_expressionHasBeenSet; } /** *

The expression that is used to query the object.

*/ inline void SetExpression(const Aws::String& value) { m_expressionHasBeenSet = true; m_expression = value; } /** *

The expression that is used to query the object.

*/ inline void SetExpression(Aws::String&& value) { m_expressionHasBeenSet = true; m_expression = std::move(value); } /** *

The expression that is used to query the object.

*/ inline void SetExpression(const char* value) { m_expressionHasBeenSet = true; m_expression.assign(value); } /** *

The expression that is used to query the object.

*/ inline SelectObjectContentRequest& WithExpression(const Aws::String& value) { SetExpression(value); return *this;} /** *

The expression that is used to query the object.

*/ inline SelectObjectContentRequest& WithExpression(Aws::String&& value) { SetExpression(std::move(value)); return *this;} /** *

The expression that is used to query the object.

*/ inline SelectObjectContentRequest& WithExpression(const char* value) { SetExpression(value); return *this;} /** *

The type of the provided expression (for example, SQL).

*/ inline const ExpressionType& GetExpressionType() const{ return m_expressionType; } /** *

The type of the provided expression (for example, SQL).

*/ inline bool ExpressionTypeHasBeenSet() const { return m_expressionTypeHasBeenSet; } /** *

The type of the provided expression (for example, SQL).

*/ inline void SetExpressionType(const ExpressionType& value) { m_expressionTypeHasBeenSet = true; m_expressionType = value; } /** *

The type of the provided expression (for example, SQL).

*/ inline void SetExpressionType(ExpressionType&& value) { m_expressionTypeHasBeenSet = true; m_expressionType = std::move(value); } /** *

The type of the provided expression (for example, SQL).

*/ inline SelectObjectContentRequest& WithExpressionType(const ExpressionType& value) { SetExpressionType(value); return *this;} /** *

The type of the provided expression (for example, SQL).

*/ inline SelectObjectContentRequest& WithExpressionType(ExpressionType&& value) { SetExpressionType(std::move(value)); return *this;} /** *

Specifies if periodic request progress information should be enabled.

*/ inline const RequestProgress& GetRequestProgress() const{ return m_requestProgress; } /** *

Specifies if periodic request progress information should be enabled.

*/ inline bool RequestProgressHasBeenSet() const { return m_requestProgressHasBeenSet; } /** *

Specifies if periodic request progress information should be enabled.

*/ inline void SetRequestProgress(const RequestProgress& value) { m_requestProgressHasBeenSet = true; m_requestProgress = value; } /** *

Specifies if periodic request progress information should be enabled.

*/ inline void SetRequestProgress(RequestProgress&& value) { m_requestProgressHasBeenSet = true; m_requestProgress = std::move(value); } /** *

Specifies if periodic request progress information should be enabled.

*/ inline SelectObjectContentRequest& WithRequestProgress(const RequestProgress& value) { SetRequestProgress(value); return *this;} /** *

Specifies if periodic request progress information should be enabled.

*/ inline SelectObjectContentRequest& WithRequestProgress(RequestProgress&& value) { SetRequestProgress(std::move(value)); return *this;} /** *

Describes the format of the data in the object that is being queried.

*/ inline const InputSerialization& GetInputSerialization() const{ return m_inputSerialization; } /** *

Describes the format of the data in the object that is being queried.

*/ inline bool InputSerializationHasBeenSet() const { return m_inputSerializationHasBeenSet; } /** *

Describes the format of the data in the object that is being queried.

*/ inline void SetInputSerialization(const InputSerialization& value) { m_inputSerializationHasBeenSet = true; m_inputSerialization = value; } /** *

Describes the format of the data in the object that is being queried.

*/ inline void SetInputSerialization(InputSerialization&& value) { m_inputSerializationHasBeenSet = true; m_inputSerialization = std::move(value); } /** *

Describes the format of the data in the object that is being queried.

*/ inline SelectObjectContentRequest& WithInputSerialization(const InputSerialization& value) { SetInputSerialization(value); return *this;} /** *

Describes the format of the data in the object that is being queried.

*/ inline SelectObjectContentRequest& WithInputSerialization(InputSerialization&& value) { SetInputSerialization(std::move(value)); return *this;} /** *

Describes the format of the data that you want Amazon S3 to return in * response.

*/ inline const OutputSerialization& GetOutputSerialization() const{ return m_outputSerialization; } /** *

Describes the format of the data that you want Amazon S3 to return in * response.

*/ inline bool OutputSerializationHasBeenSet() const { return m_outputSerializationHasBeenSet; } /** *

Describes the format of the data that you want Amazon S3 to return in * response.

*/ inline void SetOutputSerialization(const OutputSerialization& value) { m_outputSerializationHasBeenSet = true; m_outputSerialization = value; } /** *

Describes the format of the data that you want Amazon S3 to return in * response.

*/ inline void SetOutputSerialization(OutputSerialization&& value) { m_outputSerializationHasBeenSet = true; m_outputSerialization = std::move(value); } /** *

Describes the format of the data that you want Amazon S3 to return in * response.

*/ inline SelectObjectContentRequest& WithOutputSerialization(const OutputSerialization& value) { SetOutputSerialization(value); return *this;} /** *

Describes the format of the data that you want Amazon S3 to return in * response.

*/ inline SelectObjectContentRequest& WithOutputSerialization(OutputSerialization&& value) { SetOutputSerialization(std::move(value)); return *this;} /** *

Specifies the byte range of the object to get the records from. A record is * processed when its first byte is contained by the range. This parameter is * optional, but when specified, it must not be empty. See RFC 2616, Section * 14.35.1 about how to specify the start and end of the range.

* ScanRangemay be used in the following ways:

* <scanrange><start>50</start><end>100</end></scanrange> * - process only the records starting between the bytes 50 and 100 (inclusive, * counting from zero)
* <scanrange><start>50</start></scanrange> - * process only the records starting after the byte 50
* <scanrange><end>50</end></scanrange> - * process only the records within the last 50 bytes of the file.

*/ inline const ScanRange& GetScanRange() const{ return m_scanRange; } /** *

* ScanRangemay be used in the following ways:

* <scanrange><start>50</start><end>100</end></scanrange> * - process only the records starting between the bytes 50 and 100 (inclusive, * counting from zero)
* <scanrange><start>50</start></scanrange> - * process only the records starting after the byte 50
* <scanrange><end>50</end></scanrange> - * process only the records within the last 50 bytes of the file.

*/ inline bool ScanRangeHasBeenSet() const { return m_scanRangeHasBeenSet; } /** *

* ScanRangemay be used in the following ways:

* <scanrange><start>50</start><end>100</end></scanrange> * - process only the records starting between the bytes 50 and 100 (inclusive, * counting from zero)
* <scanrange><start>50</start></scanrange> - * process only the records starting after the byte 50
* <scanrange><end>50</end></scanrange> - * process only the records within the last 50 bytes of the file.

*/ inline void SetScanRange(const ScanRange& value) { m_scanRangeHasBeenSet = true; m_scanRange = value; } /** *

* ScanRangemay be used in the following ways:

* <scanrange><start>50</start><end>100</end></scanrange> * - process only the records starting between the bytes 50 and 100 (inclusive, * counting from zero)
* <scanrange><start>50</start></scanrange> - * process only the records starting after the byte 50
* <scanrange><end>50</end></scanrange> - * process only the records within the last 50 bytes of the file.

*/ inline void SetScanRange(ScanRange&& value) { m_scanRangeHasBeenSet = true; m_scanRange = std::move(value); } /** *

* ScanRangemay be used in the following ways:

* <scanrange><start>50</start><end>100</end></scanrange> * - process only the records starting between the bytes 50 and 100 (inclusive, * counting from zero)
* <scanrange><start>50</start></scanrange> - * process only the records starting after the byte 50
* <scanrange><end>50</end></scanrange> - * process only the records within the last 50 bytes of the file.

*/ inline SelectObjectContentRequest& WithScanRange(const ScanRange& value) { SetScanRange(value); return *this;} /** *

* ScanRangemay be used in the following ways:

* <scanrange><start>50</start><end>100</end></scanrange> * - process only the records starting between the bytes 50 and 100 (inclusive, * counting from zero)
* <scanrange><start>50</start></scanrange> - * process only the records starting after the byte 50
* <scanrange><end>50</end></scanrange> - * process only the records within the last 50 bytes of the file.

*/ inline SelectObjectContentRequest& WithScanRange(ScanRange&& value) { SetScanRange(std::move(value)); return *this;} /** *