com.amazonaws.services.simpleemailv2.model.IdentityInfo Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sesv2 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.simpleemailv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about an email identity.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class IdentityInfo implements Serializable, Cloneable, StructuredPojo {
/**
*
* The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity types.
*
*/
private String identityType;
/**
*
* The address or domain of the identity.
*
*/
private String identityName;
/**
*
* Indicates whether or not you can send email from the identity.
*
*
* An identity is an email address or domain that you send email from. Before you can send email from an
* identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from
* that identity.
*
*/
private Boolean sendingEnabled;
/**
*
* The verification status of the identity. The status can be one of the following:
*
*
* -
*
* PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to verify the
* identity.
*
*
* -
*
* SUCCESS – The verification process completed successfully.
*
*
* -
*
* FAILED – The verification process failed.
*
*
* -
*
* TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the verification
* status of the identity.
*
*
* -
*
* NOT_STARTED – The verification process hasn't been initiated for the identity.
*
*
*
*/
private String verificationStatus;
/**
*
* The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity types.
*
*
* @param identityType
* The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity
* types.
* @see IdentityType
*/
public void setIdentityType(String identityType) {
this.identityType = identityType;
}
/**
*
* The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity types.
*
*
* @return The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity
* types.
* @see IdentityType
*/
public String getIdentityType() {
return this.identityType;
}
/**
*
* The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity types.
*
*
* @param identityType
* The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity
* types.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IdentityType
*/
public IdentityInfo withIdentityType(String identityType) {
setIdentityType(identityType);
return this;
}
/**
*
* The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity types.
*
*
* @param identityType
* The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity
* types.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IdentityType
*/
public IdentityInfo withIdentityType(IdentityType identityType) {
this.identityType = identityType.toString();
return this;
}
/**
*
* The address or domain of the identity.
*
*
* @param identityName
* The address or domain of the identity.
*/
public void setIdentityName(String identityName) {
this.identityName = identityName;
}
/**
*
* The address or domain of the identity.
*
*
* @return The address or domain of the identity.
*/
public String getIdentityName() {
return this.identityName;
}
/**
*
* The address or domain of the identity.
*
*
* @param identityName
* The address or domain of the identity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityInfo withIdentityName(String identityName) {
setIdentityName(identityName);
return this;
}
/**
*
* Indicates whether or not you can send email from the identity.
*
*
* An identity is an email address or domain that you send email from. Before you can send email from an
* identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from
* that identity.
*
*
* @param sendingEnabled
* Indicates whether or not you can send email from the identity.
*
* An identity is an email address or domain that you send email from. Before you can send email from
* an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send
* email from that identity.
*/
public void setSendingEnabled(Boolean sendingEnabled) {
this.sendingEnabled = sendingEnabled;
}
/**
*
* Indicates whether or not you can send email from the identity.
*
*
* An identity is an email address or domain that you send email from. Before you can send email from an
* identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from
* that identity.
*
*
* @return Indicates whether or not you can send email from the identity.
*
* An identity is an email address or domain that you send email from. Before you can send email from
* an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send
* email from that identity.
*/
public Boolean getSendingEnabled() {
return this.sendingEnabled;
}
/**
*
* Indicates whether or not you can send email from the identity.
*
*
* An identity is an email address or domain that you send email from. Before you can send email from an
* identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from
* that identity.
*
*
* @param sendingEnabled
* Indicates whether or not you can send email from the identity.
*
* An identity is an email address or domain that you send email from. Before you can send email from
* an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send
* email from that identity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityInfo withSendingEnabled(Boolean sendingEnabled) {
setSendingEnabled(sendingEnabled);
return this;
}
/**
*
* Indicates whether or not you can send email from the identity.
*
*
* An identity is an email address or domain that you send email from. Before you can send email from an
* identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from
* that identity.
*
*
* @return Indicates whether or not you can send email from the identity.
*
* An identity is an email address or domain that you send email from. Before you can send email from
* an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send
* email from that identity.
*/
public Boolean isSendingEnabled() {
return this.sendingEnabled;
}
/**
*
* The verification status of the identity. The status can be one of the following:
*
*
* -
*
* PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to verify the
* identity.
*
*
* -
*
* SUCCESS – The verification process completed successfully.
*
*
* -
*
* FAILED – The verification process failed.
*
*
* -
*
* TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the verification
* status of the identity.
*
*
* -
*
* NOT_STARTED – The verification process hasn't been initiated for the identity.
*
*
*
*
* @param verificationStatus
* The verification status of the identity. The status can be one of the following:
*
* -
*
* PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to
* verify the identity.
*
*
* -
*
* SUCCESS – The verification process completed successfully.
*
*
* -
*
* FAILED – The verification process failed.
*
*
* -
*
* TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the
* verification status of the identity.
*
*
* -
*
* NOT_STARTED – The verification process hasn't been initiated for the identity.
*
*
* @see VerificationStatus
*/
public void setVerificationStatus(String verificationStatus) {
this.verificationStatus = verificationStatus;
}
/**
*
* The verification status of the identity. The status can be one of the following:
*
*
* -
*
* PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to verify the
* identity.
*
*
* -
*
* SUCCESS – The verification process completed successfully.
*
*
* -
*
* FAILED – The verification process failed.
*
*
* -
*
* TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the verification
* status of the identity.
*
*
* -
*
* NOT_STARTED – The verification process hasn't been initiated for the identity.
*
*
*
*
* @return The verification status of the identity. The status can be one of the following:
*
* -
*
* PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to
* verify the identity.
*
*
* -
*
* SUCCESS – The verification process completed successfully.
*
*
* -
*
* FAILED – The verification process failed.
*
*
* -
*
* TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the
* verification status of the identity.
*
*
* -
*
* NOT_STARTED – The verification process hasn't been initiated for the identity.
*
*
* @see VerificationStatus
*/
public String getVerificationStatus() {
return this.verificationStatus;
}
/**
*
* The verification status of the identity. The status can be one of the following:
*
*
* -
*
* PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to verify the
* identity.
*
*
* -
*
* SUCCESS – The verification process completed successfully.
*
*
* -
*
* FAILED – The verification process failed.
*
*
* -
*
* TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the verification
* status of the identity.
*
*
* -
*
* NOT_STARTED – The verification process hasn't been initiated for the identity.
*
*
*
*
* @param verificationStatus
* The verification status of the identity. The status can be one of the following:
*
* -
*
* PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to
* verify the identity.
*
*
* -
*
* SUCCESS – The verification process completed successfully.
*
*
* -
*
* FAILED – The verification process failed.
*
*
* -
*
* TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the
* verification status of the identity.
*
*
* -
*
* NOT_STARTED – The verification process hasn't been initiated for the identity.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see VerificationStatus
*/
public IdentityInfo withVerificationStatus(String verificationStatus) {
setVerificationStatus(verificationStatus);
return this;
}
/**
*
* The verification status of the identity. The status can be one of the following:
*
*
* -
*
* PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to verify the
* identity.
*
*
* -
*
* SUCCESS – The verification process completed successfully.
*
*
* -
*
* FAILED – The verification process failed.
*
*
* -
*
* TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the verification
* status of the identity.
*
*
* -
*
* NOT_STARTED – The verification process hasn't been initiated for the identity.
*
*
*
*
* @param verificationStatus
* The verification status of the identity. The status can be one of the following:
*
* -
*
* PENDING – The verification process was initiated, but Amazon SES hasn't yet been able to
* verify the identity.
*
*
* -
*
* SUCCESS – The verification process completed successfully.
*
*
* -
*
* FAILED – The verification process failed.
*
*
* -
*
* TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the
* verification status of the identity.
*
*
* -
*
* NOT_STARTED – The verification process hasn't been initiated for the identity.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see VerificationStatus
*/
public IdentityInfo withVerificationStatus(VerificationStatus verificationStatus) {
this.verificationStatus = verificationStatus.toString();
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 (getIdentityType() != null)
sb.append("IdentityType: ").append(getIdentityType()).append(",");
if (getIdentityName() != null)
sb.append("IdentityName: ").append(getIdentityName()).append(",");
if (getSendingEnabled() != null)
sb.append("SendingEnabled: ").append(getSendingEnabled()).append(",");
if (getVerificationStatus() != null)
sb.append("VerificationStatus: ").append(getVerificationStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof IdentityInfo == false)
return false;
IdentityInfo other = (IdentityInfo) obj;
if (other.getIdentityType() == null ^ this.getIdentityType() == null)
return false;
if (other.getIdentityType() != null && other.getIdentityType().equals(this.getIdentityType()) == false)
return false;
if (other.getIdentityName() == null ^ this.getIdentityName() == null)
return false;
if (other.getIdentityName() != null && other.getIdentityName().equals(this.getIdentityName()) == false)
return false;
if (other.getSendingEnabled() == null ^ this.getSendingEnabled() == null)
return false;
if (other.getSendingEnabled() != null && other.getSendingEnabled().equals(this.getSendingEnabled()) == false)
return false;
if (other.getVerificationStatus() == null ^ this.getVerificationStatus() == null)
return false;
if (other.getVerificationStatus() != null && other.getVerificationStatus().equals(this.getVerificationStatus()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIdentityType() == null) ? 0 : getIdentityType().hashCode());
hashCode = prime * hashCode + ((getIdentityName() == null) ? 0 : getIdentityName().hashCode());
hashCode = prime * hashCode + ((getSendingEnabled() == null) ? 0 : getSendingEnabled().hashCode());
hashCode = prime * hashCode + ((getVerificationStatus() == null) ? 0 : getVerificationStatus().hashCode());
return hashCode;
}
@Override
public IdentityInfo clone() {
try {
return (IdentityInfo) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.simpleemailv2.model.transform.IdentityInfoMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}