Class GetDeliverabilityTestReportResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetDeliverabilityTestReportResponse.Builder,
GetDeliverabilityTestReportResponse>
The results of the predictive inbox placement test.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final DeliverabilityTestReport
An object that contains the results of 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 <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the IspPlacements property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final List
<IspPlacement> An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.final String
message()
An object that contains the message that you sent when you performed this predictive inbox placement test.final PlacementStatistics
An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.static Class
<? extends GetDeliverabilityTestReportResponse.Builder> tags()
An array of objects that define the tags (keys and values) that are associated 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.services.pinpointemail.model.PinpointEmailResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
deliverabilityTestReport
An object that contains the results of the predictive inbox placement test.
- Returns:
- An object that contains the results of the predictive inbox placement test.
-
overallPlacement
An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.
- Returns:
- An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.
-
hasIspPlacements
public final boolean hasIspPlacements()For responses, this returns true if the service returned a value for the IspPlacements 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. -
ispPlacements
An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
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
hasIspPlacements()
method.- Returns:
- An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
-
message
An object that contains the message that you sent when you performed this predictive inbox placement test.
- Returns:
- An object that contains the message that you sent when you performed this 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 are associated 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 are associated 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<GetDeliverabilityTestReportResponse.Builder,
GetDeliverabilityTestReportResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends GetDeliverabilityTestReportResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-