aws-sdk-cloudwatchlogs 1.118.0

AWS SDK for Amazon CloudWatch Logs
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateScheduledQueryInput {
    /// <p>The ARN or name of the scheduled query to update.</p>
    pub identifier: ::std::option::Option<::std::string::String>,
    /// <p>An updated description for the scheduled query.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The updated query language for the scheduled query.</p>
    pub query_language: ::std::option::Option<crate::types::QueryLanguage>,
    /// <p>The updated query string to execute.</p>
    pub query_string: ::std::option::Option<::std::string::String>,
    /// <p>The updated array of log group names or ARNs to query.</p>
    pub log_group_identifiers: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The updated cron expression that defines when the scheduled query runs.</p>
    pub schedule_expression: ::std::option::Option<::std::string::String>,
    /// <p>The updated timezone for evaluating the schedule expression.</p>
    pub timezone: ::std::option::Option<::std::string::String>,
    /// <p>The updated time offset in seconds that defines the lookback period for the query.</p>
    pub start_time_offset: ::std::option::Option<i64>,
    /// <p>The updated configuration for where to deliver query results.</p>
    pub destination_configuration: ::std::option::Option<crate::types::DestinationConfiguration>,
    /// <p>The updated start time for the scheduled query in Unix epoch format.</p>
    pub schedule_start_time: ::std::option::Option<i64>,
    /// <p>The updated end time for the scheduled query in Unix epoch format.</p>
    pub schedule_end_time: ::std::option::Option<i64>,
    /// <p>The updated ARN of the IAM role that grants permissions to execute the query and deliver results.</p>
    pub execution_role_arn: ::std::option::Option<::std::string::String>,
    /// <p>The updated state of the scheduled query.</p>
    pub state: ::std::option::Option<crate::types::ScheduledQueryState>,
}
impl UpdateScheduledQueryInput {
    /// <p>The ARN or name of the scheduled query to update.</p>
    pub fn identifier(&self) -> ::std::option::Option<&str> {
        self.identifier.as_deref()
    }
    /// <p>An updated description for the scheduled query.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The updated query language for the scheduled query.</p>
    pub fn query_language(&self) -> ::std::option::Option<&crate::types::QueryLanguage> {
        self.query_language.as_ref()
    }
    /// <p>The updated query string to execute.</p>
    pub fn query_string(&self) -> ::std::option::Option<&str> {
        self.query_string.as_deref()
    }
    /// <p>The updated array of log group names or ARNs to query.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.log_group_identifiers.is_none()`.
    pub fn log_group_identifiers(&self) -> &[::std::string::String] {
        self.log_group_identifiers.as_deref().unwrap_or_default()
    }
    /// <p>The updated cron expression that defines when the scheduled query runs.</p>
    pub fn schedule_expression(&self) -> ::std::option::Option<&str> {
        self.schedule_expression.as_deref()
    }
    /// <p>The updated timezone for evaluating the schedule expression.</p>
    pub fn timezone(&self) -> ::std::option::Option<&str> {
        self.timezone.as_deref()
    }
    /// <p>The updated time offset in seconds that defines the lookback period for the query.</p>
    pub fn start_time_offset(&self) -> ::std::option::Option<i64> {
        self.start_time_offset
    }
    /// <p>The updated configuration for where to deliver query results.</p>
    pub fn destination_configuration(&self) -> ::std::option::Option<&crate::types::DestinationConfiguration> {
        self.destination_configuration.as_ref()
    }
    /// <p>The updated start time for the scheduled query in Unix epoch format.</p>
    pub fn schedule_start_time(&self) -> ::std::option::Option<i64> {
        self.schedule_start_time
    }
    /// <p>The updated end time for the scheduled query in Unix epoch format.</p>
    pub fn schedule_end_time(&self) -> ::std::option::Option<i64> {
        self.schedule_end_time
    }
    /// <p>The updated ARN of the IAM role that grants permissions to execute the query and deliver results.</p>
    pub fn execution_role_arn(&self) -> ::std::option::Option<&str> {
        self.execution_role_arn.as_deref()
    }
    /// <p>The updated state of the scheduled query.</p>
    pub fn state(&self) -> ::std::option::Option<&crate::types::ScheduledQueryState> {
        self.state.as_ref()
    }
}
impl UpdateScheduledQueryInput {
    /// Creates a new builder-style object to manufacture [`UpdateScheduledQueryInput`](crate::operation::update_scheduled_query::UpdateScheduledQueryInput).
    pub fn builder() -> crate::operation::update_scheduled_query::builders::UpdateScheduledQueryInputBuilder {
        crate::operation::update_scheduled_query::builders::UpdateScheduledQueryInputBuilder::default()
    }
}

/// A builder for [`UpdateScheduledQueryInput`](crate::operation::update_scheduled_query::UpdateScheduledQueryInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateScheduledQueryInputBuilder {
    pub(crate) identifier: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) query_language: ::std::option::Option<crate::types::QueryLanguage>,
    pub(crate) query_string: ::std::option::Option<::std::string::String>,
    pub(crate) log_group_identifiers: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) schedule_expression: ::std::option::Option<::std::string::String>,
    pub(crate) timezone: ::std::option::Option<::std::string::String>,
    pub(crate) start_time_offset: ::std::option::Option<i64>,
    pub(crate) destination_configuration: ::std::option::Option<crate::types::DestinationConfiguration>,
    pub(crate) schedule_start_time: ::std::option::Option<i64>,
    pub(crate) schedule_end_time: ::std::option::Option<i64>,
    pub(crate) execution_role_arn: ::std::option::Option<::std::string::String>,
    pub(crate) state: ::std::option::Option<crate::types::ScheduledQueryState>,
}
impl UpdateScheduledQueryInputBuilder {
    /// <p>The ARN or name of the scheduled query to update.</p>
    /// This field is required.
    pub fn identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN or name of the scheduled query to update.</p>
    pub fn set_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.identifier = input;
        self
    }
    /// <p>The ARN or name of the scheduled query to update.</p>
    pub fn get_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.identifier
    }
    /// <p>An updated description for the scheduled query.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>An updated description for the scheduled query.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>An updated description for the scheduled query.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The updated query language for the scheduled query.</p>
    /// This field is required.
    pub fn query_language(mut self, input: crate::types::QueryLanguage) -> Self {
        self.query_language = ::std::option::Option::Some(input);
        self
    }
    /// <p>The updated query language for the scheduled query.</p>
    pub fn set_query_language(mut self, input: ::std::option::Option<crate::types::QueryLanguage>) -> Self {
        self.query_language = input;
        self
    }
    /// <p>The updated query language for the scheduled query.</p>
    pub fn get_query_language(&self) -> &::std::option::Option<crate::types::QueryLanguage> {
        &self.query_language
    }
    /// <p>The updated query string to execute.</p>
    /// This field is required.
    pub fn query_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.query_string = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The updated query string to execute.</p>
    pub fn set_query_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.query_string = input;
        self
    }
    /// <p>The updated query string to execute.</p>
    pub fn get_query_string(&self) -> &::std::option::Option<::std::string::String> {
        &self.query_string
    }
    /// Appends an item to `log_group_identifiers`.
    ///
    /// To override the contents of this collection use [`set_log_group_identifiers`](Self::set_log_group_identifiers).
    ///
    /// <p>The updated array of log group names or ARNs to query.</p>
    pub fn log_group_identifiers(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.log_group_identifiers.unwrap_or_default();
        v.push(input.into());
        self.log_group_identifiers = ::std::option::Option::Some(v);
        self
    }
    /// <p>The updated array of log group names or ARNs to query.</p>
    pub fn set_log_group_identifiers(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.log_group_identifiers = input;
        self
    }
    /// <p>The updated array of log group names or ARNs to query.</p>
    pub fn get_log_group_identifiers(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.log_group_identifiers
    }
    /// <p>The updated cron expression that defines when the scheduled query runs.</p>
    /// This field is required.
    pub fn schedule_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.schedule_expression = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The updated cron expression that defines when the scheduled query runs.</p>
    pub fn set_schedule_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.schedule_expression = input;
        self
    }
    /// <p>The updated cron expression that defines when the scheduled query runs.</p>
    pub fn get_schedule_expression(&self) -> &::std::option::Option<::std::string::String> {
        &self.schedule_expression
    }
    /// <p>The updated timezone for evaluating the schedule expression.</p>
    pub fn timezone(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.timezone = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The updated timezone for evaluating the schedule expression.</p>
    pub fn set_timezone(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.timezone = input;
        self
    }
    /// <p>The updated timezone for evaluating the schedule expression.</p>
    pub fn get_timezone(&self) -> &::std::option::Option<::std::string::String> {
        &self.timezone
    }
    /// <p>The updated time offset in seconds that defines the lookback period for the query.</p>
    pub fn start_time_offset(mut self, input: i64) -> Self {
        self.start_time_offset = ::std::option::Option::Some(input);
        self
    }
    /// <p>The updated time offset in seconds that defines the lookback period for the query.</p>
    pub fn set_start_time_offset(mut self, input: ::std::option::Option<i64>) -> Self {
        self.start_time_offset = input;
        self
    }
    /// <p>The updated time offset in seconds that defines the lookback period for the query.</p>
    pub fn get_start_time_offset(&self) -> &::std::option::Option<i64> {
        &self.start_time_offset
    }
    /// <p>The updated configuration for where to deliver query results.</p>
    pub fn destination_configuration(mut self, input: crate::types::DestinationConfiguration) -> Self {
        self.destination_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The updated configuration for where to deliver query results.</p>
    pub fn set_destination_configuration(mut self, input: ::std::option::Option<crate::types::DestinationConfiguration>) -> Self {
        self.destination_configuration = input;
        self
    }
    /// <p>The updated configuration for where to deliver query results.</p>
    pub fn get_destination_configuration(&self) -> &::std::option::Option<crate::types::DestinationConfiguration> {
        &self.destination_configuration
    }
    /// <p>The updated start time for the scheduled query in Unix epoch format.</p>
    pub fn schedule_start_time(mut self, input: i64) -> Self {
        self.schedule_start_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The updated start time for the scheduled query in Unix epoch format.</p>
    pub fn set_schedule_start_time(mut self, input: ::std::option::Option<i64>) -> Self {
        self.schedule_start_time = input;
        self
    }
    /// <p>The updated start time for the scheduled query in Unix epoch format.</p>
    pub fn get_schedule_start_time(&self) -> &::std::option::Option<i64> {
        &self.schedule_start_time
    }
    /// <p>The updated end time for the scheduled query in Unix epoch format.</p>
    pub fn schedule_end_time(mut self, input: i64) -> Self {
        self.schedule_end_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The updated end time for the scheduled query in Unix epoch format.</p>
    pub fn set_schedule_end_time(mut self, input: ::std::option::Option<i64>) -> Self {
        self.schedule_end_time = input;
        self
    }
    /// <p>The updated end time for the scheduled query in Unix epoch format.</p>
    pub fn get_schedule_end_time(&self) -> &::std::option::Option<i64> {
        &self.schedule_end_time
    }
    /// <p>The updated ARN of the IAM role that grants permissions to execute the query and deliver results.</p>
    /// This field is required.
    pub fn execution_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.execution_role_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The updated ARN of the IAM role that grants permissions to execute the query and deliver results.</p>
    pub fn set_execution_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.execution_role_arn = input;
        self
    }
    /// <p>The updated ARN of the IAM role that grants permissions to execute the query and deliver results.</p>
    pub fn get_execution_role_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.execution_role_arn
    }
    /// <p>The updated state of the scheduled query.</p>
    pub fn state(mut self, input: crate::types::ScheduledQueryState) -> Self {
        self.state = ::std::option::Option::Some(input);
        self
    }
    /// <p>The updated state of the scheduled query.</p>
    pub fn set_state(mut self, input: ::std::option::Option<crate::types::ScheduledQueryState>) -> Self {
        self.state = input;
        self
    }
    /// <p>The updated state of the scheduled query.</p>
    pub fn get_state(&self) -> &::std::option::Option<crate::types::ScheduledQueryState> {
        &self.state
    }
    /// Consumes the builder and constructs a [`UpdateScheduledQueryInput`](crate::operation::update_scheduled_query::UpdateScheduledQueryInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::update_scheduled_query::UpdateScheduledQueryInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::update_scheduled_query::UpdateScheduledQueryInput {
            identifier: self.identifier,
            description: self.description,
            query_language: self.query_language,
            query_string: self.query_string,
            log_group_identifiers: self.log_group_identifiers,
            schedule_expression: self.schedule_expression,
            timezone: self.timezone,
            start_time_offset: self.start_time_offset,
            destination_configuration: self.destination_configuration,
            schedule_start_time: self.schedule_start_time,
            schedule_end_time: self.schedule_end_time,
            execution_role_arn: self.execution_role_arn,
            state: self.state,
        })
    }
}