software.amazon.awssdk.services.sesv2.model

Class SuppressionOptions

java.lang.Object

software.amazon.awssdk.services.sesv2.model.SuppressionOptions

All Implemented Interfaces:

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

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

An object that contains information about the suppression list preferences for your account.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SuppressionOptions.Builder

Method Summary

Modifier and Type	Method and Description
static SuppressionOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSuppressedReasons() For responses, this returns true if the service returned a value for the SuppressedReasons property.
List<SdkField<?>>	sdkFields()
static Class<? extends SuppressionOptions.Builder>	serializableBuilderClass()
List<SuppressionListReason>	suppressedReasons() A list that contains the reasons that email addresses are automatically added to the suppression list for your account.
List<String>	suppressedReasonsAsStrings() A list that contains the reasons that email addresses are automatically added to the suppression list for your account.
SuppressionOptions.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

suppressedReasons

public final List<SuppressionListReason> suppressedReasons()

A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:

• COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.

• BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

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

Returns:

A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:

• COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.

• BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

hasSuppressedReasons

public final boolean hasSuppressedReasons()

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

suppressedReasonsAsStrings

public final List<String> suppressedReasonsAsStrings()

A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:

• COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.

• BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

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

Returns:

A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:

• COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.

• BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

toBuilder

public SuppressionOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SuppressionOptions.Builder,SuppressionOptions>

builder

public static SuppressionOptions.Builder builder()

serializableBuilderClass

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