Package 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("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<BatchGetMetricDataQuery.Builder,BatchGetMetricDataQuery>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.