#[non_exhaustive]pub struct QueryExecutionBuilder { /* private fields */ }
Expand description
A builder for QueryExecution
.
Implementations§
Source§impl QueryExecutionBuilder
impl QueryExecutionBuilder
Sourcepub fn query_execution_id(self, input: impl Into<String>) -> Self
pub fn query_execution_id(self, input: impl Into<String>) -> Self
The unique identifier for each query execution.
Sourcepub fn set_query_execution_id(self, input: Option<String>) -> Self
pub fn set_query_execution_id(self, input: Option<String>) -> Self
The unique identifier for each query execution.
Sourcepub fn get_query_execution_id(&self) -> &Option<String>
pub fn get_query_execution_id(&self) -> &Option<String>
The unique identifier for each query execution.
Sourcepub fn query(self, input: impl Into<String>) -> Self
pub fn query(self, input: impl Into<String>) -> Self
The SQL query statements which the query execution ran.
Sourcepub fn set_query(self, input: Option<String>) -> Self
pub fn set_query(self, input: Option<String>) -> Self
The SQL query statements which the query execution ran.
Sourcepub fn get_query(&self) -> &Option<String>
pub fn get_query(&self) -> &Option<String>
The SQL query statements which the query execution ran.
Sourcepub fn statement_type(self, input: StatementType) -> Self
pub fn statement_type(self, input: StatementType) -> Self
The type of query statement that was run. DDL
indicates DDL query statements. DML
indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT
. UTILITY
indicates query statements other than DDL and DML, such as SHOW CREATE TABLE
, or DESCRIBE TABLE
.
Sourcepub fn set_statement_type(self, input: Option<StatementType>) -> Self
pub fn set_statement_type(self, input: Option<StatementType>) -> Self
The type of query statement that was run. DDL
indicates DDL query statements. DML
indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT
. UTILITY
indicates query statements other than DDL and DML, such as SHOW CREATE TABLE
, or DESCRIBE TABLE
.
Sourcepub fn get_statement_type(&self) -> &Option<StatementType>
pub fn get_statement_type(&self) -> &Option<StatementType>
The type of query statement that was run. DDL
indicates DDL query statements. DML
indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT
. UTILITY
indicates query statements other than DDL and DML, such as SHOW CREATE TABLE
, or DESCRIBE TABLE
.
Sourcepub fn managed_query_results_configuration(
self,
input: ManagedQueryResultsConfiguration,
) -> Self
pub fn managed_query_results_configuration( self, input: ManagedQueryResultsConfiguration, ) -> Self
The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
Sourcepub fn set_managed_query_results_configuration(
self,
input: Option<ManagedQueryResultsConfiguration>,
) -> Self
pub fn set_managed_query_results_configuration( self, input: Option<ManagedQueryResultsConfiguration>, ) -> Self
The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
Sourcepub fn get_managed_query_results_configuration(
&self,
) -> &Option<ManagedQueryResultsConfiguration>
pub fn get_managed_query_results_configuration( &self, ) -> &Option<ManagedQueryResultsConfiguration>
The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.
Sourcepub fn result_configuration(self, input: ResultConfiguration) -> Self
pub fn result_configuration(self, input: ResultConfiguration) -> Self
The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.
Sourcepub fn set_result_configuration(
self,
input: Option<ResultConfiguration>,
) -> Self
pub fn set_result_configuration( self, input: Option<ResultConfiguration>, ) -> Self
The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.
Sourcepub fn get_result_configuration(&self) -> &Option<ResultConfiguration>
pub fn get_result_configuration(&self) -> &Option<ResultConfiguration>
The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.
Sourcepub fn result_reuse_configuration(self, input: ResultReuseConfiguration) -> Self
pub fn result_reuse_configuration(self, input: ResultReuseConfiguration) -> Self
Specifies the query result reuse behavior that was used for the query.
Sourcepub fn set_result_reuse_configuration(
self,
input: Option<ResultReuseConfiguration>,
) -> Self
pub fn set_result_reuse_configuration( self, input: Option<ResultReuseConfiguration>, ) -> Self
Specifies the query result reuse behavior that was used for the query.
Sourcepub fn get_result_reuse_configuration(
&self,
) -> &Option<ResultReuseConfiguration>
pub fn get_result_reuse_configuration( &self, ) -> &Option<ResultReuseConfiguration>
Specifies the query result reuse behavior that was used for the query.
Sourcepub fn query_execution_context(self, input: QueryExecutionContext) -> Self
pub fn query_execution_context(self, input: QueryExecutionContext) -> Self
The database in which the query execution occurred.
Sourcepub fn set_query_execution_context(
self,
input: Option<QueryExecutionContext>,
) -> Self
pub fn set_query_execution_context( self, input: Option<QueryExecutionContext>, ) -> Self
The database in which the query execution occurred.
Sourcepub fn get_query_execution_context(&self) -> &Option<QueryExecutionContext>
pub fn get_query_execution_context(&self) -> &Option<QueryExecutionContext>
The database in which the query execution occurred.
Sourcepub fn status(self, input: QueryExecutionStatus) -> Self
pub fn status(self, input: QueryExecutionStatus) -> Self
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
Sourcepub fn set_status(self, input: Option<QueryExecutionStatus>) -> Self
pub fn set_status(self, input: Option<QueryExecutionStatus>) -> Self
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
Sourcepub fn get_status(&self) -> &Option<QueryExecutionStatus>
pub fn get_status(&self) -> &Option<QueryExecutionStatus>
The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
Sourcepub fn statistics(self, input: QueryExecutionStatistics) -> Self
pub fn statistics(self, input: QueryExecutionStatistics) -> Self
Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.
Sourcepub fn set_statistics(self, input: Option<QueryExecutionStatistics>) -> Self
pub fn set_statistics(self, input: Option<QueryExecutionStatistics>) -> Self
Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.
Sourcepub fn get_statistics(&self) -> &Option<QueryExecutionStatistics>
pub fn get_statistics(&self) -> &Option<QueryExecutionStatistics>
Query execution statistics, such as the amount of data scanned, the amount of time that the query took to process, and the type of statement that was run.
Sourcepub fn work_group(self, input: impl Into<String>) -> Self
pub fn work_group(self, input: impl Into<String>) -> Self
The name of the workgroup in which the query ran.
Sourcepub fn set_work_group(self, input: Option<String>) -> Self
pub fn set_work_group(self, input: Option<String>) -> Self
The name of the workgroup in which the query ran.
Sourcepub fn get_work_group(&self) -> &Option<String>
pub fn get_work_group(&self) -> &Option<String>
The name of the workgroup in which the query ran.
Sourcepub fn engine_version(self, input: EngineVersion) -> Self
pub fn engine_version(self, input: EngineVersion) -> Self
The engine version that executed the query.
Sourcepub fn set_engine_version(self, input: Option<EngineVersion>) -> Self
pub fn set_engine_version(self, input: Option<EngineVersion>) -> Self
The engine version that executed the query.
Sourcepub fn get_engine_version(&self) -> &Option<EngineVersion>
pub fn get_engine_version(&self) -> &Option<EngineVersion>
The engine version that executed the query.
Sourcepub fn execution_parameters(self, input: impl Into<String>) -> Self
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. The list of parameters is not returned in the response.
Sourcepub fn set_execution_parameters(self, input: Option<Vec<String>>) -> Self
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. The list of parameters is not returned in the response.
Sourcepub fn get_execution_parameters(&self) -> &Option<Vec<String>>
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. The list of parameters is not returned in the response.
Sourcepub fn substatement_type(self, input: impl Into<String>) -> Self
pub fn substatement_type(self, input: impl Into<String>) -> Self
The kind of query statement that was run.
Sourcepub fn set_substatement_type(self, input: Option<String>) -> Self
pub fn set_substatement_type(self, input: Option<String>) -> Self
The kind of query statement that was run.
Sourcepub fn get_substatement_type(&self) -> &Option<String>
pub fn get_substatement_type(&self) -> &Option<String>
The kind of query statement that was run.
Sourcepub fn query_results_s3_access_grants_configuration(
self,
input: QueryResultsS3AccessGrantsConfiguration,
) -> Self
pub fn query_results_s3_access_grants_configuration( self, input: QueryResultsS3AccessGrantsConfiguration, ) -> Self
Specifies whether Amazon S3 access grants are enabled for query results.
Sourcepub fn set_query_results_s3_access_grants_configuration(
self,
input: Option<QueryResultsS3AccessGrantsConfiguration>,
) -> Self
pub fn set_query_results_s3_access_grants_configuration( self, input: Option<QueryResultsS3AccessGrantsConfiguration>, ) -> Self
Specifies whether Amazon S3 access grants are enabled for query results.
Sourcepub fn get_query_results_s3_access_grants_configuration(
&self,
) -> &Option<QueryResultsS3AccessGrantsConfiguration>
pub fn get_query_results_s3_access_grants_configuration( &self, ) -> &Option<QueryResultsS3AccessGrantsConfiguration>
Specifies whether Amazon S3 access grants are enabled for query results.
Sourcepub fn build(self) -> QueryExecution
pub fn build(self) -> QueryExecution
Consumes the builder and constructs a QueryExecution
.
Trait Implementations§
Source§impl Clone for QueryExecutionBuilder
impl Clone for QueryExecutionBuilder
Source§fn clone(&self) -> QueryExecutionBuilder
fn clone(&self) -> QueryExecutionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for QueryExecutionBuilder
impl Debug for QueryExecutionBuilder
Source§impl Default for QueryExecutionBuilder
impl Default for QueryExecutionBuilder
Source§fn default() -> QueryExecutionBuilder
fn default() -> QueryExecutionBuilder
Source§impl PartialEq for QueryExecutionBuilder
impl PartialEq for QueryExecutionBuilder
impl StructuralPartialEq for QueryExecutionBuilder
Auto Trait Implementations§
impl Freeze for QueryExecutionBuilder
impl RefUnwindSafe for QueryExecutionBuilder
impl Send for QueryExecutionBuilder
impl Sync for QueryExecutionBuilder
impl Unpin for QueryExecutionBuilder
impl UnwindSafe for QueryExecutionBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);