com.amazonaws.services.simpleemailv2.model

Class PutDeliverabilityDashboardOptionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleemailv2.model.PutDeliverabilityDashboardOptionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutDeliverabilityDashboardOptionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

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.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutDeliverabilityDashboardOptionRequest()

Method Summary

Modifier and Type	Method and Description
PutDeliverabilityDashboardOptionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getDashboardEnabled() Specifies whether to enable the Deliverability dashboard.
List<DomainDeliverabilityTrackingOption>	getSubscribedDomains() An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
int	hashCode()
Boolean	isDashboardEnabled() Specifies whether to enable the Deliverability dashboard.
void	setDashboardEnabled(Boolean dashboardEnabled) Specifies whether to enable the Deliverability dashboard.
void	setSubscribedDomains(Collection<DomainDeliverabilityTrackingOption> subscribedDomains) An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
String	toString() Returns a string representation of this object.
PutDeliverabilityDashboardOptionRequest	withDashboardEnabled(Boolean dashboardEnabled) Specifies whether to enable the Deliverability dashboard.
PutDeliverabilityDashboardOptionRequest	withSubscribedDomains(Collection<DomainDeliverabilityTrackingOption> subscribedDomains) An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
PutDeliverabilityDashboardOptionRequest	withSubscribedDomains(DomainDeliverabilityTrackingOption... subscribedDomains) An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutDeliverabilityDashboardOptionRequest

public PutDeliverabilityDashboardOptionRequest()

Method Detail

setDashboardEnabled

public void setDashboardEnabled(Boolean dashboardEnabled)

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

Parameters:

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

getDashboardEnabled

public Boolean getDashboardEnabled()

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.

withDashboardEnabled

public PutDeliverabilityDashboardOptionRequest withDashboardEnabled(Boolean dashboardEnabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isDashboardEnabled

public Boolean isDashboardEnabled()

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.

getSubscribedDomains

public List<DomainDeliverabilityTrackingOption> getSubscribedDomains()

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

Returns:

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

setSubscribedDomains

public void setSubscribedDomains(Collection<DomainDeliverabilityTrackingOption> subscribedDomains)

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

Parameters:

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

withSubscribedDomains

public PutDeliverabilityDashboardOptionRequest withSubscribedDomains(DomainDeliverabilityTrackingOption... subscribedDomains)

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

NOTE: This method appends the values to the existing list (if any). Use setSubscribedDomains(java.util.Collection) or withSubscribedDomains(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withSubscribedDomains

public PutDeliverabilityDashboardOptionRequest withSubscribedDomains(Collection<DomainDeliverabilityTrackingOption> subscribedDomains)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutDeliverabilityDashboardOptionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()