pub struct CreateScheduledQueryFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateScheduledQuery.
Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.
Implementations§
Source§impl CreateScheduledQueryFluentBuilder
impl CreateScheduledQueryFluentBuilder
Sourcepub fn as_input(&self) -> &CreateScheduledQueryInputBuilder
pub fn as_input(&self) -> &CreateScheduledQueryInputBuilder
Access the CreateScheduledQuery as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateScheduledQueryOutput, SdkError<CreateScheduledQueryError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateScheduledQueryOutput, SdkError<CreateScheduledQueryError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateScheduledQueryOutput, CreateScheduledQueryError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateScheduledQueryOutput, CreateScheduledQueryError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn query_string(self, input: impl Into<String>) -> Self
pub fn query_string(self, input: impl Into<String>) -> Self
The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.
The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
Sourcepub fn set_query_string(self, input: Option<String>) -> Self
pub fn set_query_string(self, input: Option<String>) -> Self
The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.
The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
Sourcepub fn get_query_string(&self) -> &Option<String>
pub fn get_query_string(&self) -> &Option<String>
The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run.
The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
Sourcepub fn schedule_configuration(self, input: ScheduleConfiguration) -> Self
pub fn schedule_configuration(self, input: ScheduleConfiguration) -> Self
The schedule configuration for the query.
Sourcepub fn set_schedule_configuration(
self,
input: Option<ScheduleConfiguration>,
) -> Self
pub fn set_schedule_configuration( self, input: Option<ScheduleConfiguration>, ) -> Self
The schedule configuration for the query.
Sourcepub fn get_schedule_configuration(&self) -> &Option<ScheduleConfiguration>
pub fn get_schedule_configuration(&self) -> &Option<ScheduleConfiguration>
The schedule configuration for the query.
Sourcepub fn notification_configuration(
self,
input: NotificationConfiguration,
) -> Self
pub fn notification_configuration( self, input: NotificationConfiguration, ) -> Self
Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
Sourcepub fn set_notification_configuration(
self,
input: Option<NotificationConfiguration>,
) -> Self
pub fn set_notification_configuration( self, input: Option<NotificationConfiguration>, ) -> Self
Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
Sourcepub fn get_notification_configuration(
&self,
) -> &Option<NotificationConfiguration>
pub fn get_notification_configuration( &self, ) -> &Option<NotificationConfiguration>
Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
Sourcepub fn target_configuration(self, input: TargetConfiguration) -> Self
pub fn target_configuration(self, input: TargetConfiguration) -> Self
Configuration used for writing the result of a query.
Sourcepub fn set_target_configuration(
self,
input: Option<TargetConfiguration>,
) -> Self
pub fn set_target_configuration( self, input: Option<TargetConfiguration>, ) -> Self
Configuration used for writing the result of a query.
Sourcepub fn get_target_configuration(&self) -> &Option<TargetConfiguration>
pub fn get_target_configuration(&self) -> &Option<TargetConfiguration>
Configuration used for writing the result of a query.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.
-
If CreateScheduledQuery is called without a
ClientToken, the Query SDK generates aClientTokenon your behalf. -
After 8 hours, any request with the same
ClientTokenis treated as a new request.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.
-
If CreateScheduledQuery is called without a
ClientToken, the Query SDK generates aClientTokenon your behalf. -
After 8 hours, any request with the same
ClientTokenis treated as a new request.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.
-
If CreateScheduledQuery is called without a
ClientToken, the Query SDK generates aClientTokenon your behalf. -
After 8 hours, any request with the same
ClientTokenis treated as a new request.
Sourcepub fn scheduled_query_execution_role_arn(
self,
input: impl Into<String>,
) -> Self
pub fn scheduled_query_execution_role_arn( self, input: impl Into<String>, ) -> Self
The ARN for the IAM role that Timestream will assume when running the scheduled query.
Sourcepub fn set_scheduled_query_execution_role_arn(
self,
input: Option<String>,
) -> Self
pub fn set_scheduled_query_execution_role_arn( self, input: Option<String>, ) -> Self
The ARN for the IAM role that Timestream will assume when running the scheduled query.
Sourcepub fn get_scheduled_query_execution_role_arn(&self) -> &Option<String>
pub fn get_scheduled_query_execution_role_arn(&self) -> &Option<String>
The ARN for the IAM role that Timestream will assume when running the scheduled query.
Appends an item to Tags.
To override the contents of this collection use set_tags.
A list of key-value pairs to label the scheduled query.
A list of key-value pairs to label the scheduled query.
A list of key-value pairs to label the scheduled query.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/
If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/
If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/
If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
Sourcepub fn error_report_configuration(self, input: ErrorReportConfiguration) -> Self
pub fn error_report_configuration(self, input: ErrorReportConfiguration) -> Self
Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
Sourcepub fn set_error_report_configuration(
self,
input: Option<ErrorReportConfiguration>,
) -> Self
pub fn set_error_report_configuration( self, input: Option<ErrorReportConfiguration>, ) -> Self
Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
Sourcepub fn get_error_report_configuration(
&self,
) -> &Option<ErrorReportConfiguration>
pub fn get_error_report_configuration( &self, ) -> &Option<ErrorReportConfiguration>
Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
Trait Implementations§
Source§impl Clone for CreateScheduledQueryFluentBuilder
impl Clone for CreateScheduledQueryFluentBuilder
Source§fn clone(&self) -> CreateScheduledQueryFluentBuilder
fn clone(&self) -> CreateScheduledQueryFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateScheduledQueryFluentBuilder
impl !RefUnwindSafe for CreateScheduledQueryFluentBuilder
impl Send for CreateScheduledQueryFluentBuilder
impl Sync for CreateScheduledQueryFluentBuilder
impl Unpin for CreateScheduledQueryFluentBuilder
impl !UnwindSafe for CreateScheduledQueryFluentBuilder
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);