Package com.google.cloud.kms.v1

Interface PublicKeyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PublicKey, PublicKey.Builder
@Generated public interface PublicKeyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    CryptoKeyVersion.CryptoKeyVersionAlgorithm
    getAlgorithm()
    The [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] associated with this key.
    int
    getAlgorithmValue()
    The [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] associated with this key.
    String
    getName()
    The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
    com.google.protobuf.ByteString
    getNameBytes()
    The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
    String
    getPem()
    The public key, encoded in PEM format.
    com.google.protobuf.ByteString
    getPemBytes()
    The public key, encoded in PEM format.
    com.google.protobuf.Int64Value
    getPemCrc32C()
    Integrity verification field.
    com.google.protobuf.Int64ValueOrBuilder
    getPemCrc32COrBuilder()
    Integrity verification field.
    ProtectionLevel
    getProtectionLevel()
    The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
    int
    getProtectionLevelValue()
    The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
    ChecksummedData
    getPublicKey()
    This field contains the public key (with integrity verification), formatted according to the [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.
    PublicKey.PublicKeyFormat
    getPublicKeyFormat()
    The [PublicKey][google.cloud.kms.v1.PublicKey] format specified by the customer through the [public_key_format][google.cloud.kms.v1.GetPublicKeyRequest.public_key_format] field.
    int
    getPublicKeyFormatValue()
    The [PublicKey][google.cloud.kms.v1.PublicKey] format specified by the customer through the [public_key_format][google.cloud.kms.v1.GetPublicKeyRequest.public_key_format] field.
    ChecksummedDataOrBuilder
    getPublicKeyOrBuilder()
    This field contains the public key (with integrity verification), formatted according to the [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.
    boolean
    hasPemCrc32C()
    Integrity verification field.
    boolean
    hasPublicKey()
    This field contains the public key (with integrity verification), formatted according to the [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getPem

      String getPem()
       The public key, encoded in PEM format. For more information, see the
 [RFC 7468](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).
      string pem = 1;
      Returns:
      The pem.

    • getPemBytes

      com.google.protobuf.ByteString getPemBytes()
       The public key, encoded in PEM format. For more information, see the
 [RFC 7468](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).
      string pem = 1;
      Returns:
      The bytes for pem.

    • getAlgorithmValue

      int getAlgorithmValue()
       The
 [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm]
 associated with this key.
      .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2;
      Returns:
      The enum numeric value on the wire for algorithm.

    • getAlgorithm

      CryptoKeyVersion.CryptoKeyVersionAlgorithm getAlgorithm()
       The
 [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm]
 associated with this key.
      .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2;
      Returns:
      The algorithm.

    • hasPemCrc32C

      boolean hasPemCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
 [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem]. An integrity check of
 [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] can be performed by
 computing the CRC32C checksum of
 [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] and comparing your
 results to this field. Discard the response in case of non-matching
 checksum values, and perform a limited number of retries. A persistent
 mismatch may indicate an issue in your computation of the CRC32C checksum.
 Note: This field is defined as int64 for reasons of compatibility across
 different languages. However, it is a non-negative integer, which will
 never exceed `2^32-1`, and can be safely downconverted to uint32 in
 languages that support this type.

 NOTE: This field is in Beta.
      .google.protobuf.Int64Value pem_crc32c = 3;
      Returns:
      Whether the pemCrc32c field is set.

    • getPemCrc32C

      com.google.protobuf.Int64Value getPemCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
 [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem]. An integrity check of
 [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] can be performed by
 computing the CRC32C checksum of
 [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] and comparing your
 results to this field. Discard the response in case of non-matching
 checksum values, and perform a limited number of retries. A persistent
 mismatch may indicate an issue in your computation of the CRC32C checksum.
 Note: This field is defined as int64 for reasons of compatibility across
 different languages. However, it is a non-negative integer, which will
 never exceed `2^32-1`, and can be safely downconverted to uint32 in
 languages that support this type.

 NOTE: This field is in Beta.
      .google.protobuf.Int64Value pem_crc32c = 3;
      Returns:
      The pemCrc32c.

    • getPemCrc32COrBuilder

      com.google.protobuf.Int64ValueOrBuilder getPemCrc32COrBuilder()
       Integrity verification field. A CRC32C checksum of the returned
 [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem]. An integrity check of
 [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] can be performed by
 computing the CRC32C checksum of
 [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] and comparing your
 results to this field. Discard the response in case of non-matching
 checksum values, and perform a limited number of retries. A persistent
 mismatch may indicate an issue in your computation of the CRC32C checksum.
 Note: This field is defined as int64 for reasons of compatibility across
 different languages. However, it is a non-negative integer, which will
 never exceed `2^32-1`, and can be safely downconverted to uint32 in
 languages that support this type.

 NOTE: This field is in Beta.
      .google.protobuf.Int64Value pem_crc32c = 3;

    • getName

      String getName()
       The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
 Provided here for verification.

 NOTE: This field is in Beta.
      string name = 4;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
 Provided here for verification.

 NOTE: This field is in Beta.
      string name = 4;
      Returns:
      The bytes for name.

    • getProtectionLevelValue

      int getProtectionLevelValue()
       The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
      .google.cloud.kms.v1.ProtectionLevel protection_level = 5;
      Returns:
      The enum numeric value on the wire for protectionLevel.

    • getProtectionLevel

      ProtectionLevel getProtectionLevel()
       The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.
      .google.cloud.kms.v1.ProtectionLevel protection_level = 5;
      Returns:
      The protectionLevel.

    • getPublicKeyFormatValue

      int getPublicKeyFormatValue()
       The [PublicKey][google.cloud.kms.v1.PublicKey] format specified by the
 customer through the
 [public_key_format][google.cloud.kms.v1.GetPublicKeyRequest.public_key_format]
 field.
      .google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 7;
      Returns:
      The enum numeric value on the wire for publicKeyFormat.

    • getPublicKeyFormat

      PublicKey.PublicKeyFormat getPublicKeyFormat()
       The [PublicKey][google.cloud.kms.v1.PublicKey] format specified by the
 customer through the
 [public_key_format][google.cloud.kms.v1.GetPublicKeyRequest.public_key_format]
 field.
      .google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 7;
      Returns:
      The publicKeyFormat.

    • hasPublicKey

      boolean hasPublicKey()
       This field contains the public key (with integrity verification), formatted
 according to the
 [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.
      .google.cloud.kms.v1.ChecksummedData public_key = 8;
      Returns:
      Whether the publicKey field is set.

    • getPublicKey

      ChecksummedData getPublicKey()
       This field contains the public key (with integrity verification), formatted
 according to the
 [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.
      .google.cloud.kms.v1.ChecksummedData public_key = 8;
      Returns:
      The publicKey.

    • getPublicKeyOrBuilder

      ChecksummedDataOrBuilder getPublicKeyOrBuilder()
       This field contains the public key (with integrity verification), formatted
 according to the
 [public_key_format][google.cloud.kms.v1.PublicKey.public_key_format] field.
      .google.cloud.kms.v1.ChecksummedData public_key = 8;