Package software.amazon.awssdk.services.sesv2.model

Class CreateDeliverabilityTestReportRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sesv2.model.SesV2Request
software.amazon.awssdk.services.sesv2.model.CreateDeliverabilityTestReportRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDeliverabilityTestReportRequest.Builder,CreateDeliverabilityTestReportRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDeliverabilityTestReportRequest extends SesV2Request implements 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. We send that message to special email addresses spread across several major email providers around the world. The test takes about 24 hours to complete. When the test is complete, you can use the GetDeliverabilityTestReport operation to view the results of the test.

  • Method Details

    • reportName

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

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

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

      public CreateDeliverabilityTestReportRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDeliverabilityTestReportRequest.Builder,CreateDeliverabilityTestReportRequest>
      Specified by:
      toBuilder in class SesV2Request

    • builder

      public static CreateDeliverabilityTestReportRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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 SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo