AWS SDK for C++  1.8.22
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3::Model::SelectObjectContentRequest Class Reference

#include <SelectObjectContentRequest.h>

+ Inheritance diagram for Aws::S3::Model::SelectObjectContentRequest:

Public Member Functions

 SelectObjectContentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
Aws::Utils::Event::EventStreamDecoderGetEventStreamDecoder ()
 
const SelectObjectContentHandlerGetEventStreamHandler () const
 
void SetEventStreamHandler (const SelectObjectContentHandler &value)
 
SelectObjectContentRequestWithEventStreamHandler (const SelectObjectContentHandler &value)
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
SelectObjectContentRequestWithBucket (const Aws::String &value)
 
SelectObjectContentRequestWithBucket (Aws::String &&value)
 
SelectObjectContentRequestWithBucket (const char *value)
 
const Aws::StringGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::String &value)
 
void SetKey (Aws::String &&value)
 
void SetKey (const char *value)
 
SelectObjectContentRequestWithKey (const Aws::String &value)
 
SelectObjectContentRequestWithKey (Aws::String &&value)
 
SelectObjectContentRequestWithKey (const char *value)
 
const Aws::StringGetSSECustomerAlgorithm () const
 
bool SSECustomerAlgorithmHasBeenSet () const
 
void SetSSECustomerAlgorithm (const Aws::String &value)
 
void SetSSECustomerAlgorithm (Aws::String &&value)
 
void SetSSECustomerAlgorithm (const char *value)
 
SelectObjectContentRequestWithSSECustomerAlgorithm (const Aws::String &value)
 
SelectObjectContentRequestWithSSECustomerAlgorithm (Aws::String &&value)
 
SelectObjectContentRequestWithSSECustomerAlgorithm (const char *value)
 
const Aws::StringGetSSECustomerKey () const
 
bool SSECustomerKeyHasBeenSet () const
 
void SetSSECustomerKey (const Aws::String &value)
 
void SetSSECustomerKey (Aws::String &&value)
 
void SetSSECustomerKey (const char *value)
 
SelectObjectContentRequestWithSSECustomerKey (const Aws::String &value)
 
SelectObjectContentRequestWithSSECustomerKey (Aws::String &&value)
 
SelectObjectContentRequestWithSSECustomerKey (const char *value)
 
const Aws::StringGetSSECustomerKeyMD5 () const
 
bool SSECustomerKeyMD5HasBeenSet () const
 
void SetSSECustomerKeyMD5 (const Aws::String &value)
 
void SetSSECustomerKeyMD5 (Aws::String &&value)
 
void SetSSECustomerKeyMD5 (const char *value)
 
SelectObjectContentRequestWithSSECustomerKeyMD5 (const Aws::String &value)
 
SelectObjectContentRequestWithSSECustomerKeyMD5 (Aws::String &&value)
 
SelectObjectContentRequestWithSSECustomerKeyMD5 (const char *value)
 
const Aws::StringGetExpression () const
 
bool ExpressionHasBeenSet () const
 
void SetExpression (const Aws::String &value)
 
void SetExpression (Aws::String &&value)
 
void SetExpression (const char *value)
 
SelectObjectContentRequestWithExpression (const Aws::String &value)
 
SelectObjectContentRequestWithExpression (Aws::String &&value)
 
SelectObjectContentRequestWithExpression (const char *value)
 
const ExpressionTypeGetExpressionType () const
 
bool ExpressionTypeHasBeenSet () const
 
void SetExpressionType (const ExpressionType &value)
 
void SetExpressionType (ExpressionType &&value)
 
SelectObjectContentRequestWithExpressionType (const ExpressionType &value)
 
SelectObjectContentRequestWithExpressionType (ExpressionType &&value)
 
const RequestProgressGetRequestProgress () const
 
bool RequestProgressHasBeenSet () const
 
void SetRequestProgress (const RequestProgress &value)
 
void SetRequestProgress (RequestProgress &&value)
 
SelectObjectContentRequestWithRequestProgress (const RequestProgress &value)
 
SelectObjectContentRequestWithRequestProgress (RequestProgress &&value)
 
const InputSerializationGetInputSerialization () const
 
bool InputSerializationHasBeenSet () const
 
void SetInputSerialization (const InputSerialization &value)
 
void SetInputSerialization (InputSerialization &&value)
 
SelectObjectContentRequestWithInputSerialization (const InputSerialization &value)
 
SelectObjectContentRequestWithInputSerialization (InputSerialization &&value)
 
const OutputSerializationGetOutputSerialization () const
 
bool OutputSerializationHasBeenSet () const
 
void SetOutputSerialization (const OutputSerialization &value)
 
void SetOutputSerialization (OutputSerialization &&value)
 
SelectObjectContentRequestWithOutputSerialization (const OutputSerialization &value)
 
SelectObjectContentRequestWithOutputSerialization (OutputSerialization &&value)
 
const ScanRangeGetScanRange () const
 
bool ScanRangeHasBeenSet () const
 
void SetScanRange (const ScanRange &value)
 
void SetScanRange (ScanRange &&value)
 
SelectObjectContentRequestWithScanRange (const ScanRange &value)
 
SelectObjectContentRequestWithScanRange (ScanRange &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag () const
 
bool CustomizedAccessLogTagHasBeenSet () const
 
void SetCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
SelectObjectContentRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
SelectObjectContentRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
SelectObjectContentRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
SelectObjectContentRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
SelectObjectContentRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
SelectObjectContentRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
SelectObjectContentRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
SelectObjectContentRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
SelectObjectContentRequestAddCustomizedAccessLogTag (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::S3::S3Request
virtual ~S3Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 43 of file SelectObjectContentRequest.h.

Constructor & Destructor Documentation

◆ SelectObjectContentRequest()

Aws::S3::Model::SelectObjectContentRequest::SelectObjectContentRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::AddCustomizedAccessLogTag ( const Aws::String key,
const Aws::String value 
)
inline

Definition at line 621 of file SelectObjectContentRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
const Aws::String value 
)
inline

Definition at line 624 of file SelectObjectContentRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::AddCustomizedAccessLogTag ( const Aws::String key,
Aws::String &&  value 
)
inline

Definition at line 627 of file SelectObjectContentRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Definition at line 630 of file SelectObjectContentRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::AddCustomizedAccessLogTag ( const char *  key,
Aws::String &&  value 
)
inline

Definition at line 633 of file SelectObjectContentRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::AddCustomizedAccessLogTag ( Aws::String &&  key,
const char *  value 
)
inline

Definition at line 636 of file SelectObjectContentRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::AddCustomizedAccessLogTag ( const char *  key,
const char *  value 
)
inline

Definition at line 639 of file SelectObjectContentRequest.h.

◆ AddQueryStringParameters()

void Aws::S3::Model::SelectObjectContentRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ BucketHasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::BucketHasBeenSet ( ) const
inline

The S3 bucket.

Definition at line 89 of file SelectObjectContentRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::CustomizedAccessLogTagHasBeenSet ( ) const
inline

Definition at line 606 of file SelectObjectContentRequest.h.

◆ ExpressionHasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::ExpressionHasBeenSet ( ) const
inline

The expression that is used to query the object.

Definition at line 342 of file SelectObjectContentRequest.h.

◆ ExpressionTypeHasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::ExpressionTypeHasBeenSet ( ) const
inline

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

Definition at line 383 of file SelectObjectContentRequest.h.

◆ GetBucket()

const Aws::String& Aws::S3::Model::SelectObjectContentRequest::GetBucket ( ) const
inline

The S3 bucket.

Definition at line 84 of file SelectObjectContentRequest.h.

◆ GetCustomizedAccessLogTag()

const Aws::Map<Aws::String, Aws::String>& Aws::S3::Model::SelectObjectContentRequest::GetCustomizedAccessLogTag ( ) const
inline

Definition at line 603 of file SelectObjectContentRequest.h.

◆ GetEventStreamDecoder()

Aws::Utils::Event::EventStreamDecoder& Aws::S3::Model::SelectObjectContentRequest::GetEventStreamDecoder ( )
inline

Underlying Event Stream Decoder.

Definition at line 63 of file SelectObjectContentRequest.h.

◆ GetEventStreamHandler()

const SelectObjectContentHandler& Aws::S3::Model::SelectObjectContentRequest::GetEventStreamHandler ( ) const
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 68 of file SelectObjectContentRequest.h.

◆ GetExpression()

const Aws::String& Aws::S3::Model::SelectObjectContentRequest::GetExpression ( ) const
inline

The expression that is used to query the object.

Definition at line 337 of file SelectObjectContentRequest.h.

◆ GetExpressionType()

const ExpressionType& Aws::S3::Model::SelectObjectContentRequest::GetExpressionType ( ) const
inline

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

Definition at line 378 of file SelectObjectContentRequest.h.

◆ GetInputSerialization()

const InputSerialization& Aws::S3::Model::SelectObjectContentRequest::GetInputSerialization ( ) const
inline

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

Definition at line 440 of file SelectObjectContentRequest.h.

◆ GetKey()

const Aws::String& Aws::S3::Model::SelectObjectContentRequest::GetKey ( ) const
inline

The object key.

Definition at line 125 of file SelectObjectContentRequest.h.

◆ GetOutputSerialization()

const OutputSerialization& Aws::S3::Model::SelectObjectContentRequest::GetOutputSerialization ( ) const
inline

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

Definition at line 472 of file SelectObjectContentRequest.h.

◆ GetRequestProgress()

const RequestProgress& Aws::S3::Model::SelectObjectContentRequest::GetRequestProgress ( ) const
inline

Specifies if periodic request progress information should be enabled.

Definition at line 409 of file SelectObjectContentRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3::Model::SelectObjectContentRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::S3::S3Request.

◆ GetScanRange()

const ScanRange& Aws::S3::Model::SelectObjectContentRequest::GetScanRange ( ) const
inline

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.

Definition at line 519 of file SelectObjectContentRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::S3::Model::SelectObjectContentRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 52 of file SelectObjectContentRequest.h.

◆ GetSSECustomerAlgorithm()

const Aws::String& Aws::S3::Model::SelectObjectContentRequest::GetSSECustomerAlgorithm ( ) const
inline

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 168 of file SelectObjectContentRequest.h.

◆ GetSSECustomerKey()

const Aws::String& Aws::S3::Model::SelectObjectContentRequest::GetSSECustomerKey ( ) const
inline

The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 225 of file SelectObjectContentRequest.h.

◆ GetSSECustomerKeyMD5()

const Aws::String& Aws::S3::Model::SelectObjectContentRequest::GetSSECustomerKeyMD5 ( ) const
inline

The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 282 of file SelectObjectContentRequest.h.

◆ InputSerializationHasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::InputSerializationHasBeenSet ( ) const
inline

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

Definition at line 445 of file SelectObjectContentRequest.h.

◆ KeyHasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::KeyHasBeenSet ( ) const
inline

The object key.

Definition at line 130 of file SelectObjectContentRequest.h.

◆ OutputSerializationHasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::OutputSerializationHasBeenSet ( ) const
inline

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

Definition at line 478 of file SelectObjectContentRequest.h.

◆ RequestProgressHasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::RequestProgressHasBeenSet ( ) const
inline

Specifies if periodic request progress information should be enabled.

Definition at line 414 of file SelectObjectContentRequest.h.

◆ ScanRangeHasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::ScanRangeHasBeenSet ( ) const
inline

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.

Definition at line 535 of file SelectObjectContentRequest.h.

◆ SerializePayload()

Aws::String Aws::S3::Model::SelectObjectContentRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

void Aws::S3::Model::SelectObjectContentRequest::SetBucket ( const Aws::String value)
inline

The S3 bucket.

Definition at line 94 of file SelectObjectContentRequest.h.

◆ SetBucket() [2/3]

void Aws::S3::Model::SelectObjectContentRequest::SetBucket ( Aws::String &&  value)
inline

The S3 bucket.

Definition at line 99 of file SelectObjectContentRequest.h.

◆ SetBucket() [3/3]

void Aws::S3::Model::SelectObjectContentRequest::SetBucket ( const char *  value)
inline

The S3 bucket.

Definition at line 104 of file SelectObjectContentRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

void Aws::S3::Model::SelectObjectContentRequest::SetCustomizedAccessLogTag ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Definition at line 609 of file SelectObjectContentRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

void Aws::S3::Model::SelectObjectContentRequest::SetCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Definition at line 612 of file SelectObjectContentRequest.h.

◆ SetEventStreamHandler()

void Aws::S3::Model::SelectObjectContentRequest::SetEventStreamHandler ( const SelectObjectContentHandler value)
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 73 of file SelectObjectContentRequest.h.

◆ SetExpression() [1/3]

void Aws::S3::Model::SelectObjectContentRequest::SetExpression ( const Aws::String value)
inline

The expression that is used to query the object.

Definition at line 347 of file SelectObjectContentRequest.h.

◆ SetExpression() [2/3]

void Aws::S3::Model::SelectObjectContentRequest::SetExpression ( Aws::String &&  value)
inline

The expression that is used to query the object.

Definition at line 352 of file SelectObjectContentRequest.h.

◆ SetExpression() [3/3]

void Aws::S3::Model::SelectObjectContentRequest::SetExpression ( const char *  value)
inline

The expression that is used to query the object.

Definition at line 357 of file SelectObjectContentRequest.h.

◆ SetExpressionType() [1/2]

void Aws::S3::Model::SelectObjectContentRequest::SetExpressionType ( const ExpressionType value)
inline

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

Definition at line 388 of file SelectObjectContentRequest.h.

◆ SetExpressionType() [2/2]

void Aws::S3::Model::SelectObjectContentRequest::SetExpressionType ( ExpressionType &&  value)
inline

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

Definition at line 393 of file SelectObjectContentRequest.h.

◆ SetInputSerialization() [1/2]

void Aws::S3::Model::SelectObjectContentRequest::SetInputSerialization ( const InputSerialization value)
inline

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

Definition at line 450 of file SelectObjectContentRequest.h.

◆ SetInputSerialization() [2/2]

void Aws::S3::Model::SelectObjectContentRequest::SetInputSerialization ( InputSerialization &&  value)
inline

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

Definition at line 455 of file SelectObjectContentRequest.h.

◆ SetKey() [1/3]

void Aws::S3::Model::SelectObjectContentRequest::SetKey ( const Aws::String value)
inline

The object key.

Definition at line 135 of file SelectObjectContentRequest.h.

◆ SetKey() [2/3]

void Aws::S3::Model::SelectObjectContentRequest::SetKey ( Aws::String &&  value)
inline

The object key.

Definition at line 140 of file SelectObjectContentRequest.h.

◆ SetKey() [3/3]

void Aws::S3::Model::SelectObjectContentRequest::SetKey ( const char *  value)
inline

The object key.

Definition at line 145 of file SelectObjectContentRequest.h.

◆ SetOutputSerialization() [1/2]

void Aws::S3::Model::SelectObjectContentRequest::SetOutputSerialization ( const OutputSerialization value)
inline

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

Definition at line 484 of file SelectObjectContentRequest.h.

◆ SetOutputSerialization() [2/2]

void Aws::S3::Model::SelectObjectContentRequest::SetOutputSerialization ( OutputSerialization &&  value)
inline

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

Definition at line 490 of file SelectObjectContentRequest.h.

◆ SetRequestProgress() [1/2]

void Aws::S3::Model::SelectObjectContentRequest::SetRequestProgress ( const RequestProgress value)
inline

Specifies if periodic request progress information should be enabled.

Definition at line 419 of file SelectObjectContentRequest.h.

◆ SetRequestProgress() [2/2]

void Aws::S3::Model::SelectObjectContentRequest::SetRequestProgress ( RequestProgress &&  value)
inline

Specifies if periodic request progress information should be enabled.

Definition at line 424 of file SelectObjectContentRequest.h.

◆ SetScanRange() [1/2]

void Aws::S3::Model::SelectObjectContentRequest::SetScanRange ( const ScanRange value)
inline

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.

Definition at line 551 of file SelectObjectContentRequest.h.

◆ SetScanRange() [2/2]

void Aws::S3::Model::SelectObjectContentRequest::SetScanRange ( ScanRange &&  value)
inline

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.

Definition at line 567 of file SelectObjectContentRequest.h.

◆ SetSSECustomerAlgorithm() [1/3]

void Aws::S3::Model::SelectObjectContentRequest::SetSSECustomerAlgorithm ( const Aws::String value)
inline

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 182 of file SelectObjectContentRequest.h.

◆ SetSSECustomerAlgorithm() [2/3]

void Aws::S3::Model::SelectObjectContentRequest::SetSSECustomerAlgorithm ( Aws::String &&  value)
inline

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 189 of file SelectObjectContentRequest.h.

◆ SetSSECustomerAlgorithm() [3/3]

void Aws::S3::Model::SelectObjectContentRequest::SetSSECustomerAlgorithm ( const char *  value)
inline

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 196 of file SelectObjectContentRequest.h.

◆ SetSSECustomerKey() [1/3]

void Aws::S3::Model::SelectObjectContentRequest::SetSSECustomerKey ( const Aws::String value)
inline

The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 239 of file SelectObjectContentRequest.h.

◆ SetSSECustomerKey() [2/3]

void Aws::S3::Model::SelectObjectContentRequest::SetSSECustomerKey ( Aws::String &&  value)
inline

The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 246 of file SelectObjectContentRequest.h.

◆ SetSSECustomerKey() [3/3]

void Aws::S3::Model::SelectObjectContentRequest::SetSSECustomerKey ( const char *  value)
inline

The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 253 of file SelectObjectContentRequest.h.

◆ SetSSECustomerKeyMD5() [1/3]

void Aws::S3::Model::SelectObjectContentRequest::SetSSECustomerKeyMD5 ( const Aws::String value)
inline

The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 296 of file SelectObjectContentRequest.h.

◆ SetSSECustomerKeyMD5() [2/3]

void Aws::S3::Model::SelectObjectContentRequest::SetSSECustomerKeyMD5 ( Aws::String &&  value)
inline

The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 303 of file SelectObjectContentRequest.h.

◆ SetSSECustomerKeyMD5() [3/3]

void Aws::S3::Model::SelectObjectContentRequest::SetSSECustomerKeyMD5 ( const char *  value)
inline

The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 310 of file SelectObjectContentRequest.h.

◆ SSECustomerAlgorithmHasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::SSECustomerAlgorithmHasBeenSet ( ) const
inline

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 175 of file SelectObjectContentRequest.h.

◆ SSECustomerKeyHasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::SSECustomerKeyHasBeenSet ( ) const
inline

The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 232 of file SelectObjectContentRequest.h.

◆ SSECustomerKeyMD5HasBeenSet()

bool Aws::S3::Model::SelectObjectContentRequest::SSECustomerKeyMD5HasBeenSet ( ) const
inline

The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 289 of file SelectObjectContentRequest.h.

◆ WithBucket() [1/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithBucket ( const Aws::String value)
inline

The S3 bucket.

Definition at line 109 of file SelectObjectContentRequest.h.

◆ WithBucket() [2/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithBucket ( Aws::String &&  value)
inline

The S3 bucket.

Definition at line 114 of file SelectObjectContentRequest.h.

◆ WithBucket() [3/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithBucket ( const char *  value)
inline

The S3 bucket.

Definition at line 119 of file SelectObjectContentRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithCustomizedAccessLogTag ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Definition at line 615 of file SelectObjectContentRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Definition at line 618 of file SelectObjectContentRequest.h.

◆ WithEventStreamHandler()

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithEventStreamHandler ( const SelectObjectContentHandler value)
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 78 of file SelectObjectContentRequest.h.

◆ WithExpression() [1/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithExpression ( const Aws::String value)
inline

The expression that is used to query the object.

Definition at line 362 of file SelectObjectContentRequest.h.

◆ WithExpression() [2/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithExpression ( Aws::String &&  value)
inline

The expression that is used to query the object.

Definition at line 367 of file SelectObjectContentRequest.h.

◆ WithExpression() [3/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithExpression ( const char *  value)
inline

The expression that is used to query the object.

Definition at line 372 of file SelectObjectContentRequest.h.

◆ WithExpressionType() [1/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithExpressionType ( const ExpressionType value)
inline

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

Definition at line 398 of file SelectObjectContentRequest.h.

◆ WithExpressionType() [2/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithExpressionType ( ExpressionType &&  value)
inline

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

Definition at line 403 of file SelectObjectContentRequest.h.

◆ WithInputSerialization() [1/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithInputSerialization ( const InputSerialization value)
inline

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

Definition at line 460 of file SelectObjectContentRequest.h.

◆ WithInputSerialization() [2/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithInputSerialization ( InputSerialization &&  value)
inline

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

Definition at line 465 of file SelectObjectContentRequest.h.

◆ WithKey() [1/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithKey ( const Aws::String value)
inline

The object key.

Definition at line 150 of file SelectObjectContentRequest.h.

◆ WithKey() [2/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithKey ( Aws::String &&  value)
inline

The object key.

Definition at line 155 of file SelectObjectContentRequest.h.

◆ WithKey() [3/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithKey ( const char *  value)
inline

The object key.

Definition at line 160 of file SelectObjectContentRequest.h.

◆ WithOutputSerialization() [1/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithOutputSerialization ( const OutputSerialization value)
inline

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

Definition at line 496 of file SelectObjectContentRequest.h.

◆ WithOutputSerialization() [2/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithOutputSerialization ( OutputSerialization &&  value)
inline

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

Definition at line 502 of file SelectObjectContentRequest.h.

◆ WithRequestProgress() [1/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithRequestProgress ( const RequestProgress value)
inline

Specifies if periodic request progress information should be enabled.

Definition at line 429 of file SelectObjectContentRequest.h.

◆ WithRequestProgress() [2/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithRequestProgress ( RequestProgress &&  value)
inline

Specifies if periodic request progress information should be enabled.

Definition at line 434 of file SelectObjectContentRequest.h.

◆ WithScanRange() [1/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithScanRange ( const ScanRange value)
inline

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.

Definition at line 583 of file SelectObjectContentRequest.h.

◆ WithScanRange() [2/2]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithScanRange ( ScanRange &&  value)
inline

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.

Definition at line 599 of file SelectObjectContentRequest.h.

◆ WithSSECustomerAlgorithm() [1/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithSSECustomerAlgorithm ( const Aws::String value)
inline

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 203 of file SelectObjectContentRequest.h.

◆ WithSSECustomerAlgorithm() [2/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithSSECustomerAlgorithm ( Aws::String &&  value)
inline

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 210 of file SelectObjectContentRequest.h.

◆ WithSSECustomerAlgorithm() [3/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithSSECustomerAlgorithm ( const char *  value)
inline

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 217 of file SelectObjectContentRequest.h.

◆ WithSSECustomerKey() [1/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithSSECustomerKey ( const Aws::String value)
inline

The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 260 of file SelectObjectContentRequest.h.

◆ WithSSECustomerKey() [2/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithSSECustomerKey ( Aws::String &&  value)
inline

The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 267 of file SelectObjectContentRequest.h.

◆ WithSSECustomerKey() [3/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithSSECustomerKey ( const char *  value)
inline

The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 274 of file SelectObjectContentRequest.h.

◆ WithSSECustomerKeyMD5() [1/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithSSECustomerKeyMD5 ( const Aws::String value)
inline

The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 317 of file SelectObjectContentRequest.h.

◆ WithSSECustomerKeyMD5() [2/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithSSECustomerKeyMD5 ( Aws::String &&  value)
inline

The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 324 of file SelectObjectContentRequest.h.

◆ WithSSECustomerKeyMD5() [3/3]

SelectObjectContentRequest& Aws::S3::Model::SelectObjectContentRequest::WithSSECustomerKeyMD5 ( const char *  value)
inline

The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

Definition at line 331 of file SelectObjectContentRequest.h.


The documentation for this class was generated from the following file: