#[non_exhaustive]pub struct DescribeCustomMetricOutputBuilder { /* private fields */ }
Expand description
A builder for DescribeCustomMetricOutput
.
Implementations§
Source§impl DescribeCustomMetricOutputBuilder
impl DescribeCustomMetricOutputBuilder
Sourcepub fn metric_name(self, input: impl Into<String>) -> Self
pub fn metric_name(self, input: impl Into<String>) -> Self
The name of the custom metric.
Sourcepub fn set_metric_name(self, input: Option<String>) -> Self
pub fn set_metric_name(self, input: Option<String>) -> Self
The name of the custom metric.
Sourcepub fn get_metric_name(&self) -> &Option<String>
pub fn get_metric_name(&self) -> &Option<String>
The name of the custom metric.
Sourcepub fn metric_arn(self, input: impl Into<String>) -> Self
pub fn metric_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Number (ARN) of the custom metric.
Sourcepub fn set_metric_arn(self, input: Option<String>) -> Self
pub fn set_metric_arn(self, input: Option<String>) -> Self
The Amazon Resource Number (ARN) of the custom metric.
Sourcepub fn get_metric_arn(&self) -> &Option<String>
pub fn get_metric_arn(&self) -> &Option<String>
The Amazon Resource Number (ARN) of the custom metric.
Sourcepub fn metric_type(self, input: CustomMetricType) -> Self
pub fn metric_type(self, input: CustomMetricType) -> Self
The type of the custom metric.
The type number
only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.
Sourcepub fn set_metric_type(self, input: Option<CustomMetricType>) -> Self
pub fn set_metric_type(self, input: Option<CustomMetricType>) -> Self
The type of the custom metric.
The type number
only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.
Sourcepub fn get_metric_type(&self) -> &Option<CustomMetricType>
pub fn get_metric_type(&self) -> &Option<CustomMetricType>
The type of the custom metric.
The type number
only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.
Sourcepub fn display_name(self, input: impl Into<String>) -> Self
pub fn display_name(self, input: impl Into<String>) -> Self
Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.
Sourcepub fn set_display_name(self, input: Option<String>) -> Self
pub fn set_display_name(self, input: Option<String>) -> Self
Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.
Sourcepub fn get_display_name(&self) -> &Option<String>
pub fn get_display_name(&self) -> &Option<String>
Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.
Sourcepub fn creation_date(self, input: DateTime) -> Self
pub fn creation_date(self, input: DateTime) -> Self
The creation date of the custom metric in milliseconds since epoch.
Sourcepub fn set_creation_date(self, input: Option<DateTime>) -> Self
pub fn set_creation_date(self, input: Option<DateTime>) -> Self
The creation date of the custom metric in milliseconds since epoch.
Sourcepub fn get_creation_date(&self) -> &Option<DateTime>
pub fn get_creation_date(&self) -> &Option<DateTime>
The creation date of the custom metric in milliseconds since epoch.
Sourcepub fn last_modified_date(self, input: DateTime) -> Self
pub fn last_modified_date(self, input: DateTime) -> Self
The time the custom metric was last modified in milliseconds since epoch.
Sourcepub fn set_last_modified_date(self, input: Option<DateTime>) -> Self
pub fn set_last_modified_date(self, input: Option<DateTime>) -> Self
The time the custom metric was last modified in milliseconds since epoch.
Sourcepub fn get_last_modified_date(&self) -> &Option<DateTime>
pub fn get_last_modified_date(&self) -> &Option<DateTime>
The time the custom metric was last modified in milliseconds since epoch.
Sourcepub fn build(self) -> DescribeCustomMetricOutput
pub fn build(self) -> DescribeCustomMetricOutput
Consumes the builder and constructs a DescribeCustomMetricOutput
.
Trait Implementations§
Source§impl Clone for DescribeCustomMetricOutputBuilder
impl Clone for DescribeCustomMetricOutputBuilder
Source§fn clone(&self) -> DescribeCustomMetricOutputBuilder
fn clone(&self) -> DescribeCustomMetricOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for DescribeCustomMetricOutputBuilder
impl Default for DescribeCustomMetricOutputBuilder
Source§fn default() -> DescribeCustomMetricOutputBuilder
fn default() -> DescribeCustomMetricOutputBuilder
Source§impl PartialEq for DescribeCustomMetricOutputBuilder
impl PartialEq for DescribeCustomMetricOutputBuilder
Source§fn eq(&self, other: &DescribeCustomMetricOutputBuilder) -> bool
fn eq(&self, other: &DescribeCustomMetricOutputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for DescribeCustomMetricOutputBuilder
Auto Trait Implementations§
impl Freeze for DescribeCustomMetricOutputBuilder
impl RefUnwindSafe for DescribeCustomMetricOutputBuilder
impl Send for DescribeCustomMetricOutputBuilder
impl Sync for DescribeCustomMetricOutputBuilder
impl Unpin for DescribeCustomMetricOutputBuilder
impl UnwindSafe for DescribeCustomMetricOutputBuilder
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);