Class DeliverabilityTestReport

java.lang.Object
software.amazon.awssdk.services.pinpointemail.model.DeliverabilityTestReport
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DeliverabilityTestReport.Builder,DeliverabilityTestReport>
@Generated("software.amazon.awssdk:codegen") public final class DeliverabilityTestReport extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DeliverabilityTestReport.Builder,DeliverabilityTestReport>

An object that contains metadata related to a predictive inbox placement test.

See Also:

  • Method Details

    • reportId

      public final String reportId()

      A unique string that identifies the predictive inbox placement test.

      Returns:
      A unique string that identifies the predictive inbox placement test.

    • reportName

      public final String reportName()

      A name that helps you identify a predictive inbox placement test report.

      Returns:
      A name that helps you identify a predictive inbox placement test report.

    • subject

      public final String subject()

      The subject line for an email that you submitted in a predictive inbox placement test.

      Returns:
      The subject line for an email that you submitted in a predictive inbox placement test.

    • fromEmailAddress

      public final String fromEmailAddress()

      The sender address that you specified for the predictive inbox placement test.

      Returns:
      The sender address that you specified for the predictive inbox placement test.

    • createDate

      public final Instant createDate()

      The date and time when the predictive inbox placement test was created, in Unix time format.

      Returns:
      The date and time when the predictive inbox placement test was created, in Unix time format.

    • deliverabilityTestStatus

      public final DeliverabilityTestStatus deliverabilityTestStatus()

      The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

      If the service returns an enum value that is not available in the current SDK version, deliverabilityTestStatus will return DeliverabilityTestStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deliverabilityTestStatusAsString().

      Returns:
      The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.
      See Also:

    • deliverabilityTestStatusAsString

      public final String deliverabilityTestStatusAsString()

      The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

      If the service returns an enum value that is not available in the current SDK version, deliverabilityTestStatus will return DeliverabilityTestStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deliverabilityTestStatusAsString().

      Returns:
      The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.
      See Also:

    • toBuilder

      public DeliverabilityTestReport.Builder 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 interface ToCopyableBuilder<DeliverabilityTestReport.Builder,DeliverabilityTestReport>
      Returns:
      a builder for type T

    • builder

      public static DeliverabilityTestReport.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.