#[non_exhaustive]pub struct GetRelationalDatabaseMetricDataInputBuilder { /* private fields */ }
Expand description
A builder for GetRelationalDatabaseMetricDataInput
.
Implementations§
Source§impl GetRelationalDatabaseMetricDataInputBuilder
impl GetRelationalDatabaseMetricDataInputBuilder
Sourcepub fn relational_database_name(self, input: impl Into<String>) -> Self
pub fn relational_database_name(self, input: impl Into<String>) -> Self
The name of your database from which to get metric data.
This field is required.Sourcepub fn set_relational_database_name(self, input: Option<String>) -> Self
pub fn set_relational_database_name(self, input: Option<String>) -> Self
The name of your database from which to get metric data.
Sourcepub fn get_relational_database_name(&self) -> &Option<String>
pub fn get_relational_database_name(&self) -> &Option<String>
The name of your database from which to get metric data.
Sourcepub fn metric_name(self, input: RelationalDatabaseMetricName) -> Self
pub fn metric_name(self, input: RelationalDatabaseMetricName) -> Self
The metric for which you want to return information.
Valid relational database metric names are listed below, along with the most useful statistics
to include in your request, and the published unit
value. All relational database metric data is available in 1-minute (60 seconds) granularity.
-
CPUUtilization
- The percentage of CPU utilization currently in use on the database.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
. -
DatabaseConnections
- The number of database connections in use.Statistics
: The most useful statistics areMaximum
andSum
.Unit
: The published unit isCount
. -
DiskQueueDepth
- The number of outstanding IOs (read/write requests) that are waiting to access the disk.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
. -
FreeStorageSpace
- The amount of available storage space.Statistics
: The most useful statistic isSum
.Unit
: The published unit isBytes
. -
NetworkReceiveThroughput
- The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isBytes/Second
. -
NetworkTransmitThroughput
- The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isBytes/Second
.
Sourcepub fn set_metric_name(
self,
input: Option<RelationalDatabaseMetricName>,
) -> Self
pub fn set_metric_name( self, input: Option<RelationalDatabaseMetricName>, ) -> Self
The metric for which you want to return information.
Valid relational database metric names are listed below, along with the most useful statistics
to include in your request, and the published unit
value. All relational database metric data is available in 1-minute (60 seconds) granularity.
-
CPUUtilization
- The percentage of CPU utilization currently in use on the database.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
. -
DatabaseConnections
- The number of database connections in use.Statistics
: The most useful statistics areMaximum
andSum
.Unit
: The published unit isCount
. -
DiskQueueDepth
- The number of outstanding IOs (read/write requests) that are waiting to access the disk.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
. -
FreeStorageSpace
- The amount of available storage space.Statistics
: The most useful statistic isSum
.Unit
: The published unit isBytes
. -
NetworkReceiveThroughput
- The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isBytes/Second
. -
NetworkTransmitThroughput
- The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isBytes/Second
.
Sourcepub fn get_metric_name(&self) -> &Option<RelationalDatabaseMetricName>
pub fn get_metric_name(&self) -> &Option<RelationalDatabaseMetricName>
The metric for which you want to return information.
Valid relational database metric names are listed below, along with the most useful statistics
to include in your request, and the published unit
value. All relational database metric data is available in 1-minute (60 seconds) granularity.
-
CPUUtilization
- The percentage of CPU utilization currently in use on the database.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
. -
DatabaseConnections
- The number of database connections in use.Statistics
: The most useful statistics areMaximum
andSum
.Unit
: The published unit isCount
. -
DiskQueueDepth
- The number of outstanding IOs (read/write requests) that are waiting to access the disk.Statistics
: The most useful statistic isSum
.Unit
: The published unit isCount
. -
FreeStorageSpace
- The amount of available storage space.Statistics
: The most useful statistic isSum
.Unit
: The published unit isBytes
. -
NetworkReceiveThroughput
- The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isBytes/Second
. -
NetworkTransmitThroughput
- The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.Statistics
: The most useful statistic isAverage
.Unit
: The published unit isBytes/Second
.
Sourcepub fn period(self, input: i32) -> Self
pub fn period(self, input: i32) -> Self
The granularity, in seconds, of the returned data points.
All relational database metric data is available in 1-minute (60 seconds) granularity.
This field is required.Sourcepub fn set_period(self, input: Option<i32>) -> Self
pub fn set_period(self, input: Option<i32>) -> Self
The granularity, in seconds, of the returned data points.
All relational database metric data is available in 1-minute (60 seconds) granularity.
Sourcepub fn get_period(&self) -> &Option<i32>
pub fn get_period(&self) -> &Option<i32>
The granularity, in seconds, of the returned data points.
All relational database metric data is available in 1-minute (60 seconds) granularity.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The start of the time interval from which to get metric data.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input
1538424000
as the start time.
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The start of the time interval from which to get metric data.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input
1538424000
as the start time.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The start of the time interval from which to get metric data.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input
1538424000
as the start time.
Sourcepub fn end_time(self, input: DateTime) -> Self
pub fn end_time(self, input: DateTime) -> Self
The end of the time interval from which to get metric data.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input
1538424000
as the end time.
Sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
The end of the time interval from which to get metric data.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input
1538424000
as the end time.
Sourcepub fn get_end_time(&self) -> &Option<DateTime>
pub fn get_end_time(&self) -> &Option<DateTime>
The end of the time interval from which to get metric data.
Constraints:
-
Specified in Coordinated Universal Time (UTC).
-
Specified in the Unix time format.
For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input
1538424000
as the end time.
Sourcepub fn unit(self, input: MetricUnit) -> Self
pub fn unit(self, input: MetricUnit) -> Self
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 metricName
parameter.
Sourcepub fn set_unit(self, input: Option<MetricUnit>) -> Self
pub fn set_unit(self, input: Option<MetricUnit>) -> Self
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 metricName
parameter.
Sourcepub fn get_unit(&self) -> &Option<MetricUnit>
pub fn get_unit(&self) -> &Option<MetricUnit>
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 metricName
parameter.
Sourcepub fn statistics(self, input: MetricStatistic) -> Self
pub fn statistics(self, input: MetricStatistic) -> Self
Appends an item to statistics
.
To override the contents of this collection use set_statistics
.
The statistic for the metric.
The following statistics are available:
-
Minimum
- The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. -
Maximum
- The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. -
Sum
- All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. -
Average
- 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. -
SampleCount
- The count, or number, of data points used for the statistical calculation.
Sourcepub fn set_statistics(self, input: Option<Vec<MetricStatistic>>) -> Self
pub fn set_statistics(self, input: Option<Vec<MetricStatistic>>) -> Self
The statistic for the metric.
The following statistics are available:
-
Minimum
- The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. -
Maximum
- The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. -
Sum
- All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. -
Average
- 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. -
SampleCount
- The count, or number, of data points used for the statistical calculation.
Sourcepub fn get_statistics(&self) -> &Option<Vec<MetricStatistic>>
pub fn get_statistics(&self) -> &Option<Vec<MetricStatistic>>
The statistic for the metric.
The following statistics are available:
-
Minimum
- The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. -
Maximum
- The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. -
Sum
- All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. -
Average
- 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. -
SampleCount
- The count, or number, of data points used for the statistical calculation.
Sourcepub fn build(self) -> Result<GetRelationalDatabaseMetricDataInput, BuildError>
pub fn build(self) -> Result<GetRelationalDatabaseMetricDataInput, BuildError>
Consumes the builder and constructs a GetRelationalDatabaseMetricDataInput
.
Source§impl GetRelationalDatabaseMetricDataInputBuilder
impl GetRelationalDatabaseMetricDataInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<GetRelationalDatabaseMetricDataOutput, SdkError<GetRelationalDatabaseMetricDataError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<GetRelationalDatabaseMetricDataOutput, SdkError<GetRelationalDatabaseMetricDataError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for GetRelationalDatabaseMetricDataInputBuilder
impl Clone for GetRelationalDatabaseMetricDataInputBuilder
Source§fn clone(&self) -> GetRelationalDatabaseMetricDataInputBuilder
fn clone(&self) -> GetRelationalDatabaseMetricDataInputBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for GetRelationalDatabaseMetricDataInputBuilder
impl Default for GetRelationalDatabaseMetricDataInputBuilder
Source§fn default() -> GetRelationalDatabaseMetricDataInputBuilder
fn default() -> GetRelationalDatabaseMetricDataInputBuilder
Source§impl PartialEq for GetRelationalDatabaseMetricDataInputBuilder
impl PartialEq for GetRelationalDatabaseMetricDataInputBuilder
Source§fn eq(&self, other: &GetRelationalDatabaseMetricDataInputBuilder) -> bool
fn eq(&self, other: &GetRelationalDatabaseMetricDataInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for GetRelationalDatabaseMetricDataInputBuilder
Auto Trait Implementations§
impl Freeze for GetRelationalDatabaseMetricDataInputBuilder
impl RefUnwindSafe for GetRelationalDatabaseMetricDataInputBuilder
impl Send for GetRelationalDatabaseMetricDataInputBuilder
impl Sync for GetRelationalDatabaseMetricDataInputBuilder
impl Unpin for GetRelationalDatabaseMetricDataInputBuilder
impl UnwindSafe for GetRelationalDatabaseMetricDataInputBuilder
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);