software.amazon.awssdk.services.sesv2.model

Class GetMessageInsightsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sesv2.model.SesV2Response

software.amazon.awssdk.services.sesv2.model.GetMessageInsightsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetMessageInsightsResponse.Builder,GetMessageInsightsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetMessageInsightsResponse
extends SesV2Response
implements ToCopyableBuilder<GetMessageInsightsResponse.Builder,GetMessageInsightsResponse>

Information about a message.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetMessageInsightsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetMessageInsightsResponse.Builder	builder()
List<MessageTag>	emailTags() A list of tags, in the form of name/value pairs, that were applied to the email you sent, along with Amazon SES Auto-Tags.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fromEmailAddress() The from address used to send the message.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEmailTags() For responses, this returns true if the service returned a value for the EmailTags property.
int	hashCode()
boolean	hasInsights() For responses, this returns true if the service returned a value for the Insights property.
List<EmailInsights>	insights() A set of insights associated with the message.
String	messageId() A unique identifier for the message.
List<SdkField<?>>	sdkFields()
static Class<? extends GetMessageInsightsResponse.Builder>	serializableBuilderClass()
String	subject() The subject line of the message.
GetMessageInsightsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.sesv2.model.SesV2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

messageId

public final String messageId()

A unique identifier for the message.

Returns:

A unique identifier for the message.

fromEmailAddress

public final String fromEmailAddress()

The from address used to send the message.

Returns:

The from address used to send the message.

subject

public final String subject()

The subject line of the message.

Returns:

The subject line of the message.

hasEmailTags

public final boolean hasEmailTags()

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

emailTags

public final List<MessageTag> emailTags()

A list of tags, in the form of name/value pairs, that were applied to the email you sent, along with Amazon SES Auto-Tags.

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

Returns:

A list of tags, in the form of name/value pairs, that were applied to the email you sent, along with Amazon SES Auto-Tags.

hasInsights

public final boolean hasInsights()

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

insights

public final List<EmailInsights> insights()

A set of insights associated with the message.

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

Returns:

A set of insights associated with the message.

toBuilder

public GetMessageInsightsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetMessageInsightsResponse.Builder,GetMessageInsightsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetMessageInsightsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetMessageInsightsResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo