Package com.google.cloud.kms.v1

Enum PublicKey.PublicKeyFormat

java.lang.Object
java.lang.Enum<PublicKey.PublicKeyFormat>
com.google.cloud.kms.v1.PublicKey.PublicKeyFormat
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<PublicKey.PublicKeyFormat>
Enclosing class:
PublicKey
public static enum PublicKey.PublicKeyFormat extends Enum<PublicKey.PublicKeyFormat> implements com.google.protobuf.ProtocolMessageEnum
 The supported [PublicKey][google.cloud.kms.v1.PublicKey] formats.
Protobuf enum google.cloud.kms.v1.PublicKey.PublicKeyFormat

  • Enum Constant Details

    • PUBLIC_KEY_FORMAT_UNSPECIFIED

      public static final PublicKey.PublicKeyFormat PUBLIC_KEY_FORMAT_UNSPECIFIED
       If the
 [public_key_format][google.cloud.kms.v1.GetPublicKeyRequest.public_key_format]
 field is not specified:
 - For PQC algorithms, an error will be returned.
 - For non-PQC algorithms, the default format is PEM, and the field
 [pem][google.cloud.kms.v1.PublicKey.pem] will be populated.

 Otherwise, the public key will be exported through the
 [public_key][google.cloud.kms.v1.PublicKey.public_key] field in the
 requested format.
      PUBLIC_KEY_FORMAT_UNSPECIFIED = 0;

    • PEM

      public static final PublicKey.PublicKeyFormat PEM
       The returned public key will be encoded in PEM format.
 See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for
 [General Considerations](https://tools.ietf.org/html/rfc7468#section-2)
 and [Textual Encoding of Subject Public Key Info]
 (https://tools.ietf.org/html/rfc7468#section-13) for more information.
      PEM = 1;

    • DER

      public static final PublicKey.PublicKeyFormat DER
       The returned public key will be encoded in DER format (the
 PrivateKeyInfo structure from RFC 5208).
      DER = 2;

    • NIST_PQC

      public static final PublicKey.PublicKeyFormat NIST_PQC
       This is supported only for PQC algorithms.
 The key material is returned in the format defined by NIST PQC
 standards (FIPS 203, FIPS 204, and FIPS 205).
      NIST_PQC = 3;

    • XWING_RAW_BYTES

      public static final PublicKey.PublicKeyFormat XWING_RAW_BYTES
       The returned public key is in raw bytes format defined in its standard
 https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem.
      XWING_RAW_BYTES = 4;

    • UNRECOGNIZED

      public static final PublicKey.PublicKeyFormat UNRECOGNIZED

  • Field Details

    • PUBLIC_KEY_FORMAT_UNSPECIFIED_VALUE

      public static final int PUBLIC_KEY_FORMAT_UNSPECIFIED_VALUE
       If the
 [public_key_format][google.cloud.kms.v1.GetPublicKeyRequest.public_key_format]
 field is not specified:
 - For PQC algorithms, an error will be returned.
 - For non-PQC algorithms, the default format is PEM, and the field
 [pem][google.cloud.kms.v1.PublicKey.pem] will be populated.

 Otherwise, the public key will be exported through the
 [public_key][google.cloud.kms.v1.PublicKey.public_key] field in the
 requested format.
      PUBLIC_KEY_FORMAT_UNSPECIFIED = 0;
      See Also:

    • PEM_VALUE

      public static final int PEM_VALUE
       The returned public key will be encoded in PEM format.
 See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for
 [General Considerations](https://tools.ietf.org/html/rfc7468#section-2)
 and [Textual Encoding of Subject Public Key Info]
 (https://tools.ietf.org/html/rfc7468#section-13) for more information.
      PEM = 1;
      See Also:

    • DER_VALUE

      public static final int DER_VALUE
       The returned public key will be encoded in DER format (the
 PrivateKeyInfo structure from RFC 5208).
      DER = 2;
      See Also:

    • NIST_PQC_VALUE

      public static final int NIST_PQC_VALUE
       This is supported only for PQC algorithms.
 The key material is returned in the format defined by NIST PQC
 standards (FIPS 203, FIPS 204, and FIPS 205).
      NIST_PQC = 3;
      See Also:

    • XWING_RAW_BYTES_VALUE

      public static final int XWING_RAW_BYTES_VALUE
       The returned public key is in raw bytes format defined in its standard
 https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem.
      XWING_RAW_BYTES = 4;
      See Also:

  • Method Details

    • values

      public static PublicKey.PublicKeyFormat[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static PublicKey.PublicKeyFormat valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static PublicKey.PublicKeyFormat valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static PublicKey.PublicKeyFormat forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<PublicKey.PublicKeyFormat> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static PublicKey.PublicKeyFormat valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null