Struct aws_sdk_athena::operation::start_query_execution::builders::StartQueryExecutionInputBuilder

#[non_exhaustive]
pub struct StartQueryExecutionInputBuilder { /* private fields */ }

A builder for StartQueryExecutionInput.

Implementations

impl StartQueryExecutionInputBuilder

pub fn query_string(self, input: impl Into<String>) -> Self

The SQL query statements to be executed.

This field is required.

pub fn set_query_string(self, input: Option<String>) -> Self

The SQL query statements to be executed.

pub fn get_query_string(&self) -> &Option<String>

The SQL query statements to be executed.

pub fn client_request_token(self, input: impl Into<String>) -> Self

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. An error is returned if a parameter, such as QueryString, has changed. A call to StartQueryExecution that uses a previous client request token returns the same QueryExecutionId even if the requester doesn't have permission on the tables specified in QueryString.

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.

pub fn set_client_request_token(self, input: Option<String>) -> Self

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. An error is returned if a parameter, such as QueryString, has changed. A call to StartQueryExecution that uses a previous client request token returns the same QueryExecutionId even if the requester doesn't have permission on the tables specified in QueryString.

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.

pub fn get_client_request_token(&self) -> &Option<String>

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. An error is returned if a parameter, such as QueryString, has changed. A call to StartQueryExecution that uses a previous client request token returns the same QueryExecutionId even if the requester doesn't have permission on the tables specified in QueryString.

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.

pub fn query_execution_context(self, input: QueryExecutionContext) -> Self

The database within which the query executes.

pub fn set_query_execution_context( self, input: Option<QueryExecutionContext> ) -> Self

The database within which the query executes.

pub fn get_query_execution_context(&self) -> &Option<QueryExecutionContext>

The database within which the query executes.

pub fn result_configuration(self, input: ResultConfiguration) -> Self

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.

pub fn set_result_configuration( self, input: Option<ResultConfiguration> ) -> Self

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.

pub fn get_result_configuration(&self) -> &Option<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.

pub fn work_group(self, input: impl Into<String>) -> Self

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

pub fn set_work_group(self, input: Option<String>) -> Self

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

pub fn get_work_group(&self) -> &Option<String>

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

pub fn execution_parameters(self, input: impl Into<String>) -> Self

Appends an item to execution_parameters.

To override the contents of this collection use set_execution_parameters.

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.

pub fn set_execution_parameters(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_execution_parameters(&self) -> &Option<Vec<String>>

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.

pub fn result_reuse_configuration(self, input: ResultReuseConfiguration) -> Self

Specifies the query result reuse behavior for the query.

pub fn set_result_reuse_configuration( self, input: Option<ResultReuseConfiguration> ) -> Self

Specifies the query result reuse behavior for the query.

pub fn get_result_reuse_configuration( &self ) -> &Option<ResultReuseConfiguration>

Specifies the query result reuse behavior for the query.

pub fn build(self) -> Result<StartQueryExecutionInput, BuildError>

Consumes the builder and constructs a StartQueryExecutionInput.

impl StartQueryExecutionInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<StartQueryExecutionOutput, SdkError<StartQueryExecutionError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for StartQueryExecutionInputBuilder

fn clone(&self) -> StartQueryExecutionInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartQueryExecutionInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StartQueryExecutionInputBuilder

fn default() -> StartQueryExecutionInputBuilder

Returns the “default value” for a type.

impl PartialEq for StartQueryExecutionInputBuilder

fn eq(&self, other: &StartQueryExecutionInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartQueryExecutionInputBuilder