Struct aws_sdk_codeguruprofiler::operation::batch_get_frame_metric_data::BatchGetFrameMetricDataInput

#[non_exhaustive]
pub struct BatchGetFrameMetricDataInput {
    pub profiling_group_name: Option<String>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub period: Option<String>,
    pub target_resolution: Option<AggregationPeriod>,
    pub frame_metrics: Option<Vec<FrameMetric>>,
}

The structure representing the BatchGetFrameMetricDataRequest.

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.

profiling_group_name: Option<String>

The name of the profiling group associated with the the frame metrics used to return the time series values.

start_time: Option<DateTime>

The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

end_time: Option<DateTime>

The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

period: Option<String>

The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (PT24H or P1D).

target_resolution: Option<AggregationPeriod>

The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values.

• P1D — 1 day

• PT1H — 1 hour

• PT5M — 5 minutes

frame_metrics: Option<Vec<FrameMetric>>

The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

Implementations

impl BatchGetFrameMetricDataInput

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

The name of the profiling group associated with the the frame metrics used to return the time series values.

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

The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

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

The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

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

The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (PT24H or P1D).

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

The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values.

• P1D — 1 day

• PT1H — 1 hour

• PT5M — 5 minutes

pub fn frame_metrics(&self) -> &[FrameMetric]

The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

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

impl BatchGetFrameMetricDataInput

pub fn builder() -> BatchGetFrameMetricDataInputBuilder

Creates a new builder-style object to manufacture BatchGetFrameMetricDataInput.

Trait Implementations

impl Clone for BatchGetFrameMetricDataInput

fn clone(&self) -> BatchGetFrameMetricDataInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchGetFrameMetricDataInput

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

Formats the value using the given formatter.

impl PartialEq for BatchGetFrameMetricDataInput

fn eq(&self, other: &BatchGetFrameMetricDataInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BatchGetFrameMetricDataInput