aws_sdk_lightsail/operation/get_relational_database_metric_data/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_relational_database_metric_data::_get_relational_database_metric_data_output::GetRelationalDatabaseMetricDataOutputBuilder;

pub use crate::operation::get_relational_database_metric_data::_get_relational_database_metric_data_input::GetRelationalDatabaseMetricDataInputBuilder;

impl crate::operation::get_relational_database_metric_data::builders::GetRelationalDatabaseMetricDataInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricDataOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricDataError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.get_relational_database_metric_data();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `GetRelationalDatabaseMetricData`.
///
/// <p>Returns the data points of the specified metric for a database in Amazon Lightsail.</p>
/// <p>Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetRelationalDatabaseMetricDataFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::get_relational_database_metric_data::builders::GetRelationalDatabaseMetricDataInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricDataOutput,
        crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricDataError,
    > for GetRelationalDatabaseMetricDataFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricDataOutput,
            crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricDataError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl GetRelationalDatabaseMetricDataFluentBuilder {
    /// Creates a new `GetRelationalDatabaseMetricDataFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the GetRelationalDatabaseMetricData as a reference.
    pub fn as_input(&self) -> &crate::operation::get_relational_database_metric_data::builders::GetRelationalDatabaseMetricDataInputBuilder {
        &self.inner
    }
    /// 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](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricDataOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricDataError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricData::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricData::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricDataOutput,
        crate::operation::get_relational_database_metric_data::GetRelationalDatabaseMetricDataError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The name of your database from which to get metric data.</p>
    pub fn relational_database_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.relational_database_name(input.into());
        self
    }
    /// <p>The name of your database from which to get metric data.</p>
    pub fn set_relational_database_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_relational_database_name(input);
        self
    }
    /// <p>The name of your database from which to get metric data.</p>
    pub fn get_relational_database_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_relational_database_name()
    }
    /// <p>The metric for which you want to return information.</p>
    /// <p>Valid relational database metric names are listed below, along with the most useful <code>statistics</code> to include in your request, and the published <code>unit</code> value. All relational database metric data is available in 1-minute (60 seconds) granularity.</p>
    /// <ul>
    /// <li>
    /// <p><b> <code>CPUUtilization</code> </b> - The percentage of CPU utilization currently in use on the database.</p>
    /// <p><code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Average</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
    /// <li>
    /// <p><b> <code>DatabaseConnections</code> </b> - The number of database connections in use.</p>
    /// <p><code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Sum</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Count</code>.</p></li>
    /// <li>
    /// <p><b> <code>DiskQueueDepth</code> </b> - The number of outstanding IOs (read/write requests) that are waiting to access the disk.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Count</code>.</p></li>
    /// <li>
    /// <p><b> <code>FreeStorageSpace</code> </b> - The amount of available storage space.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Bytes</code>.</p></li>
    /// <li>
    /// <p><b> <code>NetworkReceiveThroughput</code> </b> - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Bytes/Second</code>.</p></li>
    /// <li>
    /// <p><b> <code>NetworkTransmitThroughput</code> </b> - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Bytes/Second</code>.</p></li>
    /// </ul>
    pub fn metric_name(mut self, input: crate::types::RelationalDatabaseMetricName) -> Self {
        self.inner = self.inner.metric_name(input);
        self
    }
    /// <p>The metric for which you want to return information.</p>
    /// <p>Valid relational database metric names are listed below, along with the most useful <code>statistics</code> to include in your request, and the published <code>unit</code> value. All relational database metric data is available in 1-minute (60 seconds) granularity.</p>
    /// <ul>
    /// <li>
    /// <p><b> <code>CPUUtilization</code> </b> - The percentage of CPU utilization currently in use on the database.</p>
    /// <p><code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Average</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
    /// <li>
    /// <p><b> <code>DatabaseConnections</code> </b> - The number of database connections in use.</p>
    /// <p><code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Sum</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Count</code>.</p></li>
    /// <li>
    /// <p><b> <code>DiskQueueDepth</code> </b> - The number of outstanding IOs (read/write requests) that are waiting to access the disk.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Count</code>.</p></li>
    /// <li>
    /// <p><b> <code>FreeStorageSpace</code> </b> - The amount of available storage space.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Bytes</code>.</p></li>
    /// <li>
    /// <p><b> <code>NetworkReceiveThroughput</code> </b> - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Bytes/Second</code>.</p></li>
    /// <li>
    /// <p><b> <code>NetworkTransmitThroughput</code> </b> - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Bytes/Second</code>.</p></li>
    /// </ul>
    pub fn set_metric_name(mut self, input: ::std::option::Option<crate::types::RelationalDatabaseMetricName>) -> Self {
        self.inner = self.inner.set_metric_name(input);
        self
    }
    /// <p>The metric for which you want to return information.</p>
    /// <p>Valid relational database metric names are listed below, along with the most useful <code>statistics</code> to include in your request, and the published <code>unit</code> value. All relational database metric data is available in 1-minute (60 seconds) granularity.</p>
    /// <ul>
    /// <li>
    /// <p><b> <code>CPUUtilization</code> </b> - The percentage of CPU utilization currently in use on the database.</p>
    /// <p><code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Average</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Percent</code>.</p></li>
    /// <li>
    /// <p><b> <code>DatabaseConnections</code> </b> - The number of database connections in use.</p>
    /// <p><code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Sum</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Count</code>.</p></li>
    /// <li>
    /// <p><b> <code>DiskQueueDepth</code> </b> - The number of outstanding IOs (read/write requests) that are waiting to access the disk.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Count</code>.</p></li>
    /// <li>
    /// <p><b> <code>FreeStorageSpace</code> </b> - The amount of available storage space.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Bytes</code>.</p></li>
    /// <li>
    /// <p><b> <code>NetworkReceiveThroughput</code> </b> - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Bytes/Second</code>.</p></li>
    /// <li>
    /// <p><b> <code>NetworkTransmitThroughput</code> </b> - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.</p>
    /// <p><code>Statistics</code>: The most useful statistic is <code>Average</code>.</p>
    /// <p><code>Unit</code>: The published unit is <code>Bytes/Second</code>.</p></li>
    /// </ul>
    pub fn get_metric_name(&self) -> &::std::option::Option<crate::types::RelationalDatabaseMetricName> {
        self.inner.get_metric_name()
    }
    /// <p>The granularity, in seconds, of the returned data points.</p>
    /// <p>All relational database metric data is available in 1-minute (60 seconds) granularity.</p>
    pub fn period(mut self, input: i32) -> Self {
        self.inner = self.inner.period(input);
        self
    }
    /// <p>The granularity, in seconds, of the returned data points.</p>
    /// <p>All relational database metric data is available in 1-minute (60 seconds) granularity.</p>
    pub fn set_period(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_period(input);
        self
    }
    /// <p>The granularity, in seconds, of the returned data points.</p>
    /// <p>All relational database metric data is available in 1-minute (60 seconds) granularity.</p>
    pub fn get_period(&self) -> &::std::option::Option<i32> {
        self.inner.get_period()
    }
    /// <p>The start of the time interval from which to get metric data.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>Specified in Coordinated Universal Time (UTC).</p></li>
    /// <li>
    /// <p>Specified in the Unix time format.</p>
    /// <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the start time.</p></li>
    /// </ul>
    pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.start_time(input);
        self
    }
    /// <p>The start of the time interval from which to get metric data.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>Specified in Coordinated Universal Time (UTC).</p></li>
    /// <li>
    /// <p>Specified in the Unix time format.</p>
    /// <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the start time.</p></li>
    /// </ul>
    pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_start_time(input);
        self
    }
    /// <p>The start of the time interval from which to get metric data.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>Specified in Coordinated Universal Time (UTC).</p></li>
    /// <li>
    /// <p>Specified in the Unix time format.</p>
    /// <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the start time.</p></li>
    /// </ul>
    pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_start_time()
    }
    /// <p>The end of the time interval from which to get metric data.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>Specified in Coordinated Universal Time (UTC).</p></li>
    /// <li>
    /// <p>Specified in the Unix time format.</p>
    /// <p>For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the end time.</p></li>
    /// </ul>
    pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.end_time(input);
        self
    }
    /// <p>The end of the time interval from which to get metric data.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>Specified in Coordinated Universal Time (UTC).</p></li>
    /// <li>
    /// <p>Specified in the Unix time format.</p>
    /// <p>For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the end time.</p></li>
    /// </ul>
    pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_end_time(input);
        self
    }
    /// <p>The end of the time interval from which to get metric data.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>Specified in Coordinated Universal Time (UTC).</p></li>
    /// <li>
    /// <p>Specified in the Unix time format.</p>
    /// <p>For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the end time.</p></li>
    /// </ul>
    pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_end_time()
    }
    /// <p>The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the <code>metricName</code> parameter.</p>
    pub fn unit(mut self, input: crate::types::MetricUnit) -> Self {
        self.inner = self.inner.unit(input);
        self
    }
    /// <p>The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the <code>metricName</code> parameter.</p>
    pub fn set_unit(mut self, input: ::std::option::Option<crate::types::MetricUnit>) -> Self {
        self.inner = self.inner.set_unit(input);
        self
    }
    /// <p>The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the <code>metricName</code> parameter.</p>
    pub fn get_unit(&self) -> &::std::option::Option<crate::types::MetricUnit> {
        self.inner.get_unit()
    }
    ///
    /// Appends an item to `statistics`.
    ///
    /// To override the contents of this collection use [`set_statistics`](Self::set_statistics).
    ///
    /// <p>The statistic for the metric.</p>
    /// <p>The following statistics are available:</p>
    /// <ul>
    /// <li>
    /// <p><code>Minimum</code> - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.</p></li>
    /// <li>
    /// <p><code>Maximum</code> - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.</p></li>
    /// <li>
    /// <p><code>Sum</code> - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.</p></li>
    /// <li>
    /// <p><code>Average</code> - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.</p></li>
    /// <li>
    /// <p><code>SampleCount</code> - The count, or number, of data points used for the statistical calculation.</p></li>
    /// </ul>
    pub fn statistics(mut self, input: crate::types::MetricStatistic) -> Self {
        self.inner = self.inner.statistics(input);
        self
    }
    /// <p>The statistic for the metric.</p>
    /// <p>The following statistics are available:</p>
    /// <ul>
    /// <li>
    /// <p><code>Minimum</code> - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.</p></li>
    /// <li>
    /// <p><code>Maximum</code> - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.</p></li>
    /// <li>
    /// <p><code>Sum</code> - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.</p></li>
    /// <li>
    /// <p><code>Average</code> - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.</p></li>
    /// <li>
    /// <p><code>SampleCount</code> - The count, or number, of data points used for the statistical calculation.</p></li>
    /// </ul>
    pub fn set_statistics(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::MetricStatistic>>) -> Self {
        self.inner = self.inner.set_statistics(input);
        self
    }
    /// <p>The statistic for the metric.</p>
    /// <p>The following statistics are available:</p>
    /// <ul>
    /// <li>
    /// <p><code>Minimum</code> - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.</p></li>
    /// <li>
    /// <p><code>Maximum</code> - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.</p></li>
    /// <li>
    /// <p><code>Sum</code> - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.</p></li>
    /// <li>
    /// <p><code>Average</code> - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.</p></li>
    /// <li>
    /// <p><code>SampleCount</code> - The count, or number, of data points used for the statistical calculation.</p></li>
    /// </ul>
    pub fn get_statistics(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::MetricStatistic>> {
        self.inner.get_statistics()
    }
}