Class DescribedCertificate

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

Describes the properties of a certificate.

See Also:

  • Method Details

    • arn

      public final String arn()

      The unique Amazon Resource Name (ARN) for the certificate.

      Returns:
      The unique Amazon Resource Name (ARN) for the certificate.

    • certificateId

      public final String certificateId()

      An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

      Returns:
      An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

    • usage

      public final CertificateUsageType usage()

      Specifies how this certificate is used. It can be used in the following ways:

      • SIGNING: For signing AS2 messages

      • ENCRYPTION: For encrypting AS2 messages

      • TLS: For securing AS2 communications sent over HTTPS

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

      Returns:
      Specifies how this certificate is used. It can be used in the following ways:

      • SIGNING: For signing AS2 messages

      • ENCRYPTION: For encrypting AS2 messages

      • TLS: For securing AS2 communications sent over HTTPS

      See Also:

    • usageAsString

      public final String usageAsString()

      Specifies how this certificate is used. It can be used in the following ways:

      • SIGNING: For signing AS2 messages

      • ENCRYPTION: For encrypting AS2 messages

      • TLS: For securing AS2 communications sent over HTTPS

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

      Returns:
      Specifies how this certificate is used. It can be used in the following ways:

      • SIGNING: For signing AS2 messages

      • ENCRYPTION: For encrypting AS2 messages

      • TLS: For securing AS2 communications sent over HTTPS

      See Also:

    • status

      public final CertificateStatusType status()

      A certificate's status can be either ACTIVE or INACTIVE.

      You can set ActiveDate and InactiveDate in the UpdateCertificate call. If you set values for these parameters, those values are used to determine whether the certificate has a status of ACTIVE or INACTIVE.

      If you don't set values for ActiveDate and InactiveDate, we use the NotBefore and NotAfter date as specified on the X509 certificate to determine when a certificate is active and when it is inactive.

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

      Returns:
      A certificate's status can be either ACTIVE or INACTIVE.

      You can set ActiveDate and InactiveDate in the UpdateCertificate call. If you set values for these parameters, those values are used to determine whether the certificate has a status of ACTIVE or INACTIVE.

      If you don't set values for ActiveDate and InactiveDate, we use the NotBefore and NotAfter date as specified on the X509 certificate to determine when a certificate is active and when it is inactive.

      See Also:

    • statusAsString

      public final String statusAsString()

      A certificate's status can be either ACTIVE or INACTIVE.

      You can set ActiveDate and InactiveDate in the UpdateCertificate call. If you set values for these parameters, those values are used to determine whether the certificate has a status of ACTIVE or INACTIVE.

      If you don't set values for ActiveDate and InactiveDate, we use the NotBefore and NotAfter date as specified on the X509 certificate to determine when a certificate is active and when it is inactive.

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

      Returns:
      A certificate's status can be either ACTIVE or INACTIVE.

      You can set ActiveDate and InactiveDate in the UpdateCertificate call. If you set values for these parameters, those values are used to determine whether the certificate has a status of ACTIVE or INACTIVE.

      If you don't set values for ActiveDate and InactiveDate, we use the NotBefore and NotAfter date as specified on the X509 certificate to determine when a certificate is active and when it is inactive.

      See Also:

    • certificate

      public final String certificate()

      The file name for the certificate.

      Returns:
      The file name for the certificate.

    • certificateChain

      public final String certificateChain()

      The list of certificates that make up the chain for the certificate.

      Returns:
      The list of certificates that make up the chain for the certificate.

    • activeDate

      public final Instant activeDate()

      An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is specified by the CA.

      Returns:
      An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is specified by the CA.

    • inactiveDate

      public final Instant inactiveDate()

      An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is specified by the CA.

      Returns:
      An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is specified by the CA.

    • serial

      public final String serial()

      The serial number for the certificate.

      Returns:
      The serial number for the certificate.

    • notBeforeDate

      public final Instant notBeforeDate()

      The earliest date that the certificate is valid.

      Returns:
      The earliest date that the certificate is valid.

    • notAfterDate

      public final Instant notAfterDate()

      The final date that the certificate is valid.

      Returns:
      The final date that the certificate is valid.

    • type

      public final CertificateType type()

      If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

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

      Returns:
      If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
      See Also:

    • typeAsString

      public final String typeAsString()

      If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

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

      Returns:
      If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
      See Also:

    • description

      public final String description()

      The name or description that's used to identity the certificate.

      Returns:
      The name or description that's used to identity the certificate.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Key-value pairs that can be used to group and search for certificates.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Key-value pairs that can be used to group and search for certificates.

    • toBuilder

      public DescribedCertificate.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<DescribedCertificate.Builder,DescribedCertificate>
      Returns:
      a builder for type T

    • builder

      public static DescribedCertificate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribedCertificate.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.