#[non_exhaustive]pub struct MetricDefinitionBuilder { /* private fields */ }
Expand description
A builder for MetricDefinition
.
Implementations§
Source§impl MetricDefinitionBuilder
impl MetricDefinitionBuilder
Sourcepub fn entity_id_key(self, input: impl Into<String>) -> Self
pub fn entity_id_key(self, input: impl Into<String>) -> Self
The entity, such as a user or session, that does an action that causes a metric value to be recorded.
Sourcepub fn set_entity_id_key(self, input: Option<String>) -> Self
pub fn set_entity_id_key(self, input: Option<String>) -> Self
The entity, such as a user or session, that does an action that causes a metric value to be recorded.
Sourcepub fn get_entity_id_key(&self) -> &Option<String>
pub fn get_entity_id_key(&self) -> &Option<String>
The entity, such as a user or session, that does an action that causes a metric value to be recorded.
Sourcepub fn value_key(self, input: impl Into<String>) -> Self
pub fn value_key(self, input: impl Into<String>) -> Self
The value that is tracked to produce the metric.
Sourcepub fn set_value_key(self, input: Option<String>) -> Self
pub fn set_value_key(self, input: Option<String>) -> Self
The value that is tracked to produce the metric.
Sourcepub fn get_value_key(&self) -> &Option<String>
pub fn get_value_key(&self) -> &Option<String>
The value that is tracked to produce the metric.
Sourcepub fn event_pattern(self, input: impl Into<String>) -> Self
pub fn event_pattern(self, input: impl Into<String>) -> Self
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
Sourcepub fn set_event_pattern(self, input: Option<String>) -> Self
pub fn set_event_pattern(self, input: Option<String>) -> Self
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
Sourcepub fn get_event_pattern(&self) -> &Option<String>
pub fn get_event_pattern(&self) -> &Option<String>
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
Sourcepub fn unit_label(self, input: impl Into<String>) -> Self
pub fn unit_label(self, input: impl Into<String>) -> Self
The label for the units that the metric is measuring.
Sourcepub fn set_unit_label(self, input: Option<String>) -> Self
pub fn set_unit_label(self, input: Option<String>) -> Self
The label for the units that the metric is measuring.
Sourcepub fn get_unit_label(&self) -> &Option<String>
pub fn get_unit_label(&self) -> &Option<String>
The label for the units that the metric is measuring.
Sourcepub fn build(self) -> MetricDefinition
pub fn build(self) -> MetricDefinition
Consumes the builder and constructs a MetricDefinition
.
Trait Implementations§
Source§impl Clone for MetricDefinitionBuilder
impl Clone for MetricDefinitionBuilder
Source§fn clone(&self) -> MetricDefinitionBuilder
fn clone(&self) -> MetricDefinitionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for MetricDefinitionBuilder
impl Debug for MetricDefinitionBuilder
Source§impl Default for MetricDefinitionBuilder
impl Default for MetricDefinitionBuilder
Source§fn default() -> MetricDefinitionBuilder
fn default() -> MetricDefinitionBuilder
Source§impl PartialEq for MetricDefinitionBuilder
impl PartialEq for MetricDefinitionBuilder
impl StructuralPartialEq for MetricDefinitionBuilder
Auto Trait Implementations§
impl Freeze for MetricDefinitionBuilder
impl RefUnwindSafe for MetricDefinitionBuilder
impl Send for MetricDefinitionBuilder
impl Sync for MetricDefinitionBuilder
impl Unpin for MetricDefinitionBuilder
impl UnwindSafe for MetricDefinitionBuilder
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);