Struct aws_sdk_timestreamquery::operation::create_scheduled_query::builders::CreateScheduledQueryInputBuilder

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

A builder for CreateScheduledQueryInput.

Implementations

impl CreateScheduledQueryInputBuilder

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

Name of the scheduled query.

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

Name of the scheduled query.

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

Name of the scheduled query.

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.

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.

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.

pub fn schedule_configuration(self, input: ScheduleConfiguration) -> Self

The schedule configuration for the query.

pub fn set_schedule_configuration( self, input: Option<ScheduleConfiguration> ) -> Self

The schedule configuration for the query.

pub fn get_schedule_configuration(&self) -> &Option<ScheduleConfiguration>

The schedule configuration for the query.

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.

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.

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.

pub fn target_configuration(self, input: TargetConfiguration) -> Self

Configuration used for writing the result of a query.

pub fn set_target_configuration( self, input: Option<TargetConfiguration> ) -> Self

Configuration used for writing the result of a query.

pub fn get_target_configuration(&self) -> &Option<TargetConfiguration>

Configuration used for writing the result of a query.

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 a ClientToken on your behalf.

• After 8 hours, any request with the same ClientToken is treated as a new request.

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 a ClientToken on your behalf.

• After 8 hours, any request with the same ClientToken is treated as a new request.

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 a ClientToken on your behalf.

• After 8 hours, any request with the same ClientToken is treated as a new request.

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.

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.

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.

pub fn tags(self, input: Tag) -> Self

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.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of key-value pairs to label the scheduled query.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

A list of key-value pairs to label the scheduled query.

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.

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.

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.

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.

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.

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.

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

Consumes the builder and constructs a CreateScheduledQueryInput.

impl CreateScheduledQueryInputBuilder

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

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateScheduledQueryInputBuilder

fn clone(&self) -> CreateScheduledQueryInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateScheduledQueryInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateScheduledQueryInputBuilder

fn default() -> CreateScheduledQueryInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateScheduledQueryInputBuilder

fn eq(&self, other: &CreateScheduledQueryInputBuilder) -> 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 CreateScheduledQueryInputBuilder