InsightsEvent (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.sesv2.model.InsightsEvent

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<InsightsEvent.Builder,InsightsEvent>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface InsightsEvent.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`InsightsEvent.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static InsightsEvent.Builder`	`builder()`
`EventDetails`	`details()` Details about bounce or complaint events.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InsightsEvent.Builder>`	`serializableBuilderClass()`
`Instant`	`timestamp()` The timestamp of the event.
`InsightsEvent.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`EventType`	`type()` The type of event:
`String`	`typeAsString()` The type of event:

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
  - 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:
    
    EventType
  - 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:
    
    EventType
  - details
```
public final EventDetails details()
```
    Details about bounce or complaint events.
    
    Returns:
    
    Details about bounce or complaint events.
  - toBuilder
```
public InsightsEvent.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InsightsEvent.Builder,InsightsEvent>
  - 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)
```
    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

Class InsightsEvent

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

timestamp

type

typeAsString

details

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields