com.amazonaws.services.simpleemail.model.IdentityDkimAttributes Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.simpleemail.model;
import java.io.Serializable;
/**
*
* Represents the DKIM attributes of a verified email address or a
* domain.
*
*/
public class IdentityDkimAttributes implements Serializable {
/**
* True if DKIM signing is enabled for email sent from the identity;
* false otherwise.
*/
private Boolean dkimEnabled;
/**
* Describes whether Amazon SES has successfully verified the DKIM DNS
* records (tokens) published in the domain name's DNS. (This only
* applies to domain identities, not email address identities.)
*
* Constraints:
* Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
*/
private String dkimVerificationStatus;
/**
* A set of character strings that represent the domain's identity. Using
* these tokens, you will need to create DNS CNAME records that point to
* DKIM public keys hosted by Amazon SES. Amazon Web Services will
* eventually detect that you have updated your DNS records; this
* detection process may take up to 72 hours. Upon successful detection,
* Amazon SES will be able to DKIM-sign email originating from that
* domain. (This only applies to domain identities, not email address
* identities.)
For more information about creating DNS records using
* DKIM tokens, go to the Amazon
* SES Developer Guide.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag dkimTokens;
/**
* True if DKIM signing is enabled for email sent from the identity;
* false otherwise.
*
* @return True if DKIM signing is enabled for email sent from the identity;
* false otherwise.
*/
public Boolean isDkimEnabled() {
return dkimEnabled;
}
/**
* True if DKIM signing is enabled for email sent from the identity;
* false otherwise.
*
* @param dkimEnabled True if DKIM signing is enabled for email sent from the identity;
* false otherwise.
*/
public void setDkimEnabled(Boolean dkimEnabled) {
this.dkimEnabled = dkimEnabled;
}
/**
* True if DKIM signing is enabled for email sent from the identity;
* false otherwise.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param dkimEnabled True if DKIM signing is enabled for email sent from the identity;
* false otherwise.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public IdentityDkimAttributes withDkimEnabled(Boolean dkimEnabled) {
this.dkimEnabled = dkimEnabled;
return this;
}
/**
* True if DKIM signing is enabled for email sent from the identity;
* false otherwise.
*
* @return True if DKIM signing is enabled for email sent from the identity;
* false otherwise.
*/
public Boolean getDkimEnabled() {
return dkimEnabled;
}
/**
* Describes whether Amazon SES has successfully verified the DKIM DNS
* records (tokens) published in the domain name's DNS. (This only
* applies to domain identities, not email address identities.)
*
* Constraints:
* Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
*
* @return Describes whether Amazon SES has successfully verified the DKIM DNS
* records (tokens) published in the domain name's DNS. (This only
* applies to domain identities, not email address identities.)
*
* @see VerificationStatus
*/
public String getDkimVerificationStatus() {
return dkimVerificationStatus;
}
/**
* Describes whether Amazon SES has successfully verified the DKIM DNS
* records (tokens) published in the domain name's DNS. (This only
* applies to domain identities, not email address identities.)
*
* Constraints:
* Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
*
* @param dkimVerificationStatus Describes whether Amazon SES has successfully verified the DKIM DNS
* records (tokens) published in the domain name's DNS. (This only
* applies to domain identities, not email address identities.)
*
* @see VerificationStatus
*/
public void setDkimVerificationStatus(String dkimVerificationStatus) {
this.dkimVerificationStatus = dkimVerificationStatus;
}
/**
* Describes whether Amazon SES has successfully verified the DKIM DNS
* records (tokens) published in the domain name's DNS. (This only
* applies to domain identities, not email address identities.)
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
*
* @param dkimVerificationStatus Describes whether Amazon SES has successfully verified the DKIM DNS
* records (tokens) published in the domain name's DNS. (This only
* applies to domain identities, not email address identities.)
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see VerificationStatus
*/
public IdentityDkimAttributes withDkimVerificationStatus(String dkimVerificationStatus) {
this.dkimVerificationStatus = dkimVerificationStatus;
return this;
}
/**
* Describes whether Amazon SES has successfully verified the DKIM DNS
* records (tokens) published in the domain name's DNS. (This only
* applies to domain identities, not email address identities.)
*
* Constraints:
* Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
*
* @param dkimVerificationStatus Describes whether Amazon SES has successfully verified the DKIM DNS
* records (tokens) published in the domain name's DNS. (This only
* applies to domain identities, not email address identities.)
*
* @see VerificationStatus
*/
public void setDkimVerificationStatus(VerificationStatus dkimVerificationStatus) {
this.dkimVerificationStatus = dkimVerificationStatus.toString();
}
/**
* Describes whether Amazon SES has successfully verified the DKIM DNS
* records (tokens) published in the domain name's DNS. (This only
* applies to domain identities, not email address identities.)
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
*
* @param dkimVerificationStatus Describes whether Amazon SES has successfully verified the DKIM DNS
* records (tokens) published in the domain name's DNS. (This only
* applies to domain identities, not email address identities.)
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see VerificationStatus
*/
public IdentityDkimAttributes withDkimVerificationStatus(VerificationStatus dkimVerificationStatus) {
this.dkimVerificationStatus = dkimVerificationStatus.toString();
return this;
}
/**
* A set of character strings that represent the domain's identity. Using
* these tokens, you will need to create DNS CNAME records that point to
* DKIM public keys hosted by Amazon SES. Amazon Web Services will
* eventually detect that you have updated your DNS records; this
* detection process may take up to 72 hours. Upon successful detection,
* Amazon SES will be able to DKIM-sign email originating from that
* domain. (This only applies to domain identities, not email address
* identities.)
For more information about creating DNS records using
* DKIM tokens, go to the Amazon
* SES Developer Guide.
*
* @return A set of character strings that represent the domain's identity. Using
* these tokens, you will need to create DNS CNAME records that point to
* DKIM public keys hosted by Amazon SES. Amazon Web Services will
* eventually detect that you have updated your DNS records; this
* detection process may take up to 72 hours. Upon successful detection,
* Amazon SES will be able to DKIM-sign email originating from that
* domain. (This only applies to domain identities, not email address
* identities.)
For more information about creating DNS records using
* DKIM tokens, go to the Amazon
* SES Developer Guide.
*/
public java.util.List getDkimTokens() {
if (dkimTokens == null) {
dkimTokens = new com.amazonaws.internal.ListWithAutoConstructFlag();
dkimTokens.setAutoConstruct(true);
}
return dkimTokens;
}
/**
* A set of character strings that represent the domain's identity. Using
* these tokens, you will need to create DNS CNAME records that point to
* DKIM public keys hosted by Amazon SES. Amazon Web Services will
* eventually detect that you have updated your DNS records; this
* detection process may take up to 72 hours. Upon successful detection,
* Amazon SES will be able to DKIM-sign email originating from that
* domain. (This only applies to domain identities, not email address
* identities.) For more information about creating DNS records using
* DKIM tokens, go to the Amazon
* SES Developer Guide.
*
* @param dkimTokens A set of character strings that represent the domain's identity. Using
* these tokens, you will need to create DNS CNAME records that point to
* DKIM public keys hosted by Amazon SES. Amazon Web Services will
* eventually detect that you have updated your DNS records; this
* detection process may take up to 72 hours. Upon successful detection,
* Amazon SES will be able to DKIM-sign email originating from that
* domain. (This only applies to domain identities, not email address
* identities.)
For more information about creating DNS records using
* DKIM tokens, go to the Amazon
* SES Developer Guide.
*/
public void setDkimTokens(java.util.Collection dkimTokens) {
if (dkimTokens == null) {
this.dkimTokens = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag dkimTokensCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(dkimTokens.size());
dkimTokensCopy.addAll(dkimTokens);
this.dkimTokens = dkimTokensCopy;
}
/**
* A set of character strings that represent the domain's identity. Using
* these tokens, you will need to create DNS CNAME records that point to
* DKIM public keys hosted by Amazon SES. Amazon Web Services will
* eventually detect that you have updated your DNS records; this
* detection process may take up to 72 hours. Upon successful detection,
* Amazon SES will be able to DKIM-sign email originating from that
* domain. (This only applies to domain identities, not email address
* identities.) For more information about creating DNS records using
* DKIM tokens, go to the Amazon
* SES Developer Guide.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param dkimTokens A set of character strings that represent the domain's identity. Using
* these tokens, you will need to create DNS CNAME records that point to
* DKIM public keys hosted by Amazon SES. Amazon Web Services will
* eventually detect that you have updated your DNS records; this
* detection process may take up to 72 hours. Upon successful detection,
* Amazon SES will be able to DKIM-sign email originating from that
* domain. (This only applies to domain identities, not email address
* identities.)
For more information about creating DNS records using
* DKIM tokens, go to the Amazon
* SES Developer Guide.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public IdentityDkimAttributes withDkimTokens(String... dkimTokens) {
if (getDkimTokens() == null) setDkimTokens(new java.util.ArrayList(dkimTokens.length));
for (String value : dkimTokens) {
getDkimTokens().add(value);
}
return this;
}
/**
* A set of character strings that represent the domain's identity. Using
* these tokens, you will need to create DNS CNAME records that point to
* DKIM public keys hosted by Amazon SES. Amazon Web Services will
* eventually detect that you have updated your DNS records; this
* detection process may take up to 72 hours. Upon successful detection,
* Amazon SES will be able to DKIM-sign email originating from that
* domain. (This only applies to domain identities, not email address
* identities.) For more information about creating DNS records using
* DKIM tokens, go to the Amazon
* SES Developer Guide.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param dkimTokens A set of character strings that represent the domain's identity. Using
* these tokens, you will need to create DNS CNAME records that point to
* DKIM public keys hosted by Amazon SES. Amazon Web Services will
* eventually detect that you have updated your DNS records; this
* detection process may take up to 72 hours. Upon successful detection,
* Amazon SES will be able to DKIM-sign email originating from that
* domain. (This only applies to domain identities, not email address
* identities.)
For more information about creating DNS records using
* DKIM tokens, go to the Amazon
* SES Developer Guide.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public IdentityDkimAttributes withDkimTokens(java.util.Collection dkimTokens) {
if (dkimTokens == null) {
this.dkimTokens = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag dkimTokensCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(dkimTokens.size());
dkimTokensCopy.addAll(dkimTokens);
this.dkimTokens = dkimTokensCopy;
}
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (isDkimEnabled() != null) sb.append("DkimEnabled: " + isDkimEnabled() + ",");
if (getDkimVerificationStatus() != null) sb.append("DkimVerificationStatus: " + getDkimVerificationStatus() + ",");
if (getDkimTokens() != null) sb.append("DkimTokens: " + getDkimTokens() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((isDkimEnabled() == null) ? 0 : isDkimEnabled().hashCode());
hashCode = prime * hashCode + ((getDkimVerificationStatus() == null) ? 0 : getDkimVerificationStatus().hashCode());
hashCode = prime * hashCode + ((getDkimTokens() == null) ? 0 : getDkimTokens().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof IdentityDkimAttributes == false) return false;
IdentityDkimAttributes other = (IdentityDkimAttributes)obj;
if (other.isDkimEnabled() == null ^ this.isDkimEnabled() == null) return false;
if (other.isDkimEnabled() != null && other.isDkimEnabled().equals(this.isDkimEnabled()) == false) return false;
if (other.getDkimVerificationStatus() == null ^ this.getDkimVerificationStatus() == null) return false;
if (other.getDkimVerificationStatus() != null && other.getDkimVerificationStatus().equals(this.getDkimVerificationStatus()) == false) return false;
if (other.getDkimTokens() == null ^ this.getDkimTokens() == null) return false;
if (other.getDkimTokens() != null && other.getDkimTokens().equals(this.getDkimTokens()) == false) return false;
return true;
}
}