Class InsightsEvent

java.lang.Object
software.amazon.awssdk.services.sesv2.model.InsightsEvent
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InsightsEvent.Builder,InsightsEvent>
@Generated("software.amazon.awssdk:codegen") public final class InsightsEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InsightsEvent.Builder,InsightsEvent>

An object containing details about a specific event.

See Also:

  • Method Details

    • timestamp

      public final Instant timestamp()

      The timestamp of the event.

      Returns:
      The timestamp of the event.

    • type

      public final EventType type()

      The type of event:

      • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

      • DELIVERY - SES successfully delivered the email to the recipient's mail server. Excludes deliveries to the mailbox simulator, and those from emails addressed to more than one recipient.

      • BOUNCE - Feedback received for delivery failures. Additional details about the bounce are provided in the Details object. Excludes bounces from the mailbox simulator, and those from emails addressed to more than one recipient.

      • COMPLAINT - Complaint received for the email. Additional details about the complaint are provided in the Details object. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those from emails addressed to more than one recipient.

      • OPEN - Open event for emails including open trackers. Excludes opens for emails addressed to more than one recipient.

      • CLICK - Click event for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient.

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

      Returns:
      The type of event:

      • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

      • DELIVERY - SES successfully delivered the email to the recipient's mail server. Excludes deliveries to the mailbox simulator, and those from emails addressed to more than one recipient.

      • BOUNCE - Feedback received for delivery failures. Additional details about the bounce are provided in the Details object. Excludes bounces from the mailbox simulator, and those from emails addressed to more than one recipient.

      • COMPLAINT - Complaint received for the email. Additional details about the complaint are provided in the Details object. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those from emails addressed to more than one recipient.

      • OPEN - Open event for emails including open trackers. Excludes opens for emails addressed to more than one recipient.

      • CLICK - Click event for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of event:

      • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

      • DELIVERY - SES successfully delivered the email to the recipient's mail server. Excludes deliveries to the mailbox simulator, and those from emails addressed to more than one recipient.

      • BOUNCE - Feedback received for delivery failures. Additional details about the bounce are provided in the Details object. Excludes bounces from the mailbox simulator, and those from emails addressed to more than one recipient.

      • COMPLAINT - Complaint received for the email. Additional details about the complaint are provided in the Details object. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those from emails addressed to more than one recipient.

      • OPEN - Open event for emails including open trackers. Excludes opens for emails addressed to more than one recipient.

      • CLICK - Click event for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient.

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

      Returns:
      The type of event:

      • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

      • DELIVERY - SES successfully delivered the email to the recipient's mail server. Excludes deliveries to the mailbox simulator, and those from emails addressed to more than one recipient.

      • BOUNCE - Feedback received for delivery failures. Additional details about the bounce are provided in the Details object. Excludes bounces from the mailbox simulator, and those from emails addressed to more than one recipient.

      • COMPLAINT - Complaint received for the email. Additional details about the complaint are provided in the Details object. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those from emails addressed to more than one recipient.

      • OPEN - Open event for emails including open trackers. Excludes opens for emails addressed to more than one recipient.

      • CLICK - Click event for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient.

      See Also:

    • details

      public final EventDetails details()

      Details about bounce or complaint events.

      Returns:
      Details about bounce or complaint events.

    • toBuilder

      public InsightsEvent.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<InsightsEvent.Builder,InsightsEvent>
      Returns:
      a builder for type T

    • builder

      public static InsightsEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InsightsEvent.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.