AWS SDK for C++  1.9.107
AWS SDK for C++
Public Member Functions | List of all members
Aws::Athena::Model::StartQueryExecutionRequest Class Reference

#include <StartQueryExecutionRequest.h>

+ Inheritance diagram for Aws::Athena::Model::StartQueryExecutionRequest:

Public Member Functions

 StartQueryExecutionRequest ()
 
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)
 
StartQueryExecutionRequestWithQueryString (const Aws::String &value)
 
StartQueryExecutionRequestWithQueryString (Aws::String &&value)
 
StartQueryExecutionRequestWithQueryString (const char *value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
StartQueryExecutionRequestWithClientRequestToken (const Aws::String &value)
 
StartQueryExecutionRequestWithClientRequestToken (Aws::String &&value)
 
StartQueryExecutionRequestWithClientRequestToken (const char *value)
 
const QueryExecutionContextGetQueryExecutionContext () const
 
bool QueryExecutionContextHasBeenSet () const
 
void SetQueryExecutionContext (const QueryExecutionContext &value)
 
void SetQueryExecutionContext (QueryExecutionContext &&value)
 
StartQueryExecutionRequestWithQueryExecutionContext (const QueryExecutionContext &value)
 
StartQueryExecutionRequestWithQueryExecutionContext (QueryExecutionContext &&value)
 
const ResultConfigurationGetResultConfiguration () const
 
bool ResultConfigurationHasBeenSet () const
 
void SetResultConfiguration (const ResultConfiguration &value)
 
void SetResultConfiguration (ResultConfiguration &&value)
 
StartQueryExecutionRequestWithResultConfiguration (const ResultConfiguration &value)
 
StartQueryExecutionRequestWithResultConfiguration (ResultConfiguration &&value)
 
const Aws::StringGetWorkGroup () const
 
bool WorkGroupHasBeenSet () const
 
void SetWorkGroup (const Aws::String &value)
 
void SetWorkGroup (Aws::String &&value)
 
void SetWorkGroup (const char *value)
 
StartQueryExecutionRequestWithWorkGroup (const Aws::String &value)
 
StartQueryExecutionRequestWithWorkGroup (Aws::String &&value)
 
StartQueryExecutionRequestWithWorkGroup (const char *value)
 
- Public Member Functions inherited from Aws::Athena::AthenaRequest
virtual ~AthenaRequest ()
 
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 24 of file StartQueryExecutionRequest.h.

Constructor & Destructor Documentation

◆ StartQueryExecutionRequest()

Aws::Athena::Model::StartQueryExecutionRequest::StartQueryExecutionRequest ( )

Member Function Documentation

◆ ClientRequestTokenHasBeenSet()

bool Aws::Athena::Model::StartQueryExecutionRequest::ClientRequestTokenHasBeenSet ( ) const
inline

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Definition at line 105 of file StartQueryExecutionRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::Athena::Model::StartQueryExecutionRequest::GetClientRequestToken ( ) const
inline

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Definition at line 92 of file StartQueryExecutionRequest.h.

◆ GetQueryExecutionContext()

const QueryExecutionContext& Aws::Athena::Model::StartQueryExecutionRequest::GetQueryExecutionContext ( ) const
inline

The database within which the query executes.

Definition at line 189 of file StartQueryExecutionRequest.h.

◆ GetQueryString()

const Aws::String& Aws::Athena::Model::StartQueryExecutionRequest::GetQueryString ( ) const
inline

The SQL query statements to be executed.

Definition at line 43 of file StartQueryExecutionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Athena::Model::StartQueryExecutionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Athena::AthenaRequest.

◆ GetResultConfiguration()

const ResultConfiguration& Aws::Athena::Model::StartQueryExecutionRequest::GetResultConfiguration ( ) const
inline

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Definition at line 225 of file StartQueryExecutionRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Athena::Model::StartQueryExecutionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file StartQueryExecutionRequest.h.

◆ GetWorkGroup()

const Aws::String& Aws::Athena::Model::StartQueryExecutionRequest::GetWorkGroup ( ) const
inline

The name of the workgroup in which the query is being started.

Definition at line 281 of file StartQueryExecutionRequest.h.

◆ QueryExecutionContextHasBeenSet()

bool Aws::Athena::Model::StartQueryExecutionRequest::QueryExecutionContextHasBeenSet ( ) const
inline

The database within which the query executes.

Definition at line 194 of file StartQueryExecutionRequest.h.

◆ QueryStringHasBeenSet()

bool Aws::Athena::Model::StartQueryExecutionRequest::QueryStringHasBeenSet ( ) const
inline

The SQL query statements to be executed.

Definition at line 48 of file StartQueryExecutionRequest.h.

◆ ResultConfigurationHasBeenSet()

bool Aws::Athena::Model::StartQueryExecutionRequest::ResultConfigurationHasBeenSet ( ) const
inline

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Definition at line 235 of file StartQueryExecutionRequest.h.

◆ SerializePayload()

Aws::String Aws::Athena::Model::StartQueryExecutionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetClientRequestToken ( Aws::String &&  value)
inline

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Definition at line 131 of file StartQueryExecutionRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetClientRequestToken ( const Aws::String value)
inline

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Definition at line 118 of file StartQueryExecutionRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetClientRequestToken ( const char *  value)
inline

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Definition at line 144 of file StartQueryExecutionRequest.h.

◆ SetQueryExecutionContext() [1/2]

void Aws::Athena::Model::StartQueryExecutionRequest::SetQueryExecutionContext ( const QueryExecutionContext value)
inline

The database within which the query executes.

Definition at line 199 of file StartQueryExecutionRequest.h.

◆ SetQueryExecutionContext() [2/2]

void Aws::Athena::Model::StartQueryExecutionRequest::SetQueryExecutionContext ( QueryExecutionContext &&  value)
inline

The database within which the query executes.

Definition at line 204 of file StartQueryExecutionRequest.h.

◆ SetQueryString() [1/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetQueryString ( Aws::String &&  value)
inline

The SQL query statements to be executed.

Definition at line 58 of file StartQueryExecutionRequest.h.

◆ SetQueryString() [2/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetQueryString ( const Aws::String value)
inline

The SQL query statements to be executed.

Definition at line 53 of file StartQueryExecutionRequest.h.

◆ SetQueryString() [3/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetQueryString ( const char *  value)
inline

The SQL query statements to be executed.

Definition at line 63 of file StartQueryExecutionRequest.h.

◆ SetResultConfiguration() [1/2]

void Aws::Athena::Model::StartQueryExecutionRequest::SetResultConfiguration ( const ResultConfiguration value)
inline

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Definition at line 245 of file StartQueryExecutionRequest.h.

◆ SetResultConfiguration() [2/2]

void Aws::Athena::Model::StartQueryExecutionRequest::SetResultConfiguration ( ResultConfiguration &&  value)
inline

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Definition at line 255 of file StartQueryExecutionRequest.h.

◆ SetWorkGroup() [1/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetWorkGroup ( Aws::String &&  value)
inline

The name of the workgroup in which the query is being started.

Definition at line 296 of file StartQueryExecutionRequest.h.

◆ SetWorkGroup() [2/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetWorkGroup ( const Aws::String value)
inline

The name of the workgroup in which the query is being started.

Definition at line 291 of file StartQueryExecutionRequest.h.

◆ SetWorkGroup() [3/3]

void Aws::Athena::Model::StartQueryExecutionRequest::SetWorkGroup ( const char *  value)
inline

The name of the workgroup in which the query is being started.

Definition at line 301 of file StartQueryExecutionRequest.h.

◆ WithClientRequestToken() [1/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithClientRequestToken ( Aws::String &&  value)
inline

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Definition at line 170 of file StartQueryExecutionRequest.h.

◆ WithClientRequestToken() [2/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithClientRequestToken ( const Aws::String value)
inline

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Definition at line 157 of file StartQueryExecutionRequest.h.

◆ WithClientRequestToken() [3/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithClientRequestToken ( const char *  value)
inline

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Definition at line 183 of file StartQueryExecutionRequest.h.

◆ WithQueryExecutionContext() [1/2]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithQueryExecutionContext ( const QueryExecutionContext value)
inline

The database within which the query executes.

Definition at line 209 of file StartQueryExecutionRequest.h.

◆ WithQueryExecutionContext() [2/2]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithQueryExecutionContext ( QueryExecutionContext &&  value)
inline

The database within which the query executes.

Definition at line 214 of file StartQueryExecutionRequest.h.

◆ WithQueryString() [1/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithQueryString ( Aws::String &&  value)
inline

The SQL query statements to be executed.

Definition at line 73 of file StartQueryExecutionRequest.h.

◆ WithQueryString() [2/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithQueryString ( const Aws::String value)
inline

The SQL query statements to be executed.

Definition at line 68 of file StartQueryExecutionRequest.h.

◆ WithQueryString() [3/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithQueryString ( const char *  value)
inline

The SQL query statements to be executed.

Definition at line 78 of file StartQueryExecutionRequest.h.

◆ WithResultConfiguration() [1/2]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithResultConfiguration ( const ResultConfiguration value)
inline

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Definition at line 265 of file StartQueryExecutionRequest.h.

◆ WithResultConfiguration() [2/2]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithResultConfiguration ( ResultConfiguration &&  value)
inline

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Definition at line 275 of file StartQueryExecutionRequest.h.

◆ WithWorkGroup() [1/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithWorkGroup ( Aws::String &&  value)
inline

The name of the workgroup in which the query is being started.

Definition at line 311 of file StartQueryExecutionRequest.h.

◆ WithWorkGroup() [2/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithWorkGroup ( const Aws::String value)
inline

The name of the workgroup in which the query is being started.

Definition at line 306 of file StartQueryExecutionRequest.h.

◆ WithWorkGroup() [3/3]

StartQueryExecutionRequest& Aws::Athena::Model::StartQueryExecutionRequest::WithWorkGroup ( const char *  value)
inline

The name of the workgroup in which the query is being started.

Definition at line 316 of file StartQueryExecutionRequest.h.

◆ WorkGroupHasBeenSet()

bool Aws::Athena::Model::StartQueryExecutionRequest::WorkGroupHasBeenSet ( ) const
inline

The name of the workgroup in which the query is being started.

Definition at line 286 of file StartQueryExecutionRequest.h.


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