#[non_exhaustive]pub struct BatchGetMetricDataQueryBuilder { /* private fields */ }
Expand description
A builder for BatchGetMetricDataQuery
.
Implementations§
Source§impl BatchGetMetricDataQueryBuilder
impl BatchGetMetricDataQueryBuilder
Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The query identifier.
This field is required.Sourcepub fn namespace(self, input: MetricNamespace) -> Self
pub fn namespace(self, input: MetricNamespace) -> Self
The query namespace - e.g. VDM
Sourcepub fn set_namespace(self, input: Option<MetricNamespace>) -> Self
pub fn set_namespace(self, input: Option<MetricNamespace>) -> Self
The query namespace - e.g. VDM
Sourcepub fn get_namespace(&self) -> &Option<MetricNamespace>
pub fn get_namespace(&self) -> &Option<MetricNamespace>
The query namespace - e.g. VDM
Sourcepub fn metric(self, input: Metric) -> Self
pub fn metric(self, input: Metric) -> Self
The queried metric. This can be one of the following:
-
SEND
– Emails sent eligible for tracking in the VDM dashboard. This excludes emails sent to the mailbox simulator and emails addressed to more than one recipient. -
COMPLAINT
– Complaints received for your account. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient -
PERMANENT_BOUNCE
– Permanent bounces - i.e. feedback received for emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient. -
TRANSIENT_BOUNCE
– Transient bounces - i.e. feedback received for delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the mailbox simulator, and those for emails addressed to more than one recipient. -
OPEN
– Unique open events for emails including open trackers. Excludes opens for emails addressed to more than one recipient. -
CLICK
– Unique click events for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient. -
DELIVERY
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator and for emails addressed to more than one recipient. -
DELIVERY_OPEN
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without open trackers. -
DELIVERY_CLICK
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without click trackers. -
DELIVERY_COMPLAINT
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails addressed to recipients hosted by ISPs with which Amazon SES does not have a feedback loop agreement.
Sourcepub fn set_metric(self, input: Option<Metric>) -> Self
pub fn set_metric(self, input: Option<Metric>) -> Self
The queried metric. This can be one of the following:
-
SEND
– Emails sent eligible for tracking in the VDM dashboard. This excludes emails sent to the mailbox simulator and emails addressed to more than one recipient. -
COMPLAINT
– Complaints received for your account. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient -
PERMANENT_BOUNCE
– Permanent bounces - i.e. feedback received for emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient. -
TRANSIENT_BOUNCE
– Transient bounces - i.e. feedback received for delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the mailbox simulator, and those for emails addressed to more than one recipient. -
OPEN
– Unique open events for emails including open trackers. Excludes opens for emails addressed to more than one recipient. -
CLICK
– Unique click events for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient. -
DELIVERY
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator and for emails addressed to more than one recipient. -
DELIVERY_OPEN
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without open trackers. -
DELIVERY_CLICK
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without click trackers. -
DELIVERY_COMPLAINT
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails addressed to recipients hosted by ISPs with which Amazon SES does not have a feedback loop agreement.
Sourcepub fn get_metric(&self) -> &Option<Metric>
pub fn get_metric(&self) -> &Option<Metric>
The queried metric. This can be one of the following:
-
SEND
– Emails sent eligible for tracking in the VDM dashboard. This excludes emails sent to the mailbox simulator and emails addressed to more than one recipient. -
COMPLAINT
– Complaints received for your account. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient -
PERMANENT_BOUNCE
– Permanent bounces - i.e. feedback received for emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient. -
TRANSIENT_BOUNCE
– Transient bounces - i.e. feedback received for delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the mailbox simulator, and those for emails addressed to more than one recipient. -
OPEN
– Unique open events for emails including open trackers. Excludes opens for emails addressed to more than one recipient. -
CLICK
– Unique click events for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient. -
DELIVERY
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator and for emails addressed to more than one recipient. -
DELIVERY_OPEN
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without open trackers. -
DELIVERY_CLICK
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without click trackers. -
DELIVERY_COMPLAINT
– Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails addressed to recipients hosted by ISPs with which Amazon SES does not have a feedback loop agreement.
Sourcepub fn dimensions(self, k: MetricDimensionName, v: impl Into<String>) -> Self
pub fn dimensions(self, k: MetricDimensionName, v: impl Into<String>) -> Self
Adds a key-value pair to dimensions
.
To override the contents of this collection use set_dimensions
.
An object that contains mapping between MetricDimensionName
and MetricDimensionValue
to filter metrics by.
Sourcepub fn set_dimensions(
self,
input: Option<HashMap<MetricDimensionName, String>>,
) -> Self
pub fn set_dimensions( self, input: Option<HashMap<MetricDimensionName, String>>, ) -> Self
An object that contains mapping between MetricDimensionName
and MetricDimensionValue
to filter metrics by.
Sourcepub fn get_dimensions(&self) -> &Option<HashMap<MetricDimensionName, String>>
pub fn get_dimensions(&self) -> &Option<HashMap<MetricDimensionName, String>>
An object that contains mapping between MetricDimensionName
and MetricDimensionValue
to filter metrics by.
Sourcepub fn start_date(self, input: DateTime) -> Self
pub fn start_date(self, input: DateTime) -> Self
Represents the start date for the query interval.
This field is required.Sourcepub fn set_start_date(self, input: Option<DateTime>) -> Self
pub fn set_start_date(self, input: Option<DateTime>) -> Self
Represents the start date for the query interval.
Sourcepub fn get_start_date(&self) -> &Option<DateTime>
pub fn get_start_date(&self) -> &Option<DateTime>
Represents the start date for the query interval.
Sourcepub fn end_date(self, input: DateTime) -> Self
pub fn end_date(self, input: DateTime) -> Self
Represents the end date for the query interval.
This field is required.Sourcepub fn set_end_date(self, input: Option<DateTime>) -> Self
pub fn set_end_date(self, input: Option<DateTime>) -> Self
Represents the end date for the query interval.
Sourcepub fn get_end_date(&self) -> &Option<DateTime>
pub fn get_end_date(&self) -> &Option<DateTime>
Represents the end date for the query interval.
Sourcepub fn build(self) -> Result<BatchGetMetricDataQuery, BuildError>
pub fn build(self) -> Result<BatchGetMetricDataQuery, BuildError>
Consumes the builder and constructs a BatchGetMetricDataQuery
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for BatchGetMetricDataQueryBuilder
impl Clone for BatchGetMetricDataQueryBuilder
Source§fn clone(&self) -> BatchGetMetricDataQueryBuilder
fn clone(&self) -> BatchGetMetricDataQueryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for BatchGetMetricDataQueryBuilder
impl Default for BatchGetMetricDataQueryBuilder
Source§fn default() -> BatchGetMetricDataQueryBuilder
fn default() -> BatchGetMetricDataQueryBuilder
Source§impl PartialEq for BatchGetMetricDataQueryBuilder
impl PartialEq for BatchGetMetricDataQueryBuilder
Source§fn eq(&self, other: &BatchGetMetricDataQueryBuilder) -> bool
fn eq(&self, other: &BatchGetMetricDataQueryBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for BatchGetMetricDataQueryBuilder
Auto Trait Implementations§
impl Freeze for BatchGetMetricDataQueryBuilder
impl RefUnwindSafe for BatchGetMetricDataQueryBuilder
impl Send for BatchGetMetricDataQueryBuilder
impl Sync for BatchGetMetricDataQueryBuilder
impl Unpin for BatchGetMetricDataQueryBuilder
impl UnwindSafe for BatchGetMetricDataQueryBuilder
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);