Package software.amazon.awssdk.services.pinpointemail.model

Class DomainDeliverabilityCampaign

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

An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for ( PutDeliverabilityDashboardOption operation).

See Also:

  • Method Details

    • campaignId

      public final String campaignId()

      The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

      Returns:
      The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

    • imageUrl

      public final String imageUrl()

      The URL of an image that contains a snapshot of the email message that was sent.

      Returns:
      The URL of an image that contains a snapshot of the email message that was sent.

    • subject

      public final String subject()

      The subject line, or title, of the email message.

      Returns:
      The subject line, or title, of the email message.

    • fromAddress

      public final String fromAddress()

      The verified email address that the email message was sent from.

      Returns:
      The verified email address that the email message was sent from.

    • hasSendingIps

      public final boolean hasSendingIps()
      For responses, this returns true if the service returned a value for the SendingIps 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.

    • sendingIps

      public final List<String> sendingIps()

      The IP addresses that were used to send the email message.

      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 hasSendingIps() method.

      Returns:
      The IP addresses that were used to send the email message.

    • firstSeenDateTime

      public final Instant firstSeenDateTime()

      The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

      Returns:
      The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

    • lastSeenDateTime

      public final Instant lastSeenDateTime()

      The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

      Returns:
      The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

    • inboxCount

      public final Long inboxCount()

      The number of email messages that were delivered to recipients’ inboxes.

      Returns:
      The number of email messages that were delivered to recipients’ inboxes.

    • spamCount

      public final Long spamCount()

      The number of email messages that were delivered to recipients' spam or junk mail folders.

      Returns:
      The number of email messages that were delivered to recipients' spam or junk mail folders.

    • readRate

      public final Double readRate()

      The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

      Returns:
      The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

    • deleteRate

      public final Double deleteRate()

      The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

      Returns:
      The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

    • readDeleteRate

      public final Double readDeleteRate()

      The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

      Returns:
      The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

    • projectedVolume

      public final Long projectedVolume()

      The projected number of recipients that the email message was sent to.

      Returns:
      The projected number of recipients that the email message was sent to.

    • hasEsps

      public final boolean hasEsps()
      For responses, this returns true if the service returned a value for the Esps 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.

    • esps

      public final List<String> esps()

      The major email providers who handled the email message.

      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 hasEsps() method.

      Returns:
      The major email providers who handled the email message.

    • toBuilder

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

    • builder

      public static DomainDeliverabilityCampaign.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DomainDeliverabilityCampaign.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.