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

Class Contact

java.lang.Object

software.amazon.awssdk.services.sesv2.model.Contact

All Implemented Interfaces:

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

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

A contact is the end-user who is receiving the email.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Contact.Builder

Method Summary

Modifier and Type	Method	Description
static Contact.Builder	builder()
String	emailAddress()	The contact's email address.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTopicDefaultPreferences()	For responses, this returns true if the service returned a value for the TopicDefaultPreferences property.
boolean	hasTopicPreferences()	For responses, this returns true if the service returned a value for the TopicPreferences property.
Instant	lastUpdatedTimestamp()	A timestamp noting the last time the contact's information was updated.
List<SdkField<?>>	sdkFields()
static Class<? extends Contact.Builder>	serializableBuilderClass()
Contact.Builder	toBuilder()
List<TopicPreference>	topicDefaultPreferences()	The default topic preferences applied to the contact.
List<TopicPreference>	topicPreferences()	The contact's preference for being opted-in to or opted-out of a topic.
String	toString()	Returns a string representation of this object.
Boolean	unsubscribeAll()	A boolean value status noting if the contact is unsubscribed from all contact list topics.

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

emailAddress

public final String emailAddress()

The contact's email address.

Returns:

The contact's email address.

hasTopicPreferences

public final boolean hasTopicPreferences()

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

topicPreferences

public final List<TopicPreference> topicPreferences()

The contact's preference for being opted-in to or opted-out of a topic.

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

Returns:

The contact's preference for being opted-in to or opted-out of a topic.

hasTopicDefaultPreferences

public final boolean hasTopicDefaultPreferences()

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

topicDefaultPreferences

public final List<TopicPreference> topicDefaultPreferences()

The default topic preferences applied to the contact.

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

Returns:

The default topic preferences applied to the contact.

unsubscribeAll

public final Boolean unsubscribeAll()

A boolean value status noting if the contact is unsubscribed from all contact list topics.

Returns:

A boolean value status noting if the contact is unsubscribed from all contact list topics.

lastUpdatedTimestamp

public final Instant lastUpdatedTimestamp()

A timestamp noting the last time the contact's information was updated.

Returns:

A timestamp noting the last time the contact's information was updated.

toBuilder

public Contact.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Contact.Builder,Contact>

builder

public static Contact.Builder builder()

serializableBuilderClass

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