DomainDeliverabilityCampaign (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simpleemailv2.model.DomainDeliverabilityCampaign

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DomainDeliverabilityCampaign
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DomainDeliverabilityCampaign()

Constructors
Constructor and Description
`DomainDeliverabilityCampaign()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DomainDeliverabilityCampaign`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCampaignId()` The unique identifier for the campaign.
`Double`	`getDeleteRate()` The percentage of email messages that were deleted by recipients, without being opened first.
`List<String>`	`getEsps()` The major email providers who handled the email message.
`Date`	`getFirstSeenDateTime()` The first time when the email message was delivered to any recipient's inbox.
`String`	`getFromAddress()` The verified email address that the email message was sent from.
`String`	`getImageUrl()` The URL of an image that contains a snapshot of the email message that was sent.
`Long`	`getInboxCount()` The number of email messages that were delivered to recipients’ inboxes.
`Date`	`getLastSeenDateTime()` The last time when the email message was delivered to any recipient's inbox.
`Long`	`getProjectedVolume()` The projected number of recipients that the email message was sent to.
`Double`	`getReadDeleteRate()` The percentage of email messages that were opened and then deleted by recipients.
`Double`	`getReadRate()` The percentage of email messages that were opened by recipients.
`List<String>`	`getSendingIps()` The IP addresses that were used to send the email message.
`Long`	`getSpamCount()` The number of email messages that were delivered to recipients' spam or junk mail folders.
`String`	`getSubject()` The subject line, or title, of the email message.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCampaignId(String campaignId)` The unique identifier for the campaign.
`void`	`setDeleteRate(Double deleteRate)` The percentage of email messages that were deleted by recipients, without being opened first.
`void`	`setEsps(Collection<String> esps)` The major email providers who handled the email message.
`void`	`setFirstSeenDateTime(Date firstSeenDateTime)` The first time when the email message was delivered to any recipient's inbox.
`void`	`setFromAddress(String fromAddress)` The verified email address that the email message was sent from.
`void`	`setImageUrl(String imageUrl)` The URL of an image that contains a snapshot of the email message that was sent.
`void`	`setInboxCount(Long inboxCount)` The number of email messages that were delivered to recipients’ inboxes.
`void`	`setLastSeenDateTime(Date lastSeenDateTime)` The last time when the email message was delivered to any recipient's inbox.
`void`	`setProjectedVolume(Long projectedVolume)` The projected number of recipients that the email message was sent to.
`void`	`setReadDeleteRate(Double readDeleteRate)` The percentage of email messages that were opened and then deleted by recipients.
`void`	`setReadRate(Double readRate)` The percentage of email messages that were opened by recipients.
`void`	`setSendingIps(Collection<String> sendingIps)` The IP addresses that were used to send the email message.
`void`	`setSpamCount(Long spamCount)` The number of email messages that were delivered to recipients' spam or junk mail folders.
`void`	`setSubject(String subject)` The subject line, or title, of the email message.
`String`	`toString()` Returns a string representation of this object.
`DomainDeliverabilityCampaign`	`withCampaignId(String campaignId)` The unique identifier for the campaign.
`DomainDeliverabilityCampaign`	`withDeleteRate(Double deleteRate)` The percentage of email messages that were deleted by recipients, without being opened first.
`DomainDeliverabilityCampaign`	`withEsps(Collection<String> esps)` The major email providers who handled the email message.
`DomainDeliverabilityCampaign`	`withEsps(String... esps)` The major email providers who handled the email message.
`DomainDeliverabilityCampaign`	`withFirstSeenDateTime(Date firstSeenDateTime)` The first time when the email message was delivered to any recipient's inbox.
`DomainDeliverabilityCampaign`	`withFromAddress(String fromAddress)` The verified email address that the email message was sent from.
`DomainDeliverabilityCampaign`	`withImageUrl(String imageUrl)` The URL of an image that contains a snapshot of the email message that was sent.
`DomainDeliverabilityCampaign`	`withInboxCount(Long inboxCount)` The number of email messages that were delivered to recipients’ inboxes.
`DomainDeliverabilityCampaign`	`withLastSeenDateTime(Date lastSeenDateTime)` The last time when the email message was delivered to any recipient's inbox.
`DomainDeliverabilityCampaign`	`withProjectedVolume(Long projectedVolume)` The projected number of recipients that the email message was sent to.
`DomainDeliverabilityCampaign`	`withReadDeleteRate(Double readDeleteRate)` The percentage of email messages that were opened and then deleted by recipients.
`DomainDeliverabilityCampaign`	`withReadRate(Double readRate)` The percentage of email messages that were opened by recipients.
`DomainDeliverabilityCampaign`	`withSendingIps(Collection<String> sendingIps)` The IP addresses that were used to send the email message.
`DomainDeliverabilityCampaign`	`withSendingIps(String... sendingIps)` The IP addresses that were used to send the email message.
`DomainDeliverabilityCampaign`	`withSpamCount(Long spamCount)` The number of email messages that were delivered to recipients' spam or junk mail folders.
`DomainDeliverabilityCampaign`	`withSubject(String subject)` The subject line, or title, of the email message.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DomainDeliverabilityCampaign
```
public DomainDeliverabilityCampaign()
```
- Method Detail
  - setCampaignId
```
public void setCampaignId(String campaignId)
```
    The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
    
    Parameters:
    
    campaignId - The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
  - getCampaignId
```
public String getCampaignId()
```
    The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
    
    Returns:
    
    The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
  - withCampaignId
```
public DomainDeliverabilityCampaign withCampaignId(String campaignId)
```
    The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
    
    Parameters:
    
    campaignId - The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageUrl
```
public void setImageUrl(String imageUrl)
```
    The URL of an image that contains a snapshot of the email message that was sent.
    
    Parameters:
    
    imageUrl - The URL of an image that contains a snapshot of the email message that was sent.
  - getImageUrl
```
public String getImageUrl()
```
    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.
  - withImageUrl
```
public DomainDeliverabilityCampaign withImageUrl(String imageUrl)
```
    The URL of an image that contains a snapshot of the email message that was sent.
    
    Parameters:
    
    imageUrl - The URL of an image that contains a snapshot of the email message that was sent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubject
```
public void setSubject(String subject)
```
    The subject line, or title, of the email message.
    
    Parameters:
    
    subject - The subject line, or title, of the email message.
  - getSubject
```
public String getSubject()
```
    The subject line, or title, of the email message.
    
    Returns:
    
    The subject line, or title, of the email message.
  - withSubject
```
public DomainDeliverabilityCampaign withSubject(String subject)
```
    The subject line, or title, of the email message.
    
    Parameters:
    
    subject - The subject line, or title, of the email message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFromAddress
```
public void setFromAddress(String fromAddress)
```
    The verified email address that the email message was sent from.
    
    Parameters:
    
    fromAddress - The verified email address that the email message was sent from.
  - getFromAddress
```
public String getFromAddress()
```
    The verified email address that the email message was sent from.
    
    Returns:
    
    The verified email address that the email message was sent from.
  - withFromAddress
```
public DomainDeliverabilityCampaign withFromAddress(String fromAddress)
```
    The verified email address that the email message was sent from.
    
    Parameters:
    
    fromAddress - The verified email address that the email message was sent from.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSendingIps
```
public List<String> getSendingIps()
```
    The IP addresses that were used to send the email message.
    
    Returns:
    
    The IP addresses that were used to send the email message.
  - setSendingIps
```
public void setSendingIps(Collection<String> sendingIps)
```
    The IP addresses that were used to send the email message.
    
    Parameters:
    
    sendingIps - The IP addresses that were used to send the email message.
  - withSendingIps
```
public DomainDeliverabilityCampaign withSendingIps(String... sendingIps)
```
    The IP addresses that were used to send the email message.
    
    NOTE: This method appends the values to the existing list (if any). Use setSendingIps(java.util.Collection) or withSendingIps(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sendingIps - The IP addresses that were used to send the email message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSendingIps
```
public DomainDeliverabilityCampaign withSendingIps(Collection<String> sendingIps)
```
    The IP addresses that were used to send the email message.
    
    Parameters:
    
    sendingIps - The IP addresses that were used to send the email message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFirstSeenDateTime
```
public void setFirstSeenDateTime(Date firstSeenDateTime)
```
    The first time 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.
    
    Parameters:
    
    firstSeenDateTime - The first time 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.
  - getFirstSeenDateTime
```
public Date getFirstSeenDateTime()
```
    The first time 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 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.
  - withFirstSeenDateTime
```
public DomainDeliverabilityCampaign withFirstSeenDateTime(Date firstSeenDateTime)
```
    The first time 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.
    
    Parameters:
    
    firstSeenDateTime - The first time 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastSeenDateTime
```
public void setLastSeenDateTime(Date lastSeenDateTime)
```
    The last time 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.
    
    Parameters:
    
    lastSeenDateTime - The last time 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.
  - getLastSeenDateTime
```
public Date getLastSeenDateTime()
```
    The last time 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 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.
  - withLastSeenDateTime
```
public DomainDeliverabilityCampaign withLastSeenDateTime(Date lastSeenDateTime)
```
    The last time 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.
    
    Parameters:
    
    lastSeenDateTime - The last time 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInboxCount
```
public void setInboxCount(Long inboxCount)
```
    The number of email messages that were delivered to recipients’ inboxes.
    
    Parameters:
    
    inboxCount - The number of email messages that were delivered to recipients’ inboxes.
  - getInboxCount
```
public Long getInboxCount()
```
    The number of email messages that were delivered to recipients’ inboxes.
    
    Returns:
    
    The number of email messages that were delivered to recipients’ inboxes.
  - withInboxCount
```
public DomainDeliverabilityCampaign withInboxCount(Long inboxCount)
```
    The number of email messages that were delivered to recipients’ inboxes.
    
    Parameters:
    
    inboxCount - The number of email messages that were delivered to recipients’ inboxes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSpamCount
```
public void setSpamCount(Long spamCount)
```
    The number of email messages that were delivered to recipients' spam or junk mail folders.
    
    Parameters:
    
    spamCount - The number of email messages that were delivered to recipients' spam or junk mail folders.
  - getSpamCount
```
public Long getSpamCount()
```
    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.
  - withSpamCount
```
public DomainDeliverabilityCampaign withSpamCount(Long spamCount)
```
    The number of email messages that were delivered to recipients' spam or junk mail folders.
    
    Parameters:
    
    spamCount - The number of email messages that were delivered to recipients' spam or junk mail folders.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReadRate
```
public void setReadRate(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.
    
    Parameters:
    
    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.
  - getReadRate
```
public Double getReadRate()
```
    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.
  - withReadRate
```
public DomainDeliverabilityCampaign withReadRate(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeleteRate
```
public void setDeleteRate(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.
    
    Parameters:
    
    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.
  - getDeleteRate
```
public Double getDeleteRate()
```
    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.
  - withDeleteRate
```
public DomainDeliverabilityCampaign withDeleteRate(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReadDeleteRate
```
public void setReadDeleteRate(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.
    
    Parameters:
    
    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.
  - getReadDeleteRate
```
public Double getReadDeleteRate()
```
    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.
  - withReadDeleteRate
```
public DomainDeliverabilityCampaign withReadDeleteRate(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProjectedVolume
```
public void setProjectedVolume(Long projectedVolume)
```
    The projected number of recipients that the email message was sent to.
    
    Parameters:
    
    projectedVolume - The projected number of recipients that the email message was sent to.
  - getProjectedVolume
```
public Long getProjectedVolume()
```
    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.
  - withProjectedVolume
```
public DomainDeliverabilityCampaign withProjectedVolume(Long projectedVolume)
```
    The projected number of recipients that the email message was sent to.
    
    Parameters:
    
    projectedVolume - The projected number of recipients that the email message was sent to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEsps
```
public List<String> getEsps()
```
    The major email providers who handled the email message.
    
    Returns:
    
    The major email providers who handled the email message.
  - setEsps
```
public void setEsps(Collection<String> esps)
```
    The major email providers who handled the email message.
    
    Parameters:
    
    esps - The major email providers who handled the email message.
  - withEsps
```
public DomainDeliverabilityCampaign withEsps(String... esps)
```
    The major email providers who handled the email message.
    
    NOTE: This method appends the values to the existing list (if any). Use setEsps(java.util.Collection) or withEsps(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    esps - The major email providers who handled the email message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEsps
```
public DomainDeliverabilityCampaign withEsps(Collection<String> esps)
```
    The major email providers who handled the email message.
    
    Parameters:
    
    esps - The major email providers who handled the email message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DomainDeliverabilityCampaign clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class DomainDeliverabilityCampaign

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomainDeliverabilityCampaign

Method Detail

setCampaignId

getCampaignId

withCampaignId

setImageUrl

getImageUrl

withImageUrl

setSubject

getSubject

withSubject

setFromAddress

getFromAddress

withFromAddress

getSendingIps

setSendingIps

withSendingIps

withSendingIps

setFirstSeenDateTime

getFirstSeenDateTime

withFirstSeenDateTime

setLastSeenDateTime

getLastSeenDateTime

withLastSeenDateTime

setInboxCount

getInboxCount

withInboxCount

setSpamCount

getSpamCount

withSpamCount

setReadRate

getReadRate

withReadRate

setDeleteRate

getDeleteRate

withDeleteRate

setReadDeleteRate

getReadDeleteRate

withReadDeleteRate

setProjectedVolume

getProjectedVolume

withProjectedVolume

getEsps

setEsps

withEsps

withEsps

toString

equals

hashCode

clone

marshall