AWS SDK for C++  1.9.46
AWS SDK for C++
Public Member Functions | List of all members
Aws::TimestreamQuery::Model::QueryRequest Class Reference

#include <QueryRequest.h>

+ Inheritance diagram for Aws::TimestreamQuery::Model::QueryRequest:

Public Member Functions

 QueryRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetQueryString () const
 
bool QueryStringHasBeenSet () const
 
void SetQueryString (const Aws::String &value)
 
void SetQueryString (Aws::String &&value)
 
void SetQueryString (const char *value)
 
QueryRequestWithQueryString (const Aws::String &value)
 
QueryRequestWithQueryString (Aws::String &&value)
 
QueryRequestWithQueryString (const char *value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
QueryRequestWithClientToken (const Aws::String &value)
 
QueryRequestWithClientToken (Aws::String &&value)
 
QueryRequestWithClientToken (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
QueryRequestWithNextToken (const Aws::String &value)
 
QueryRequestWithNextToken (Aws::String &&value)
 
QueryRequestWithNextToken (const char *value)
 
int GetMaxRows () const
 
bool MaxRowsHasBeenSet () const
 
void SetMaxRows (int value)
 
QueryRequestWithMaxRows (int value)
 
- Public Member Functions inherited from Aws::TimestreamQuery::TimestreamQueryRequest
virtual ~TimestreamQueryRequest ()
 
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 AddQueryStringParameters (Aws::Http::URI &uri) const
 
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

Definition at line 22 of file QueryRequest.h.

Constructor & Destructor Documentation

◆ QueryRequest()

Aws::TimestreamQuery::Model::QueryRequest::QueryRequest ( )

Member Function Documentation

◆ ClientTokenHasBeenSet()

bool Aws::TimestreamQuery::Model::QueryRequest::ClientTokenHasBeenSet ( ) const
inline

Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request. Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls have the same effect as one single call.

Your query request will fail in the following cases:

  • If you submit a request with the same client token outside the 5-minute idepotency window.

  • If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window.

After 4 hours, any request with the same client token is treated as a new request.

Definition at line 103 of file QueryRequest.h.

◆ GetClientToken()

const Aws::String& Aws::TimestreamQuery::Model::QueryRequest::GetClientToken ( ) const
inline

Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request. Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls have the same effect as one single call.

Your query request will fail in the following cases:

  • If you submit a request with the same client token outside the 5-minute idepotency window.

  • If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window.

After 4 hours, any request with the same client token is treated as a new request.

Definition at line 90 of file QueryRequest.h.

◆ GetMaxRows()

int Aws::TimestreamQuery::Model::QueryRequest::GetMaxRows ( ) const
inline

The total number of rows to return in the output. If the total number of rows available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command.

Definition at line 231 of file QueryRequest.h.

◆ GetNextToken()

const Aws::String& Aws::TimestreamQuery::Model::QueryRequest::GetNextToken ( ) const
inline

A pagination token passed to get a set of results.

Definition at line 187 of file QueryRequest.h.

◆ GetQueryString()

const Aws::String& Aws::TimestreamQuery::Model::QueryRequest::GetQueryString ( ) const
inline

The query to be executed by Timestream.

Definition at line 41 of file QueryRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::TimestreamQuery::Model::QueryRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::TimestreamQuery::Model::QueryRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file QueryRequest.h.

◆ MaxRowsHasBeenSet()

bool Aws::TimestreamQuery::Model::QueryRequest::MaxRowsHasBeenSet ( ) const
inline

The total number of rows to return in the output. If the total number of rows available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command.

Definition at line 239 of file QueryRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::TimestreamQuery::Model::QueryRequest::NextTokenHasBeenSet ( ) const
inline

A pagination token passed to get a set of results.

Definition at line 192 of file QueryRequest.h.

◆ QueryStringHasBeenSet()

bool Aws::TimestreamQuery::Model::QueryRequest::QueryStringHasBeenSet ( ) const
inline

The query to be executed by Timestream.

Definition at line 46 of file QueryRequest.h.

◆ SerializePayload()

Aws::String Aws::TimestreamQuery::Model::QueryRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetClientToken ( Aws::String &&  value)
inline

Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request. Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls have the same effect as one single call.

Your query request will fail in the following cases:

  • If you submit a request with the same client token outside the 5-minute idepotency window.

  • If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window.

After 4 hours, any request with the same client token is treated as a new request.

Definition at line 129 of file QueryRequest.h.

◆ SetClientToken() [2/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetClientToken ( const Aws::String value)
inline

Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request. Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls have the same effect as one single call.

Your query request will fail in the following cases:

  • If you submit a request with the same client token outside the 5-minute idepotency window.

  • If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window.

After 4 hours, any request with the same client token is treated as a new request.

Definition at line 116 of file QueryRequest.h.

◆ SetClientToken() [3/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetClientToken ( const char *  value)
inline

Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request. Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls have the same effect as one single call.

Your query request will fail in the following cases:

  • If you submit a request with the same client token outside the 5-minute idepotency window.

  • If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window.

After 4 hours, any request with the same client token is treated as a new request.

Definition at line 142 of file QueryRequest.h.

◆ SetMaxRows()

void Aws::TimestreamQuery::Model::QueryRequest::SetMaxRows ( int  value)
inline

The total number of rows to return in the output. If the total number of rows available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command.

Definition at line 247 of file QueryRequest.h.

◆ SetNextToken() [1/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetNextToken ( Aws::String &&  value)
inline

A pagination token passed to get a set of results.

Definition at line 202 of file QueryRequest.h.

◆ SetNextToken() [2/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetNextToken ( const Aws::String value)
inline

A pagination token passed to get a set of results.

Definition at line 197 of file QueryRequest.h.

◆ SetNextToken() [3/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetNextToken ( const char *  value)
inline

A pagination token passed to get a set of results.

Definition at line 207 of file QueryRequest.h.

◆ SetQueryString() [1/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetQueryString ( Aws::String &&  value)
inline

The query to be executed by Timestream.

Definition at line 56 of file QueryRequest.h.

◆ SetQueryString() [2/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetQueryString ( const Aws::String value)
inline

The query to be executed by Timestream.

Definition at line 51 of file QueryRequest.h.

◆ SetQueryString() [3/3]

void Aws::TimestreamQuery::Model::QueryRequest::SetQueryString ( const char *  value)
inline

The query to be executed by Timestream.

Definition at line 61 of file QueryRequest.h.

◆ WithClientToken() [1/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithClientToken ( Aws::String &&  value)
inline

Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request. Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls have the same effect as one single call.

Your query request will fail in the following cases:

  • If you submit a request with the same client token outside the 5-minute idepotency window.

  • If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window.

After 4 hours, any request with the same client token is treated as a new request.

Definition at line 168 of file QueryRequest.h.

◆ WithClientToken() [2/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithClientToken ( const Aws::String value)
inline

Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request. Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls have the same effect as one single call.

Your query request will fail in the following cases:

  • If you submit a request with the same client token outside the 5-minute idepotency window.

  • If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window.

After 4 hours, any request with the same client token is treated as a new request.

Definition at line 155 of file QueryRequest.h.

◆ WithClientToken() [3/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithClientToken ( const char *  value)
inline

Unique, case-sensitive string of up to 64 ASCII characters that you specify when you make a Query request. Providing a ClientToken makes the call to Query idempotent, meaning that multiple identical calls have the same effect as one single call.

Your query request will fail in the following cases:

  • If you submit a request with the same client token outside the 5-minute idepotency window.

  • If you submit a request with the same client token but a change in other parameters within the 5-minute idempotency window.

After 4 hours, any request with the same client token is treated as a new request.

Definition at line 181 of file QueryRequest.h.

◆ WithMaxRows()

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithMaxRows ( int  value)
inline

The total number of rows to return in the output. If the total number of rows available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command.

Definition at line 255 of file QueryRequest.h.

◆ WithNextToken() [1/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithNextToken ( Aws::String &&  value)
inline

A pagination token passed to get a set of results.

Definition at line 217 of file QueryRequest.h.

◆ WithNextToken() [2/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithNextToken ( const Aws::String value)
inline

A pagination token passed to get a set of results.

Definition at line 212 of file QueryRequest.h.

◆ WithNextToken() [3/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithNextToken ( const char *  value)
inline

A pagination token passed to get a set of results.

Definition at line 222 of file QueryRequest.h.

◆ WithQueryString() [1/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithQueryString ( Aws::String &&  value)
inline

The query to be executed by Timestream.

Definition at line 71 of file QueryRequest.h.

◆ WithQueryString() [2/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithQueryString ( const Aws::String value)
inline

The query to be executed by Timestream.

Definition at line 66 of file QueryRequest.h.

◆ WithQueryString() [3/3]

QueryRequest& Aws::TimestreamQuery::Model::QueryRequest::WithQueryString ( const char *  value)
inline

The query to be executed by Timestream.

Definition at line 76 of file QueryRequest.h.


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