Struct aws_sdk_pi::types::builders::MetricQueryBuilder

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

A builder for MetricQuery.

Implementations

impl MetricQueryBuilder

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

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

• db.load.avg - A scaled representation of the number of active sessions for the database engine.

• db.sampledload.avg - The raw number of active sessions for the database engine.

• The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

• The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

This field is required.

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

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

• db.load.avg - A scaled representation of the number of active sessions for the database engine.

• db.sampledload.avg - The raw number of active sessions for the database engine.

• The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

• The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

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

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

• db.load.avg - A scaled representation of the number of active sessions for the database engine.

• db.sampledload.avg - The raw number of active sessions for the database engine.

• The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

• The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

pub fn group_by(self, input: DimensionGroup) -> Self

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

pub fn set_group_by(self, input: Option<DimensionGroup>) -> Self

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

pub fn get_group_by(&self) -> &Option<DimensionGroup>

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

pub fn filter(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to filter.

To override the contents of this collection use set_filter.

One or more filters to apply in the request. Restrictions:

• Any number of filters by the same dimension, as specified in the GroupBy parameter.

• A single filter for any other dimension in this dimension group.

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

One or more filters to apply in the request. Restrictions:

• Any number of filters by the same dimension, as specified in the GroupBy parameter.

• A single filter for any other dimension in this dimension group.

pub fn get_filter(&self) -> &Option<HashMap<String, String>>

One or more filters to apply in the request. Restrictions:

• Any number of filters by the same dimension, as specified in the GroupBy parameter.

• A single filter for any other dimension in this dimension group.

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

Consumes the builder and constructs a MetricQuery. This method will fail if any of the following fields are not set:

• metric

Trait Implementations

impl Clone for MetricQueryBuilder

fn clone(&self) -> MetricQueryBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricQueryBuilder

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

Formats the value using the given formatter.

impl Default for MetricQueryBuilder

fn default() -> MetricQueryBuilder

Returns the “default value” for a type.

impl PartialEq for MetricQueryBuilder

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