Class PrivateKeyAttributesV3

    • Method Detail

      • hasCryptoProviders

        public final boolean hasCryptoProviders()
        For responses, this returns true if the service returned a value for the CryptoProviders 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.
      • cryptoProviders

        public final List<String> cryptoProviders()

        Defines the cryptographic providers used to generate the private key.

        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 hasCryptoProviders() method.

        Returns:
        Defines the cryptographic providers used to generate the private key.
      • keySpec

        public final KeySpec keySpec()

        Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE" value.

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

        Returns:
        Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE" value.
        See Also:
        KeySpec
      • keySpecAsString

        public final String keySpecAsString()

        Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE" value.

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

        Returns:
        Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE" value.
        See Also:
        KeySpec
      • keyUsageProperty

        public final KeyUsageProperty keyUsageProperty()

        The key usage property defines the purpose of the private key contained in the certificate. You can specify specific purposes using property flags or all by using property type ALL.

        Returns:
        The key usage property defines the purpose of the private key contained in the certificate. You can specify specific purposes using property flags or all by using property type ALL.
      • minimalKeyLength

        public final Integer minimalKeyLength()

        Set the minimum key length of the private key.

        Returns:
        Set the minimum key length of the private key.
      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)