Class ImportCertificateRequest

    • Method Detail

      • 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:
        CertificateUsageType
      • 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:
        CertificateUsageType
      • certificate

        public final String certificate()
        • For the CLI, provide a file path for a certificate in URI format. For example, --certificate file://encryption-cert.pem. Alternatively, you can provide the raw content.

        • For the SDK, specify the raw content of a certificate file. For example, --certificate "`cat encryption-cert.pem`".

        Returns:
      • For the CLI, provide a file path for a certificate in URI format. For example, --certificate file://encryption-cert.pem. Alternatively, you can provide the raw content.

      • For the SDK, specify the raw content of a certificate file. For example, --certificate "`cat encryption-cert.pem`".

      • certificateChain

        public final String certificateChain()

        An optional list of certificates that make up the chain for the certificate that's being imported.

        Returns:
        An optional list of certificates that make up the chain for the certificate that's being imported.
      • privateKey

        public final String privateKey()
        • For the CLI, provide a file path for a private key in URI format.For example, --private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file.

        • For the SDK, specify the raw content of a private key file. For example, --private-key "`cat encryption-key.pem`"

        Returns:
      • For the CLI, provide a file path for a private key in URI format.For example, --private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file.

      • For the SDK, specify the raw content of a private key file. For example, --private-key "`cat encryption-key.pem`"

      • activeDate

        public final Instant activeDate()

        An optional date that specifies when the certificate becomes active.

        Returns:
        An optional date that specifies when the certificate becomes active.
      • inactiveDate

        public final Instant inactiveDate()

        An optional date that specifies when the certificate becomes inactive.

        Returns:
        An optional date that specifies when the certificate becomes inactive.
      • description

        public final String description()

        A short description that helps identify the certificate.

        Returns:
        A short description that helps identify 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.
      • 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