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

Class CreateContactRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sesv2.model.SesV2Request

software.amazon.awssdk.services.sesv2.model.CreateContactRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateContactRequest.Builder,CreateContactRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateContactRequest
extends SesV2Request
implements ToCopyableBuilder<CreateContactRequest.Builder,CreateContactRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateContactRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	attributesData()	The attribute data attached to a contact.
static CreateContactRequest.Builder	builder()
String	contactListName()	The name of the contact list to which the contact should be added.
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	hasTopicPreferences()	For responses, this returns true if the service returned a value for the TopicPreferences property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateContactRequest.Builder>	serializableBuilderClass()
CreateContactRequest.Builder	toBuilder()
List<TopicPreference>	topicPreferences()	The contact's preferences for being opted-in to or opted-out of topics.
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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

contactListName

public final String contactListName()

The name of the contact list to which the contact should be added.

Returns:

The name of the contact list to which the contact should be added.

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 preferences for being opted-in to or opted-out of topics.

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 preferences for being opted-in to or opted-out of topics.

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.

attributesData

public final String attributesData()

The attribute data attached to a contact.

Returns:

The attribute data attached to a contact.

toBuilder

public CreateContactRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateContactRequest.Builder,CreateContactRequest>

Specified by:

toBuilder in class SesV2Request

builder

public static CreateContactRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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