#[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>,
}
Expand description
The result of the summary metrics aggregation operation.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.query_id: Option<String>
The ID of the summary metric results query operation.
query_status: Option<MetricQueryStatus>
The status of the summary metric query result.
error: Option<String>
The error message for the summary metric query result.
metric_name: Option<MetricName>
The name of the summary metric query result.
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 the summary metric query.
end_timestamp: Option<DateTime>
The end timestamp for the summary metric query.
timestamps: Option<Vec<DateTime>>
The timestamp of each aggregation result.
values: Option<Vec<MetricQueryValue>>
The list of aggregated summary metric query results.
unit: Option<String>
The units of measurement to be used for interpreting the aggregation result.
Implementations§
Source§impl SummaryMetricQueryResult
impl SummaryMetricQueryResult
Sourcepub fn query_status(&self) -> Option<&MetricQueryStatus>
pub fn query_status(&self) -> Option<&MetricQueryStatus>
The status of the summary metric query result.
Sourcepub fn metric_name(&self) -> Option<&MetricName>
pub fn metric_name(&self) -> Option<&MetricName>
The name of the summary metric query result.
Sourcepub fn dimensions(&self) -> &[Dimension]
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()
.
Sourcepub fn aggregation_period(&self) -> Option<&AggregationPeriod>
pub fn aggregation_period(&self) -> Option<&AggregationPeriod>
The aggregation period of the metric.
Sourcepub fn start_timestamp(&self) -> Option<&DateTime>
pub fn start_timestamp(&self) -> Option<&DateTime>
The start timestamp for the summary metric query.
Sourcepub fn end_timestamp(&self) -> Option<&DateTime>
pub fn end_timestamp(&self) -> Option<&DateTime>
The end timestamp for the summary metric query.
Sourcepub fn timestamps(&self) -> &[DateTime]
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()
.
Sourcepub fn values(&self) -> &[MetricQueryValue]
pub fn values(&self) -> &[MetricQueryValue]
The list of aggregated summary metric query results.
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()
.
Source§impl SummaryMetricQueryResult
impl SummaryMetricQueryResult
Sourcepub fn builder() -> SummaryMetricQueryResultBuilder
pub fn builder() -> SummaryMetricQueryResultBuilder
Creates a new builder-style object to manufacture SummaryMetricQueryResult
.
Trait Implementations§
Source§impl Clone for SummaryMetricQueryResult
impl Clone for SummaryMetricQueryResult
Source§fn clone(&self) -> SummaryMetricQueryResult
fn clone(&self) -> SummaryMetricQueryResult
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SummaryMetricQueryResult
impl Debug for SummaryMetricQueryResult
Source§impl PartialEq for SummaryMetricQueryResult
impl PartialEq for SummaryMetricQueryResult
impl StructuralPartialEq for SummaryMetricQueryResult
Auto Trait Implementations§
impl Freeze for SummaryMetricQueryResult
impl RefUnwindSafe for SummaryMetricQueryResult
impl Send for SummaryMetricQueryResult
impl Sync for SummaryMetricQueryResult
impl Unpin for SummaryMetricQueryResult
impl UnwindSafe for SummaryMetricQueryResult
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);