Struct aws_sdk_sesv2::types::builders::BatchGetMetricDataQueryBuilder

#[non_exhaustive]
pub struct BatchGetMetricDataQueryBuilder { /* private fields */ }

A builder for BatchGetMetricDataQuery.

Implementations

impl BatchGetMetricDataQueryBuilder

pub fn id(self, input: impl Into<String>) -> Self

The query identifier.

This field is required.

pub fn set_id(self, input: Option<String>) -> Self

The query identifier.

pub fn get_id(&self) -> &Option<String>

The query identifier.

pub fn namespace(self, input: MetricNamespace) -> Self

The query namespace - e.g. VDM

This field is required.

pub fn set_namespace(self, input: Option<MetricNamespace>) -> Self

The query namespace - e.g. VDM

pub fn get_namespace(&self) -> &Option<MetricNamespace>

The query namespace - e.g. VDM

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.

This field is required.

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.

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.

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.

pub fn set_dimensions( self, input: Option<HashMap<MetricDimensionName, String>> ) -> Self

An object that contains mapping between MetricDimensionName and MetricDimensionValue to filter metrics by.

pub fn get_dimensions(&self) -> &Option<HashMap<MetricDimensionName, String>>

An object that contains mapping between MetricDimensionName and MetricDimensionValue to filter metrics by.

pub fn start_date(self, input: DateTime) -> Self

Represents the start date for the query interval.

This field is required.

pub fn set_start_date(self, input: Option<DateTime>) -> Self

Represents the start date for the query interval.

pub fn get_start_date(&self) -> &Option<DateTime>

Represents the start date for the query interval.

pub fn end_date(self, input: DateTime) -> Self

Represents the end date for the query interval.

This field is required.

pub fn set_end_date(self, input: Option<DateTime>) -> Self

Represents the end date for the query interval.

pub fn get_end_date(&self) -> &Option<DateTime>

Represents the end date for the query interval.

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:

• id
• namespace
• metric
• start_date
• end_date

Trait Implementations

impl Clone for BatchGetMetricDataQueryBuilder

fn clone(&self) -> BatchGetMetricDataQueryBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchGetMetricDataQueryBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BatchGetMetricDataQueryBuilder

fn default() -> BatchGetMetricDataQueryBuilder

Returns the “default value” for a type.

impl PartialEq for BatchGetMetricDataQueryBuilder

fn eq(&self, other: &BatchGetMetricDataQueryBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BatchGetMetricDataQueryBuilder