software.amazon.awssdk.services.sesv2.model

Class BatchGetMetricDataQuery

java.lang.Object

software.amazon.awssdk.services.sesv2.model.BatchGetMetricDataQuery

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BatchGetMetricDataQuery.Builder,BatchGetMetricDataQuery>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchGetMetricDataQuery
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BatchGetMetricDataQuery.Builder,BatchGetMetricDataQuery>

Represents a single metric data query to include in a batch.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchGetMetricDataQuery.Builder

Method Summary

Modifier and Type	Method and Description
static BatchGetMetricDataQuery.Builder	builder()
Map<MetricDimensionName,String>	dimensions() An object that contains mapping between MetricDimensionName and MetricDimensionValue to filter metrics by.
Map<String,String>	dimensionsAsStrings() An object that contains mapping between MetricDimensionName and MetricDimensionValue to filter metrics by.
Instant	endDate() Represents the end date for the query interval.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensions() For responses, this returns true if the service returned a value for the Dimensions property.
int	hashCode()
String	id() The query identifier.
Metric	metric() The queried metric.
String	metricAsString() The queried metric.
MetricNamespace	namespace() The query namespace - e.g.
String	namespaceAsString() The query namespace - e.g.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchGetMetricDataQuery.Builder>	serializableBuilderClass()
Instant	startDate() Represents the start date for the query interval.
BatchGetMetricDataQuery.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public final String id()

The query identifier.

Returns:

The query identifier.

namespace

public final MetricNamespace namespace()

The query namespace - e.g. VDM

If the service returns an enum value that is not available in the current SDK version, namespace will return MetricNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from namespaceAsString().

Returns:

The query namespace - e.g. VDM

See Also:

MetricNamespace

namespaceAsString

public final String namespaceAsString()

The query namespace - e.g. VDM

If the service returns an enum value that is not available in the current SDK version, namespace will return MetricNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from namespaceAsString().

Returns:

The query namespace - e.g. VDM

See Also:

MetricNamespace

metric

public final 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.

If the service returns an enum value that is not available in the current SDK version, metric will return Metric.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricAsString().

Returns:

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.

See Also:

Metric

metricAsString

public final String metricAsString()

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.

If the service returns an enum value that is not available in the current SDK version, metric will return Metric.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricAsString().

Returns:

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.

See Also:

Metric

dimensions

public final Map<MetricDimensionName,String> dimensions()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDimensions() method.

Returns:

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

hasDimensions

public final boolean hasDimensions()

For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

dimensionsAsStrings

public final Map<String,String> dimensionsAsStrings()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDimensions() method.

Returns:

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

startDate

public final Instant startDate()

Represents the start date for the query interval.

Returns:

Represents the start date for the query interval.

endDate

public final Instant endDate()

Represents the end date for the query interval.

Returns:

Represents the end date for the query interval.

toBuilder

public BatchGetMetricDataQuery.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchGetMetricDataQuery.Builder,BatchGetMetricDataQuery>

builder

public static BatchGetMetricDataQuery.Builder builder()

serializableBuilderClass

public static Class<? extends BatchGetMetricDataQuery.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo