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

Class PutDeliverabilityDashboardOptionRequest

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.PutDeliverabilityDashboardOptionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutDeliverabilityDashboardOptionRequest.Builder,PutDeliverabilityDashboardOptionRequest>

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

Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutDeliverabilityDashboardOptionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutDeliverabilityDashboardOptionRequest.Builder	builder()
Boolean	dashboardEnabled()	Specifies whether to enable the Deliverability dashboard.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubscribedDomains()	For responses, this returns true if the service returned a value for the SubscribedDomains property.
List<SdkField<?>>	sdkFields()
static Class<? extends PutDeliverabilityDashboardOptionRequest.Builder>	serializableBuilderClass()
List<DomainDeliverabilityTrackingOption>	subscribedDomains()	An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
PutDeliverabilityDashboardOptionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

dashboardEnabled

public final Boolean dashboardEnabled()

Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to true.

Returns:

Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to true.

hasSubscribedDomains

public final boolean hasSubscribedDomains()

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

subscribedDomains

public final List<DomainDeliverabilityTrackingOption> subscribedDomains()

An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

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

Returns:

An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

toBuilder

public PutDeliverabilityDashboardOptionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutDeliverabilityDashboardOptionRequest.Builder,PutDeliverabilityDashboardOptionRequest>

Specified by:

toBuilder in class SesV2Request

builder

public static PutDeliverabilityDashboardOptionRequest.Builder builder()

serializableBuilderClass

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