Package software.amazon.awssdk.services.sesv2.model

Class EmailInsights

java.lang.Object

software.amazon.awssdk.services.sesv2.model.EmailInsights

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EmailInsights.Builder,EmailInsights>

@Generated("software.amazon.awssdk:codegen")
public final class EmailInsights
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EmailInsights.Builder,EmailInsights>

An email's insights contain metadata and delivery information about a specific email.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EmailInsights.Builder

Method Summary

Modifier and Type	Method	Description
static EmailInsights.Builder	builder()
String	destination()	The recipient of the email.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<InsightsEvent>	events()	A list of events associated with the sent email.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEvents()	For responses, this returns true if the service returned a value for the Events property.
int	hashCode()
String	isp()	The recipient's ISP (e.g., Gmail, Yahoo, etc.).
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EmailInsights.Builder>	serializableBuilderClass()
EmailInsights.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

destination

public final String destination()

The recipient of the email.

Returns:

The recipient of the email.

isp

public final String isp()

The recipient's ISP (e.g., Gmail, Yahoo, etc.).

Returns:

The recipient's ISP (e.g., Gmail, Yahoo, etc.).

hasEvents

public final boolean hasEvents()

For responses, this returns true if the service returned a value for the Events 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.

events

public final List<InsightsEvent> events()

A list of events associated with the sent email.

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 hasEvents() method.

Returns:

A list of events associated with the sent email.

toBuilder

public EmailInsights.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EmailInsights.Builder,EmailInsights>

builder

public static EmailInsights.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo