com.amazonaws.services.pinpointemail.model

Class CreateDeliverabilityTestReportRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.pinpointemail.model.CreateDeliverabilityTestReportRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateDeliverabilityTestReportRequest()

Method Summary

Modifier and Type	Method and Description
CreateDeliverabilityTestReportRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
EmailContent	getContent() The HTML body of the message that you sent when you performed the predictive inbox placement test.
String	getFromEmailAddress() The email address that the predictive inbox placement test email was sent from.
String	getReportName() A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
List<Tag>	getTags() An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
int	hashCode()
void	setContent(EmailContent content) The HTML body of the message that you sent when you performed the predictive inbox placement test.
void	setFromEmailAddress(String fromEmailAddress) The email address that the predictive inbox placement test email was sent from.
void	setReportName(String reportName) A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
void	setTags(Collection<Tag> tags) An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
String	toString() Returns a string representation of this object.
CreateDeliverabilityTestReportRequest	withContent(EmailContent content) The HTML body of the message that you sent when you performed the predictive inbox placement test.
CreateDeliverabilityTestReportRequest	withFromEmailAddress(String fromEmailAddress) The email address that the predictive inbox placement test email was sent from.
CreateDeliverabilityTestReportRequest	withReportName(String reportName) A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
CreateDeliverabilityTestReportRequest	withTags(Collection<Tag> tags) An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
CreateDeliverabilityTestReportRequest	withTags(Tag... tags) An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

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

CreateDeliverabilityTestReportRequest

public CreateDeliverabilityTestReportRequest()

Method Detail

setReportName

public void setReportName(String reportName)

A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

Parameters:

reportName - A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

getReportName

public String getReportName()

A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

Returns:

A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

withReportName

public CreateDeliverabilityTestReportRequest withReportName(String reportName)

A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

Parameters:

reportName - A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

Returns:

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

setFromEmailAddress

public void setFromEmailAddress(String fromEmailAddress)

The email address that the predictive inbox placement test email was sent from.

Parameters:

fromEmailAddress - The email address that the predictive inbox placement test email was sent from.

getFromEmailAddress

public String getFromEmailAddress()

The email address that the predictive inbox placement test email was sent from.

Returns:

The email address that the predictive inbox placement test email was sent from.

withFromEmailAddress

public CreateDeliverabilityTestReportRequest withFromEmailAddress(String fromEmailAddress)

The email address that the predictive inbox placement test email was sent from.

Parameters:

fromEmailAddress - The email address that the predictive inbox placement test email was sent from.

Returns:

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

setContent

public void setContent(EmailContent content)

The HTML body of the message that you sent when you performed the predictive inbox placement test.

Parameters:

content - The HTML body of the message that you sent when you performed the predictive inbox placement test.

getContent

public EmailContent getContent()

The HTML body of the message that you sent when you performed the predictive inbox placement test.

Returns:

The HTML body of the message that you sent when you performed the predictive inbox placement test.

withContent

public CreateDeliverabilityTestReportRequest withContent(EmailContent content)

The HTML body of the message that you sent when you performed the predictive inbox placement test.

Parameters:

content - The HTML body of the message that you sent when you performed the predictive inbox placement test.

Returns:

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

getTags

public List<Tag> getTags()

An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

Returns:

An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

setTags

public void setTags(Collection<Tag> tags)

An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

Parameters:

tags - An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

withTags

public CreateDeliverabilityTestReportRequest withTags(Tag... tags)

An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

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

Parameters:

tags - An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

Returns:

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

withTags

public CreateDeliverabilityTestReportRequest withTags(Collection<Tag> tags)

An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

Parameters:

tags - An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

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 CreateDeliverabilityTestReportRequest 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()