Interface BatchGetMetricDataQuery.Builder

All Superinterfaces:

Buildable, CopyableBuilder<BatchGetMetricDataQuery.Builder,BatchGetMetricDataQuery>, SdkBuilder<BatchGetMetricDataQuery.Builder,BatchGetMetricDataQuery>, SdkPojo

Enclosing class:

BatchGetMetricDataQuery

public static interface BatchGetMetricDataQuery.Builder
extends SdkPojo, CopyableBuilder<BatchGetMetricDataQuery.Builder,BatchGetMetricDataQuery>

Method Summary

Modifier and Type	Method	Description
BatchGetMetricDataQuery.Builder	dimensions(Map<MetricDimensionName,String> dimensions)	An object that contains mapping between MetricDimensionName and MetricDimensionValue to filter metrics by.
BatchGetMetricDataQuery.Builder	dimensionsWithStrings(Map<String,String> dimensions)	An object that contains mapping between MetricDimensionName and MetricDimensionValue to filter metrics by.
BatchGetMetricDataQuery.Builder	endDate(Instant endDate)	Represents the end date for the query interval.
BatchGetMetricDataQuery.Builder	id(String id)	The query identifier.
BatchGetMetricDataQuery.Builder	metric(String metric)	The queried metric.
BatchGetMetricDataQuery.Builder	metric(Metric metric)	The queried metric.
BatchGetMetricDataQuery.Builder	namespace(String namespace)	The query namespace - e.g.
BatchGetMetricDataQuery.Builder	namespace(MetricNamespace namespace)	The query namespace - e.g.
BatchGetMetricDataQuery.Builder	startDate(Instant startDate)	Represents the start date for the query interval.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

id

BatchGetMetricDataQuery.Builder id(String id)

The query identifier.

Parameters:

id - The query identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

namespace

BatchGetMetricDataQuery.Builder namespace(String namespace)

The query namespace - e.g. VDM

Parameters:

namespace - The query namespace - e.g. VDM

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• MetricNamespace
• MetricNamespace

namespace

BatchGetMetricDataQuery.Builder namespace(MetricNamespace namespace)

The query namespace - e.g. VDM

Parameters:

namespace - The query namespace - e.g. VDM

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• MetricNamespace
• MetricNamespace

metric

BatchGetMetricDataQuery.Builder metric(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• Metric
• Metric

metric

BatchGetMetricDataQuery.Builder metric(Metric 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• Metric
• Metric

dimensionsWithStrings

BatchGetMetricDataQuery.Builder dimensionsWithStrings(Map<String,String> dimensions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dimensions

BatchGetMetricDataQuery.Builder dimensions(Map<MetricDimensionName,String> dimensions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

startDate

BatchGetMetricDataQuery.Builder startDate(Instant startDate)

Represents the start date for the query interval.

Parameters:

startDate - Represents the start date for the query interval.

Returns:

Returns a reference to this object so that method calls can be chained together.

endDate

BatchGetMetricDataQuery.Builder endDate(Instant endDate)

Represents the end date for the query interval.

Parameters:

endDate - Represents the end date for the query interval.

Returns:

Returns a reference to this object so that method calls can be chained together.