Interface InsightsEvent.Builder

All Superinterfaces:
Buildable, CopyableBuilder<InsightsEvent.Builder,InsightsEvent>, SdkBuilder<InsightsEvent.Builder,InsightsEvent>, SdkPojo
Enclosing class:
InsightsEvent
@Mutable @NotThreadSafe public static interface InsightsEvent.Builder extends SdkPojo, CopyableBuilder<InsightsEvent.Builder,InsightsEvent>

  • Method Details

    • timestamp

      InsightsEvent.Builder timestamp(Instant timestamp)

      The timestamp of the event.

      Parameters:
      timestamp - The timestamp of the event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      InsightsEvent.Builder type(String 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.

      Parameters:
      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.

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

    • type

      InsightsEvent.Builder type(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.

      Parameters:
      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.

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

    • details

      InsightsEvent.Builder details(EventDetails details)

      Details about bounce or complaint events.

      Parameters:
      details - Details about bounce or complaint events.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • details

      default InsightsEvent.Builder details(Consumer<EventDetails.Builder> details)

      Details about bounce or complaint events.

      This is a convenience method that creates an instance of the EventDetails.Builder avoiding the need to create one manually via EventDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to details(EventDetails).

      Parameters:
      details - a consumer that will call methods on EventDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: