pub struct BatchGetFrameMetricData { /* private fields */ }
Expand description
Fluent builder constructing a request to BatchGetFrameMetricData
.
Returns the time series of values for a requested list of frame metrics from a time period.
Implementations
sourceimpl BatchGetFrameMetricData
impl BatchGetFrameMetricData
sourcepub async fn send(
self
) -> Result<BatchGetFrameMetricDataOutput, SdkError<BatchGetFrameMetricDataError>>
pub async fn send(
self
) -> Result<BatchGetFrameMetricDataOutput, SdkError<BatchGetFrameMetricDataError>>
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, which can be set when configuring the client.
sourcepub fn profiling_group_name(self, input: impl Into<String>) -> Self
pub fn profiling_group_name(self, input: impl Into<String>) -> Self
The name of the profiling group associated with the the frame metrics used to return the time series values.
sourcepub fn set_profiling_group_name(self, input: Option<String>) -> Self
pub fn set_profiling_group_name(self, input: Option<String>) -> Self
The name of the profiling group associated with the the frame metrics used to return the time series values.
sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
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.
sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
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.
sourcepub fn end_time(self, input: DateTime) -> Self
pub fn end_time(self, input: DateTime) -> Self
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.
sourcepub fn set_end_time(self, input: Option<DateTime>) -> Self
pub fn set_end_time(self, input: Option<DateTime>) -> Self
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.
sourcepub fn period(self, input: impl Into<String>) -> Self
pub fn period(self, input: impl Into<String>) -> Self
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
).
sourcepub fn set_period(self, input: Option<String>) -> Self
pub fn set_period(self, input: Option<String>) -> Self
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
).
sourcepub fn target_resolution(self, input: AggregationPeriod) -> Self
pub fn target_resolution(self, input: AggregationPeriod) -> Self
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
sourcepub fn set_target_resolution(self, input: Option<AggregationPeriod>) -> Self
pub fn set_target_resolution(self, input: Option<AggregationPeriod>) -> Self
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
sourcepub fn frame_metrics(self, input: FrameMetric) -> Self
pub fn frame_metrics(self, input: FrameMetric) -> Self
Appends an item to frameMetrics
.
To override the contents of this collection use set_frame_metrics
.
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.
sourcepub fn set_frame_metrics(self, input: Option<Vec<FrameMetric>>) -> Self
pub fn set_frame_metrics(self, input: Option<Vec<FrameMetric>>) -> Self
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.
Trait Implementations
sourceimpl Clone for BatchGetFrameMetricData
impl Clone for BatchGetFrameMetricData
sourcefn clone(&self) -> BatchGetFrameMetricData
fn clone(&self) -> BatchGetFrameMetricData
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for BatchGetFrameMetricData
impl Send for BatchGetFrameMetricData
impl Sync for BatchGetFrameMetricData
impl Unpin for BatchGetFrameMetricData
impl !UnwindSafe for BatchGetFrameMetricData
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more