/* * Copyright 2018-2023 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.iot.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Information about a certificate. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class Certificate implements Serializable, Cloneable, StructuredPojo { /** ** The ARN of the certificate. *
*/ private String certificateArn; /** ** The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) *
*/ private String certificateId; /** ** The status of the certificate. *
** The status value REGISTER_INACTIVE is deprecated and should not be used. *
*/ private String status; /** ** The mode of the certificate. *
*
* DEFAULT
: A certificate in DEFAULT
mode is either generated by Amazon Web Services IoT
* Core or registered with an issuer certificate authority (CA) in DEFAULT
mode. Devices with
* certificates in DEFAULT
mode aren't required to send the Server Name Indication (SNI) extension when
* connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we
* recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.
*
* SNI_ONLY
: A certificate in SNI_ONLY
mode is registered without an issuer CA. Devices
* with certificates in SNI_ONLY
mode must send the SNI extension when connecting to Amazon Web
* Services IoT Core.
*
* The date and time the certificate was created. *
*/ private java.util.Date creationDate; /** ** The ARN of the certificate. *
* * @param certificateArn * The ARN of the certificate. */ public void setCertificateArn(String certificateArn) { this.certificateArn = certificateArn; } /** ** The ARN of the certificate. *
* * @return The ARN of the certificate. */ public String getCertificateArn() { return this.certificateArn; } /** ** The ARN of the certificate. *
* * @param certificateArn * The ARN of the certificate. * @return Returns a reference to this object so that method calls can be chained together. */ public Certificate withCertificateArn(String certificateArn) { setCertificateArn(certificateArn); return this; } /** ** The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) *
* * @param certificateId * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) */ public void setCertificateId(String certificateId) { this.certificateId = certificateId; } /** ** The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) *
* * @return The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) */ public String getCertificateId() { return this.certificateId; } /** ** The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) *
* * @param certificateId * The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.) * @return Returns a reference to this object so that method calls can be chained together. */ public Certificate withCertificateId(String certificateId) { setCertificateId(certificateId); return this; } /** ** The status of the certificate. *
** The status value REGISTER_INACTIVE is deprecated and should not be used. *
* * @param status * The status of the certificate. ** The status value REGISTER_INACTIVE is deprecated and should not be used. * @see CertificateStatus */ public void setStatus(String status) { this.status = status; } /** *
* The status of the certificate. *
** The status value REGISTER_INACTIVE is deprecated and should not be used. *
* * @return The status of the certificate. ** The status value REGISTER_INACTIVE is deprecated and should not be used. * @see CertificateStatus */ public String getStatus() { return this.status; } /** *
* The status of the certificate. *
** The status value REGISTER_INACTIVE is deprecated and should not be used. *
* * @param status * The status of the certificate. ** The status value REGISTER_INACTIVE is deprecated and should not be used. * @return Returns a reference to this object so that method calls can be chained together. * @see CertificateStatus */ public Certificate withStatus(String status) { setStatus(status); return this; } /** *
* The status of the certificate. *
** The status value REGISTER_INACTIVE is deprecated and should not be used. *
* * @param status * The status of the certificate. ** The status value REGISTER_INACTIVE is deprecated and should not be used. * @see CertificateStatus */ public void setStatus(CertificateStatus status) { withStatus(status); } /** *
* The status of the certificate. *
** The status value REGISTER_INACTIVE is deprecated and should not be used. *
* * @param status * The status of the certificate. ** The status value REGISTER_INACTIVE is deprecated and should not be used. * @return Returns a reference to this object so that method calls can be chained together. * @see CertificateStatus */ public Certificate withStatus(CertificateStatus status) { this.status = status.toString(); return this; } /** *
* The mode of the certificate. *
*
* DEFAULT
: A certificate in DEFAULT
mode is either generated by Amazon Web Services IoT
* Core or registered with an issuer certificate authority (CA) in DEFAULT
mode. Devices with
* certificates in DEFAULT
mode aren't required to send the Server Name Indication (SNI) extension when
* connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we
* recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.
*
* SNI_ONLY
: A certificate in SNI_ONLY
mode is registered without an issuer CA. Devices
* with certificates in SNI_ONLY
mode must send the SNI extension when connecting to Amazon Web
* Services IoT Core.
*
* DEFAULT
: A certificate in DEFAULT
mode is either generated by Amazon Web
* Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT
mode.
* Devices with certificates in DEFAULT
mode aren't required to send the Server Name Indication
* (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom
* domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web
* Services IoT Core.
*
* SNI_ONLY
: A certificate in SNI_ONLY
mode is registered without an issuer CA.
* Devices with certificates in SNI_ONLY
mode must send the SNI extension when connecting to
* Amazon Web Services IoT Core.
* @see CertificateMode
*/
public void setCertificateMode(String certificateMode) {
this.certificateMode = certificateMode;
}
/**
*
* The mode of the certificate. *
*
* DEFAULT
: A certificate in DEFAULT
mode is either generated by Amazon Web Services IoT
* Core or registered with an issuer certificate authority (CA) in DEFAULT
mode. Devices with
* certificates in DEFAULT
mode aren't required to send the Server Name Indication (SNI) extension when
* connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we
* recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.
*
* SNI_ONLY
: A certificate in SNI_ONLY
mode is registered without an issuer CA. Devices
* with certificates in SNI_ONLY
mode must send the SNI extension when connecting to Amazon Web
* Services IoT Core.
*
* DEFAULT
: A certificate in DEFAULT
mode is either generated by Amazon Web
* Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT
mode.
* Devices with certificates in DEFAULT
mode aren't required to send the Server Name Indication
* (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom
* domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web
* Services IoT Core.
*
* SNI_ONLY
: A certificate in SNI_ONLY
mode is registered without an issuer CA.
* Devices with certificates in SNI_ONLY
mode must send the SNI extension when connecting to
* Amazon Web Services IoT Core.
* @see CertificateMode
*/
public String getCertificateMode() {
return this.certificateMode;
}
/**
*
* The mode of the certificate. *
*
* DEFAULT
: A certificate in DEFAULT
mode is either generated by Amazon Web Services IoT
* Core or registered with an issuer certificate authority (CA) in DEFAULT
mode. Devices with
* certificates in DEFAULT
mode aren't required to send the Server Name Indication (SNI) extension when
* connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we
* recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.
*
* SNI_ONLY
: A certificate in SNI_ONLY
mode is registered without an issuer CA. Devices
* with certificates in SNI_ONLY
mode must send the SNI extension when connecting to Amazon Web
* Services IoT Core.
*
* DEFAULT
: A certificate in DEFAULT
mode is either generated by Amazon Web
* Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT
mode.
* Devices with certificates in DEFAULT
mode aren't required to send the Server Name Indication
* (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom
* domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web
* Services IoT Core.
*
* SNI_ONLY
: A certificate in SNI_ONLY
mode is registered without an issuer CA.
* Devices with certificates in SNI_ONLY
mode must send the SNI extension when connecting to
* Amazon Web Services IoT Core.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CertificateMode
*/
public Certificate withCertificateMode(String certificateMode) {
setCertificateMode(certificateMode);
return this;
}
/**
*
* The mode of the certificate. *
*
* DEFAULT
: A certificate in DEFAULT
mode is either generated by Amazon Web Services IoT
* Core or registered with an issuer certificate authority (CA) in DEFAULT
mode. Devices with
* certificates in DEFAULT
mode aren't required to send the Server Name Indication (SNI) extension when
* connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we
* recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.
*
* SNI_ONLY
: A certificate in SNI_ONLY
mode is registered without an issuer CA. Devices
* with certificates in SNI_ONLY
mode must send the SNI extension when connecting to Amazon Web
* Services IoT Core.
*
* DEFAULT
: A certificate in DEFAULT
mode is either generated by Amazon Web
* Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT
mode.
* Devices with certificates in DEFAULT
mode aren't required to send the Server Name Indication
* (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom
* domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web
* Services IoT Core.
*
* SNI_ONLY
: A certificate in SNI_ONLY
mode is registered without an issuer CA.
* Devices with certificates in SNI_ONLY
mode must send the SNI extension when connecting to
* Amazon Web Services IoT Core.
* @see CertificateMode
*/
public void setCertificateMode(CertificateMode certificateMode) {
withCertificateMode(certificateMode);
}
/**
*
* The mode of the certificate. *
*
* DEFAULT
: A certificate in DEFAULT
mode is either generated by Amazon Web Services IoT
* Core or registered with an issuer certificate authority (CA) in DEFAULT
mode. Devices with
* certificates in DEFAULT
mode aren't required to send the Server Name Indication (SNI) extension when
* connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we
* recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.
*
* SNI_ONLY
: A certificate in SNI_ONLY
mode is registered without an issuer CA. Devices
* with certificates in SNI_ONLY
mode must send the SNI extension when connecting to Amazon Web
* Services IoT Core.
*
* DEFAULT
: A certificate in DEFAULT
mode is either generated by Amazon Web
* Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT
mode.
* Devices with certificates in DEFAULT
mode aren't required to send the Server Name Indication
* (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom
* domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web
* Services IoT Core.
*
* SNI_ONLY
: A certificate in SNI_ONLY
mode is registered without an issuer CA.
* Devices with certificates in SNI_ONLY
mode must send the SNI extension when connecting to
* Amazon Web Services IoT Core.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CertificateMode
*/
public Certificate withCertificateMode(CertificateMode certificateMode) {
this.certificateMode = certificateMode.toString();
return this;
}
/**
*
* The date and time the certificate was created. *
* * @param creationDate * The date and time the certificate was created. */ public void setCreationDate(java.util.Date creationDate) { this.creationDate = creationDate; } /** ** The date and time the certificate was created. *
* * @return The date and time the certificate was created. */ public java.util.Date getCreationDate() { return this.creationDate; } /** ** The date and time the certificate was created. *
* * @param creationDate * The date and time the certificate was created. * @return Returns a reference to this object so that method calls can be chained together. */ public Certificate withCreationDate(java.util.Date creationDate) { setCreationDate(creationDate); 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 (getCertificateArn() != null) sb.append("CertificateArn: ").append(getCertificateArn()).append(","); if (getCertificateId() != null) sb.append("CertificateId: ").append(getCertificateId()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getCertificateMode() != null) sb.append("CertificateMode: ").append(getCertificateMode()).append(","); if (getCreationDate() != null) sb.append("CreationDate: ").append(getCreationDate()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof Certificate == false) return false; Certificate other = (Certificate) obj; if (other.getCertificateArn() == null ^ this.getCertificateArn() == null) return false; if (other.getCertificateArn() != null && other.getCertificateArn().equals(this.getCertificateArn()) == false) return false; if (other.getCertificateId() == null ^ this.getCertificateId() == null) return false; if (other.getCertificateId() != null && other.getCertificateId().equals(this.getCertificateId()) == false) return false; if (other.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false) return false; if (other.getCertificateMode() == null ^ this.getCertificateMode() == null) return false; if (other.getCertificateMode() != null && other.getCertificateMode().equals(this.getCertificateMode()) == false) return false; if (other.getCreationDate() == null ^ this.getCreationDate() == null) return false; if (other.getCreationDate() != null && other.getCreationDate().equals(this.getCreationDate()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getCertificateArn() == null) ? 0 : getCertificateArn().hashCode()); hashCode = prime * hashCode + ((getCertificateId() == null) ? 0 : getCertificateId().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getCertificateMode() == null) ? 0 : getCertificateMode().hashCode()); hashCode = prime * hashCode + ((getCreationDate() == null) ? 0 : getCreationDate().hashCode()); return hashCode; } @Override public Certificate clone() { try { return (Certificate) 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.iot.model.transform.CertificateMarshaller.getInstance().marshall(this, protocolMarshaller); } }