Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::PublicKey.
The public keys for a given CryptoKeyVersion. Obtained via GetPublicKey.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#algorithm
def algorithm() -> ::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm
Returns
- (::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm) — The Algorithm associated with this key.
#algorithm=
def algorithm=(value) -> ::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm
Parameter
- value (::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm) — The Algorithm associated with this key.
Returns
- (::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm) — The Algorithm associated with this key.
#name
def name() -> ::String
Returns
-
(::String) — The name of the
CryptoKeyVersion public key.
Provided here for verification.
NOTE: This field is in Beta.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — The name of the
CryptoKeyVersion public key.
Provided here for verification.
NOTE: This field is in Beta.
Returns
-
(::String) — The name of the
CryptoKeyVersion public key.
Provided here for verification.
NOTE: This field is in Beta.
#pem
def pem() -> ::String
Returns
- (::String) — A public key encoded in PEM format, populated only when GetPublicKey returns one key. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.
#pem=
def pem=(value) -> ::String
Parameter
- value (::String) — A public key encoded in PEM format, populated only when GetPublicKey returns one key. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.
Returns
- (::String) — A public key encoded in PEM format, populated only when GetPublicKey returns one key. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.
#pem_crc32c
def pem_crc32c() -> ::Google::Protobuf::Int64Value
Returns
-
(::Google::Protobuf::Int64Value) — Integrity verification field: A CRC32C checksum of the returned
PublicKey.pem. It is only populated
when GetPublicKey
returns one key. An integrity check of
PublicKey.pem can be performed by
computing the CRC32C checksum of
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.
#pem_crc32c=
def pem_crc32c=(value) -> ::Google::Protobuf::Int64Value
Parameter
-
value (::Google::Protobuf::Int64Value) — Integrity verification field: A CRC32C checksum of the returned
PublicKey.pem. It is only populated
when GetPublicKey
returns one key. An integrity check of
PublicKey.pem can be performed by
computing the CRC32C checksum of
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.
Returns
-
(::Google::Protobuf::Int64Value) — Integrity verification field: A CRC32C checksum of the returned
PublicKey.pem. It is only populated
when GetPublicKey
returns one key. An integrity check of
PublicKey.pem can be performed by
computing the CRC32C checksum of
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.
#protection_level
def protection_level() -> ::Google::Cloud::Kms::V1::ProtectionLevel
Returns
- (::Google::Cloud::Kms::V1::ProtectionLevel) — The ProtectionLevel of the CryptoKeyVersion public key.
#protection_level=
def protection_level=(value) -> ::Google::Cloud::Kms::V1::ProtectionLevel
Parameter
- value (::Google::Cloud::Kms::V1::ProtectionLevel) — The ProtectionLevel of the CryptoKeyVersion public key.
Returns
- (::Google::Cloud::Kms::V1::ProtectionLevel) — The ProtectionLevel of the CryptoKeyVersion public key.