Class CACertificateDescription

java.lang.Object
software.amazon.awssdk.services.iot.model.CACertificateDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CACertificateDescription.Builder,CACertificateDescription>
@Generated("software.amazon.awssdk:codegen") public final class CACertificateDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CACertificateDescription.Builder,CACertificateDescription>

Describes a CA certificate.

See Also:

  • Method Details

    • certificateArn

      public final String certificateArn()

      The CA certificate ARN.

      Returns:
      The CA certificate ARN.

    • certificateId

      public final String certificateId()

      The CA certificate ID.

      Returns:
      The CA certificate ID.

    • status

      public final CACertificateStatus status()

      The status of a CA certificate.

      If the service returns an enum value that is not available in the current SDK version, status will return CACertificateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of a CA certificate.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of a CA certificate.

      If the service returns an enum value that is not available in the current SDK version, status will return CACertificateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of a CA certificate.
      See Also:

    • certificatePem

      public final String certificatePem()

      The CA certificate data, in PEM format.

      Returns:
      The CA certificate data, in PEM format.

    • ownedBy

      public final String ownedBy()

      The owner of the CA certificate.

      Returns:
      The owner of the CA certificate.

    • creationDate

      public final Instant creationDate()

      The date the CA certificate was created.

      Returns:
      The date the CA certificate was created.

    • autoRegistrationStatus

      public final AutoRegistrationStatus autoRegistrationStatus()

      Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"

      If the service returns an enum value that is not available in the current SDK version, autoRegistrationStatus will return AutoRegistrationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoRegistrationStatusAsString().

      Returns:
      Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"
      See Also:

    • autoRegistrationStatusAsString

      public final String autoRegistrationStatusAsString()

      Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"

      If the service returns an enum value that is not available in the current SDK version, autoRegistrationStatus will return AutoRegistrationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoRegistrationStatusAsString().

      Returns:
      Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"
      See Also:

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The date the CA certificate was last modified.

      Returns:
      The date the CA certificate was last modified.

    • customerVersion

      public final Integer customerVersion()

      The customer version of the CA certificate.

      Returns:
      The customer version of the CA certificate.

    • generationId

      public final String generationId()

      The generation ID of the CA certificate.

      Returns:
      The generation ID of the CA certificate.

    • validity

      public final CertificateValidity validity()

      When the CA certificate is valid.

      Returns:
      When the CA certificate is valid.

    • certificateMode

      public final CertificateMode certificateMode()

      The mode of the CA.

      All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

      If the service returns an enum value that is not available in the current SDK version, certificateMode will return CertificateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from certificateModeAsString().

      Returns:
      The mode of the CA.

      All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

      See Also:

    • certificateModeAsString

      public final String certificateModeAsString()

      The mode of the CA.

      All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

      If the service returns an enum value that is not available in the current SDK version, certificateMode will return CertificateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from certificateModeAsString().

      Returns:
      The mode of the CA.

      All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

      See Also:

    • toBuilder

      public CACertificateDescription.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CACertificateDescription.Builder,CACertificateDescription>
      Returns:
      a builder for type T

    • builder

      public static CACertificateDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CACertificateDescription.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.