Struct aws_sdk_iotwireless::types::SummaryMetricQueryResult

#[non_exhaustive]
pub struct SummaryMetricQueryResult {
    pub query_id: Option<String>,
    pub query_status: Option<MetricQueryStatus>,
    pub error: Option<String>,
    pub metric_name: Option<MetricName>,
    pub dimensions: Option<Vec<Dimension>>,
    pub aggregation_period: Option<AggregationPeriod>,
    pub start_timestamp: Option<DateTime>,
    pub end_timestamp: Option<DateTime>,
    pub timestamps: Option<Vec<DateTime>>,
    pub values: Option<Vec<MetricQueryValue>>,
    pub unit: Option<String>,
}

The result of metrics aggregation operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

query_id: Option<String>

The id of the query.

query_status: Option<MetricQueryStatus>

The status of the metric query.

error: Option<String>

The error message for the summary metric query.

metric_name: Option<MetricName>

The name of the metric.

dimensions: Option<Vec<Dimension>>

The dimensions of the metric.

aggregation_period: Option<AggregationPeriod>

The aggregation period of the metric.

start_timestamp: Option<DateTime>

The start timestamp for summary metric query.

end_timestamp: Option<DateTime>

The end timestamp for summary metric query.

timestamps: Option<Vec<DateTime>>

The timestamp of each aggregation result.

values: Option<Vec<MetricQueryValue>>

The list of aggregated metrics.

unit: Option<String>

The units of measurement to be used for interpreting the aggregation result.

Implementations

impl SummaryMetricQueryResult

pub fn query_id(&self) -> Option<&str>

The id of the query.

pub fn query_status(&self) -> Option<&MetricQueryStatus>

The status of the metric query.

pub fn error(&self) -> Option<&str>

The error message for the summary metric query.

pub fn metric_name(&self) -> Option<&MetricName>

The name of the metric.

pub fn dimensions(&self) -> &[Dimension]

The dimensions of the metric.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .dimensions.is_none().

pub fn aggregation_period(&self) -> Option<&AggregationPeriod>

The aggregation period of the metric.

pub fn start_timestamp(&self) -> Option<&DateTime>

The start timestamp for summary metric query.

pub fn end_timestamp(&self) -> Option<&DateTime>

The end timestamp for summary metric query.

pub fn timestamps(&self) -> &[DateTime]

The timestamp of each aggregation result.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .timestamps.is_none().

pub fn values(&self) -> &[MetricQueryValue]

The list of aggregated metrics.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .values.is_none().

pub fn unit(&self) -> Option<&str>

The units of measurement to be used for interpreting the aggregation result.

impl SummaryMetricQueryResult

pub fn builder() -> SummaryMetricQueryResultBuilder

Creates a new builder-style object to manufacture SummaryMetricQueryResult.

Trait Implementations

impl Clone for SummaryMetricQueryResult

fn clone(&self) -> SummaryMetricQueryResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SummaryMetricQueryResult

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

Formats the value using the given formatter.

impl PartialEq for SummaryMetricQueryResult

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