com.amazonaws.services.simpleemail.model.IdentityDkimAttributes Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ses Show documentation
/*
* Copyright 2019-2024 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;
import javax.annotation.Generated;
/**
*
* Represents the DKIM attributes of a verified email address or a domain.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class IdentityDkimAttributes implements Serializable, Cloneable {
/**
*
* Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is
* true.
*
*/
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.)
*
*/
private String dkimVerificationStatus;
/**
*
* A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME
* records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that
* you've updated your DNS records. This detection process might take up to 72 hours. After successful detection,
* Amazon SES is 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, see the Amazon SES Developer
* Guide.
*
*/
private com.amazonaws.internal.SdkInternalList dkimTokens;
/**
*
* Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is
* true.
*
*
* @param dkimEnabled
* Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default
* value is true.
*/
public void setDkimEnabled(Boolean dkimEnabled) {
this.dkimEnabled = dkimEnabled;
}
/**
*
* Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is
* true.
*
*
* @return Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default
* value is true.
*/
public Boolean getDkimEnabled() {
return this.dkimEnabled;
}
/**
*
* Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is
* true.
*
*
* @param dkimEnabled
* Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default
* value is true.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityDkimAttributes withDkimEnabled(Boolean dkimEnabled) {
setDkimEnabled(dkimEnabled);
return this;
}
/**
*
* Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is
* true.
*
*
* @return Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default
* value is true.
*/
public Boolean isDkimEnabled() {
return this.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.)
*
*
* @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.)
*
*
* @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 this.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.)
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
* @see VerificationStatus
*/
public IdentityDkimAttributes withDkimVerificationStatus(String dkimVerificationStatus) {
setDkimVerificationStatus(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.)
*
*
* @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) {
withDkimVerificationStatus(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.)
*
*
* @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 Returns a reference to this 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 need to create DNS CNAME
* records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that
* you've updated your DNS records. This detection process might take up to 72 hours. After successful detection,
* Amazon SES is 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, see the Amazon SES Developer
* Guide.
*
*
* @return A set of character strings that represent the domain's identity. Using these tokens, you need to create
* DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services
* eventually detects that you've updated your DNS records. This detection process might take up to 72
* hours. After successful detection, Amazon SES is 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, see the Amazon SES
* Developer Guide.
*/
public java.util.List getDkimTokens() {
if (dkimTokens == null) {
dkimTokens = new com.amazonaws.internal.SdkInternalList();
}
return dkimTokens;
}
/**
*
* A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME
* records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that
* you've updated your DNS records. This detection process might take up to 72 hours. After successful detection,
* Amazon SES is 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, see the Amazon SES Developer
* Guide.
*
*
* @param dkimTokens
* A set of character strings that represent the domain's identity. Using these tokens, you need to create
* DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services
* eventually detects that you've updated your DNS records. This detection process might take up to 72 hours.
* After successful detection, Amazon SES is 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, see the Amazon SES
* Developer Guide.
*/
public void setDkimTokens(java.util.Collection dkimTokens) {
if (dkimTokens == null) {
this.dkimTokens = null;
return;
}
this.dkimTokens = new com.amazonaws.internal.SdkInternalList(dkimTokens);
}
/**
*
* A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME
* records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that
* you've updated your DNS records. This detection process might take up to 72 hours. After successful detection,
* Amazon SES is 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, see the Amazon SES Developer
* Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDkimTokens(java.util.Collection)} or {@link #withDkimTokens(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param dkimTokens
* A set of character strings that represent the domain's identity. Using these tokens, you need to create
* DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services
* eventually detects that you've updated your DNS records. This detection process might take up to 72 hours.
* After successful detection, Amazon SES is 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, see the Amazon SES
* Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityDkimAttributes withDkimTokens(String... dkimTokens) {
if (this.dkimTokens == null) {
setDkimTokens(new com.amazonaws.internal.SdkInternalList(dkimTokens.length));
}
for (String ele : dkimTokens) {
this.dkimTokens.add(ele);
}
return this;
}
/**
*
* A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME
* records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that
* you've updated your DNS records. This detection process might take up to 72 hours. After successful detection,
* Amazon SES is 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, see the Amazon SES Developer
* Guide.
*
*
* @param dkimTokens
* A set of character strings that represent the domain's identity. Using these tokens, you need to create
* DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services
* eventually detects that you've updated your DNS records. This detection process might take up to 72 hours.
* After successful detection, Amazon SES is 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, see the Amazon SES
* Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityDkimAttributes withDkimTokens(java.util.Collection dkimTokens) {
setDkimTokens(dkimTokens);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDkimEnabled() != null)
sb.append("DkimEnabled: ").append(getDkimEnabled()).append(",");
if (getDkimVerificationStatus() != null)
sb.append("DkimVerificationStatus: ").append(getDkimVerificationStatus()).append(",");
if (getDkimTokens() != null)
sb.append("DkimTokens: ").append(getDkimTokens());
sb.append("}");
return sb.toString();
}
@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.getDkimEnabled() == null ^ this.getDkimEnabled() == null)
return false;
if (other.getDkimEnabled() != null && other.getDkimEnabled().equals(this.getDkimEnabled()) == 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;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDkimEnabled() == null) ? 0 : getDkimEnabled().hashCode());
hashCode = prime * hashCode + ((getDkimVerificationStatus() == null) ? 0 : getDkimVerificationStatus().hashCode());
hashCode = prime * hashCode + ((getDkimTokens() == null) ? 0 : getDkimTokens().hashCode());
return hashCode;
}
@Override
public IdentityDkimAttributes clone() {
try {
return (IdentityDkimAttributes) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}