Class CreateDeliverabilityTestReportRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDeliverabilityTestReportRequest.Builder,
CreateDeliverabilityTestReportRequest>
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.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final EmailContent
content()
The HTML body of the message that you sent when you performed the predictive inbox placement test.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The email address that the predictive inbox placement test email was sent from.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.static Class
<? extends CreateDeliverabilityTestReportRequest.Builder> tags()
An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
reportName
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.
-
fromEmailAddress
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.
-
content
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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
tags
An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
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
hasTags()
method.- Returns:
- An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateDeliverabilityTestReportRequest.Builder,
CreateDeliverabilityTestReportRequest> - Specified by:
toBuilder
in classPinpointEmailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateDeliverabilityTestReportRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-