/** * 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 namespace Aws { namespace Athena { namespace Model { /** */ class StartQueryExecutionRequest : public AthenaRequest { public: AWS_ATHENA_API StartQueryExecutionRequest(); // 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 "StartQueryExecution"; } AWS_ATHENA_API Aws::String SerializePayload() const override; AWS_ATHENA_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The SQL query statements to be executed.

*/ inline const Aws::String& GetQueryString() const{ return m_queryString; } /** *

The SQL query statements to be executed.

*/ inline bool QueryStringHasBeenSet() const { return m_queryStringHasBeenSet; } /** *

The SQL query statements to be executed.

*/ inline void SetQueryString(const Aws::String& value) { m_queryStringHasBeenSet = true; m_queryString = value; } /** *

The SQL query statements to be executed.

*/ inline void SetQueryString(Aws::String&& value) { m_queryStringHasBeenSet = true; m_queryString = std::move(value); } /** *

The SQL query statements to be executed.

*/ inline void SetQueryString(const char* value) { m_queryStringHasBeenSet = true; m_queryString.assign(value); } /** *

The SQL query statements to be executed.

*/ inline StartQueryExecutionRequest& WithQueryString(const Aws::String& value) { SetQueryString(value); return *this;} /** *

The SQL query statements to be executed.

*/ inline StartQueryExecutionRequest& WithQueryString(Aws::String&& value) { SetQueryString(std::move(value)); return *this;} /** *

The SQL query statements to be executed.

*/ inline StartQueryExecutionRequest& WithQueryString(const char* value) { SetQueryString(value); return *this;} /** *

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.

*/ inline const Aws::String& GetClientRequestToken() const{ return m_clientRequestToken; } /** *

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.

*/ inline bool ClientRequestTokenHasBeenSet() const { return m_clientRequestTokenHasBeenSet; } /** *

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.

*/ inline void SetClientRequestToken(const Aws::String& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = value; } /** *

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.

*/ inline void SetClientRequestToken(Aws::String&& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = std::move(value); } /** *

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.

*/ inline void SetClientRequestToken(const char* value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken.assign(value); } /** *

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.

*/ inline StartQueryExecutionRequest& WithClientRequestToken(const Aws::String& value) { SetClientRequestToken(value); return *this;} /** *

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.

*/ inline StartQueryExecutionRequest& WithClientRequestToken(Aws::String&& value) { SetClientRequestToken(std::move(value)); return *this;} /** *

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.

*/ inline StartQueryExecutionRequest& WithClientRequestToken(const char* value) { SetClientRequestToken(value); return *this;} /** *

The database within which the query executes.

*/ inline const QueryExecutionContext& GetQueryExecutionContext() const{ return m_queryExecutionContext; } /** *

The database within which the query executes.

*/ inline bool QueryExecutionContextHasBeenSet() const { return m_queryExecutionContextHasBeenSet; } /** *

The database within which the query executes.

*/ inline void SetQueryExecutionContext(const QueryExecutionContext& value) { m_queryExecutionContextHasBeenSet = true; m_queryExecutionContext = value; } /** *

The database within which the query executes.

*/ inline void SetQueryExecutionContext(QueryExecutionContext&& value) { m_queryExecutionContextHasBeenSet = true; m_queryExecutionContext = std::move(value); } /** *

The database within which the query executes.

*/ inline StartQueryExecutionRequest& WithQueryExecutionContext(const QueryExecutionContext& value) { SetQueryExecutionContext(value); return *this;} /** *

The database within which the query executes.

*/ inline StartQueryExecutionRequest& WithQueryExecutionContext(QueryExecutionContext&& value) { SetQueryExecutionContext(std::move(value)); return *this;} /** *

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.

*/ inline const ResultConfiguration& GetResultConfiguration() const{ return m_resultConfiguration; } /** *

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.

*/ inline bool ResultConfigurationHasBeenSet() const { return m_resultConfigurationHasBeenSet; } /** *

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.

*/ inline void SetResultConfiguration(const ResultConfiguration& value) { m_resultConfigurationHasBeenSet = true; m_resultConfiguration = value; } /** *

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.

*/ inline void SetResultConfiguration(ResultConfiguration&& value) { m_resultConfigurationHasBeenSet = true; m_resultConfiguration = std::move(value); } /** *

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.

*/ inline StartQueryExecutionRequest& WithResultConfiguration(const ResultConfiguration& value) { SetResultConfiguration(value); return *this;} /** *

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.

*/ inline StartQueryExecutionRequest& WithResultConfiguration(ResultConfiguration&& value) { SetResultConfiguration(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetWorkGroup() const{ return m_workGroup; } /** *

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

*/ inline bool WorkGroupHasBeenSet() const { return m_workGroupHasBeenSet; } /** *

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

*/ inline void SetWorkGroup(const Aws::String& value) { m_workGroupHasBeenSet = true; m_workGroup = value; } /** *

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

*/ inline void SetWorkGroup(Aws::String&& value) { m_workGroupHasBeenSet = true; m_workGroup = std::move(value); } /** *

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

*/ inline void SetWorkGroup(const char* value) { m_workGroupHasBeenSet = true; m_workGroup.assign(value); } /** *

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

*/ inline StartQueryExecutionRequest& WithWorkGroup(const Aws::String& value) { SetWorkGroup(value); return *this;} /** *

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

*/ inline StartQueryExecutionRequest& WithWorkGroup(Aws::String&& value) { SetWorkGroup(std::move(value)); return *this;} /** *

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

*/ inline StartQueryExecutionRequest& WithWorkGroup(const char* value) { SetWorkGroup(value); return *this;} /** *

A list of values for the parameters in a query. The values are applied * sequentially to the parameters in the query in the order in which the parameters * occur.

*/ inline const Aws::Vector& GetExecutionParameters() const{ return m_executionParameters; } /** *

A list of values for the parameters in a query. The values are applied * sequentially to the parameters in the query in the order in which the parameters * occur.

*/ inline bool ExecutionParametersHasBeenSet() const { return m_executionParametersHasBeenSet; } /** *

A list of values for the parameters in a query. The values are applied * sequentially to the parameters in the query in the order in which the parameters * occur.

*/ inline void SetExecutionParameters(const Aws::Vector& value) { m_executionParametersHasBeenSet = true; m_executionParameters = value; } /** *

A list of values for the parameters in a query. The values are applied * sequentially to the parameters in the query in the order in which the parameters * occur.

*/ inline void SetExecutionParameters(Aws::Vector&& value) { m_executionParametersHasBeenSet = true; m_executionParameters = std::move(value); } /** *

A list of values for the parameters in a query. The values are applied * sequentially to the parameters in the query in the order in which the parameters * occur.

*/ inline StartQueryExecutionRequest& WithExecutionParameters(const Aws::Vector& value) { SetExecutionParameters(value); return *this;} /** *

A list of values for the parameters in a query. The values are applied * sequentially to the parameters in the query in the order in which the parameters * occur.

*/ inline StartQueryExecutionRequest& WithExecutionParameters(Aws::Vector&& value) { SetExecutionParameters(std::move(value)); return *this;} /** *

A list of values for the parameters in a query. The values are applied * sequentially to the parameters in the query in the order in which the parameters * occur.

*/ inline StartQueryExecutionRequest& AddExecutionParameters(const Aws::String& value) { m_executionParametersHasBeenSet = true; m_executionParameters.push_back(value); return *this; } /** *

A list of values for the parameters in a query. The values are applied * sequentially to the parameters in the query in the order in which the parameters * occur.

*/ inline StartQueryExecutionRequest& AddExecutionParameters(Aws::String&& value) { m_executionParametersHasBeenSet = true; m_executionParameters.push_back(std::move(value)); return *this; } /** *

A list of values for the parameters in a query. The values are applied * sequentially to the parameters in the query in the order in which the parameters * occur.

*/ inline StartQueryExecutionRequest& AddExecutionParameters(const char* value) { m_executionParametersHasBeenSet = true; m_executionParameters.push_back(value); return *this; } /** *

Specifies the query result reuse behavior for the query.

*/ inline const ResultReuseConfiguration& GetResultReuseConfiguration() const{ return m_resultReuseConfiguration; } /** *

Specifies the query result reuse behavior for the query.

*/ inline bool ResultReuseConfigurationHasBeenSet() const { return m_resultReuseConfigurationHasBeenSet; } /** *

Specifies the query result reuse behavior for the query.

*/ inline void SetResultReuseConfiguration(const ResultReuseConfiguration& value) { m_resultReuseConfigurationHasBeenSet = true; m_resultReuseConfiguration = value; } /** *

Specifies the query result reuse behavior for the query.

*/ inline void SetResultReuseConfiguration(ResultReuseConfiguration&& value) { m_resultReuseConfigurationHasBeenSet = true; m_resultReuseConfiguration = std::move(value); } /** *

Specifies the query result reuse behavior for the query.

*/ inline StartQueryExecutionRequest& WithResultReuseConfiguration(const ResultReuseConfiguration& value) { SetResultReuseConfiguration(value); return *this;} /** *

Specifies the query result reuse behavior for the query.

*/ inline StartQueryExecutionRequest& WithResultReuseConfiguration(ResultReuseConfiguration&& value) { SetResultReuseConfiguration(std::move(value)); return *this;} private: Aws::String m_queryString; bool m_queryStringHasBeenSet = false; Aws::String m_clientRequestToken; bool m_clientRequestTokenHasBeenSet = false; QueryExecutionContext m_queryExecutionContext; bool m_queryExecutionContextHasBeenSet = false; ResultConfiguration m_resultConfiguration; bool m_resultConfigurationHasBeenSet = false; Aws::String m_workGroup; bool m_workGroupHasBeenSet = false; Aws::Vector m_executionParameters; bool m_executionParametersHasBeenSet = false; ResultReuseConfiguration m_resultReuseConfiguration; bool m_resultReuseConfigurationHasBeenSet = false; }; } // namespace Model } // namespace Athena } // namespace Aws