#[non_exhaustive]pub struct CostAndUsageQueryBuilder { /* private fields */ }
Expand description
A builder for CostAndUsageQuery
.
Implementations§
Source§impl CostAndUsageQueryBuilder
impl CostAndUsageQueryBuilder
Sourcepub fn metrics(self, input: MetricName) -> Self
pub fn metrics(self, input: MetricName) -> Self
Appends an item to metrics
.
To override the contents of this collection use set_metrics
.
The specific cost and usage metrics to retrieve.
Valid values for CostAndUsageQuery metrics are AmortizedCost
, BlendedCost
, NetAmortizedCost
, NetUnblendedCost
, NormalizedUsageAmount
, UnblendedCost
, and UsageQuantity
.
Sourcepub fn set_metrics(self, input: Option<Vec<MetricName>>) -> Self
pub fn set_metrics(self, input: Option<Vec<MetricName>>) -> Self
The specific cost and usage metrics to retrieve.
Valid values for CostAndUsageQuery metrics are AmortizedCost
, BlendedCost
, NetAmortizedCost
, NetUnblendedCost
, NormalizedUsageAmount
, UnblendedCost
, and UsageQuantity
.
Sourcepub fn get_metrics(&self) -> &Option<Vec<MetricName>>
pub fn get_metrics(&self) -> &Option<Vec<MetricName>>
The specific cost and usage metrics to retrieve.
Valid values for CostAndUsageQuery metrics are AmortizedCost
, BlendedCost
, NetAmortizedCost
, NetUnblendedCost
, NormalizedUsageAmount
, UnblendedCost
, and UsageQuantity
.
Sourcepub fn time_range(self, input: DateTimeRange) -> Self
pub fn time_range(self, input: DateTimeRange) -> Self
The time period for which to retrieve data. Can be specified as absolute dates or relative time periods.
This field is required.Sourcepub fn set_time_range(self, input: Option<DateTimeRange>) -> Self
pub fn set_time_range(self, input: Option<DateTimeRange>) -> Self
The time period for which to retrieve data. Can be specified as absolute dates or relative time periods.
Sourcepub fn get_time_range(&self) -> &Option<DateTimeRange>
pub fn get_time_range(&self) -> &Option<DateTimeRange>
The time period for which to retrieve data. Can be specified as absolute dates or relative time periods.
Sourcepub fn granularity(self, input: Granularity) -> Self
pub fn granularity(self, input: Granularity) -> Self
The granularity of the retrieved data: HOURLY
, DAILY
, or MONTHLY
.
Sourcepub fn set_granularity(self, input: Option<Granularity>) -> Self
pub fn set_granularity(self, input: Option<Granularity>) -> Self
The granularity of the retrieved data: HOURLY
, DAILY
, or MONTHLY
.
Sourcepub fn get_granularity(&self) -> &Option<Granularity>
pub fn get_granularity(&self) -> &Option<Granularity>
The granularity of the retrieved data: HOURLY
, DAILY
, or MONTHLY
.
Sourcepub fn group_by(self, input: GroupDefinition) -> Self
pub fn group_by(self, input: GroupDefinition) -> Self
Appends an item to group_by
.
To override the contents of this collection use set_group_by
.
Specifies how to group the retrieved data, such as by SERVICE
, ACCOUNT
, or TAG
.
Sourcepub fn set_group_by(self, input: Option<Vec<GroupDefinition>>) -> Self
pub fn set_group_by(self, input: Option<Vec<GroupDefinition>>) -> Self
Specifies how to group the retrieved data, such as by SERVICE
, ACCOUNT
, or TAG
.
Sourcepub fn get_group_by(&self) -> &Option<Vec<GroupDefinition>>
pub fn get_group_by(&self) -> &Option<Vec<GroupDefinition>>
Specifies how to group the retrieved data, such as by SERVICE
, ACCOUNT
, or TAG
.
Sourcepub fn filter(self, input: Expression) -> Self
pub fn filter(self, input: Expression) -> Self
The filter expression to be applied to the cost and usage data.
Sourcepub fn set_filter(self, input: Option<Expression>) -> Self
pub fn set_filter(self, input: Option<Expression>) -> Self
The filter expression to be applied to the cost and usage data.
Sourcepub fn get_filter(&self) -> &Option<Expression>
pub fn get_filter(&self) -> &Option<Expression>
The filter expression to be applied to the cost and usage data.
Sourcepub fn build(self) -> Result<CostAndUsageQuery, BuildError>
pub fn build(self) -> Result<CostAndUsageQuery, BuildError>
Consumes the builder and constructs a CostAndUsageQuery
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for CostAndUsageQueryBuilder
impl Clone for CostAndUsageQueryBuilder
Source§fn clone(&self) -> CostAndUsageQueryBuilder
fn clone(&self) -> CostAndUsageQueryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CostAndUsageQueryBuilder
impl Debug for CostAndUsageQueryBuilder
Source§impl Default for CostAndUsageQueryBuilder
impl Default for CostAndUsageQueryBuilder
Source§fn default() -> CostAndUsageQueryBuilder
fn default() -> CostAndUsageQueryBuilder
Source§impl PartialEq for CostAndUsageQueryBuilder
impl PartialEq for CostAndUsageQueryBuilder
impl StructuralPartialEq for CostAndUsageQueryBuilder
Auto Trait Implementations§
impl Freeze for CostAndUsageQueryBuilder
impl RefUnwindSafe for CostAndUsageQueryBuilder
impl Send for CostAndUsageQueryBuilder
impl Sync for CostAndUsageQueryBuilder
impl Unpin for CostAndUsageQueryBuilder
impl UnwindSafe for CostAndUsageQueryBuilder
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);