Interface InsightsEvent.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<InsightsEvent.Builder,InsightsEvent>
,SdkBuilder<InsightsEvent.Builder,InsightsEvent>
,SdkPojo
- Enclosing class:
- InsightsEvent
public static interface InsightsEvent.Builder extends SdkPojo, CopyableBuilder<InsightsEvent.Builder,InsightsEvent>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default InsightsEvent.Builder
details(Consumer<EventDetails.Builder> details)
Details about bounce or complaint events.InsightsEvent.Builder
details(EventDetails details)
Details about bounce or complaint events.InsightsEvent.Builder
timestamp(Instant timestamp)
The timestamp of the event.InsightsEvent.Builder
type(String type)
The type of event:InsightsEvent.Builder
type(EventType type)
The type of event:-
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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
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 theDetails
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 theDetails
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 theDetails
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 theDetails
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:
EventType
,EventType
-
-
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 theDetails
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 theDetails
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 theDetails
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 theDetails
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:
EventType
,EventType
-
-
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 theEventDetails.Builder
avoiding the need to create one manually viaEventDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todetails(EventDetails)
.- Parameters:
details
- a consumer that will call methods onEventDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
details(EventDetails)
-
-