software.amazon.awssdk.services.pinpointemail.model

Class GetDeliverabilityTestReportResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.pinpointemail.model.PinpointEmailResponse

software.amazon.awssdk.services.pinpointemail.model.GetDeliverabilityTestReportResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDeliverabilityTestReportResponse.Builder,GetDeliverabilityTestReportResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetDeliverabilityTestReportResponse
extends PinpointEmailResponse
implements ToCopyableBuilder<GetDeliverabilityTestReportResponse.Builder,GetDeliverabilityTestReportResponse>

The results of the predictive inbox placement test.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDeliverabilityTestReportResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetDeliverabilityTestReportResponse.Builder	builder()
DeliverabilityTestReport	deliverabilityTestReport() An object that contains the results of the predictive inbox placement test.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIspPlacements() For responses, this returns true if the service returned a value for the IspPlacements property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<IspPlacement>	ispPlacements() An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
String	message() An object that contains the message that you sent when you performed this predictive inbox placement test.
PlacementStatistics	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.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDeliverabilityTestReportResponse.Builder>	serializableBuilderClass()
List<Tag>	tags() An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.
GetDeliverabilityTestReportResponse.Builder	toBuilder()
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 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

deliverabilityTestReport

public final DeliverabilityTestReport 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

public final PlacementStatistics 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 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.

ispPlacements

public final List<IspPlacement> 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

public final String 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 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.

tags

public final List<Tag> 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

public GetDeliverabilityTestReportResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDeliverabilityTestReportResponse.Builder,GetDeliverabilityTestReportResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetDeliverabilityTestReportResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetDeliverabilityTestReportResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo