# Cloud KMS V1 Client - Class PublicKey (2.9.0)

2.9.0 (latest) 2.8.0 2.7.0 2.6.0 2.5.2 2.4.0 2.3.1 2.2.0 2.1.6 2.0.0 1.23.0 1.22.1 1.21.4 1.20.3 1.19.0 1.18.1 1.17.0 1.16.4 1.15.3 Reference documentation and code samples for the Cloud KMS V1 Client class PublicKey.

The public keys for a given
[CryptoKeyVersion](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion). Obtained via
[GetPublicKey](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient#_Google_Cloud_Kms_V1_Client_KeyManagementServiceClient__getPublicKey__).

Generated from protobuf message `google.cloud.kms.v1.PublicKey`

## Namespace

Google \\ Cloud \\ Kms \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ pem` | `string` 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). |
| `↳ algorithm` | `int` The [Algorithm](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion.CryptoKeyVersionAlgorithm) associated with this key. |
| `↳ pem_crc32c` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Int64Value` Integrity verification field. A CRC32C checksum of the returned [PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__). An integrity check of [PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__) can be performed by computing the CRC32C checksum of [PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__) 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. |
| `↳ name` | `string` The [name](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion#_Google_Cloud_Kms_V1_CryptoKeyVersion__getName__) of the [CryptoKeyVersion](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) public key. Provided here for verification. NOTE: This field is in Beta. |
| `↳ protection_level` | `int` The [ProtectionLevel](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel) of the [CryptoKeyVersion](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) public key. |
| `↳ public_key_format` | `int` The [PublicKey](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey) format specified by the customer through the [public_key_format](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.GetPublicKeyRequest#_Google_Cloud_Kms_V1_GetPublicKeyRequest__getPublicKeyFormat__) field. |
| `↳ public_key` | `https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ChecksummedData` This field contains the public key (with integrity verification), formatted according to the [public_key_format](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPublicKeyFormat__) field. |

### 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).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setPem

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).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAlgorithm

The
[Algorithm](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion.CryptoKeyVersionAlgorithm)
associated with this key.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [CryptoKeyVersionAlgorithm](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion.CryptoKeyVersionAlgorithm). |

### setAlgorithm

The
[Algorithm](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion.CryptoKeyVersionAlgorithm)
associated with this key.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [CryptoKeyVersionAlgorithm](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion.CryptoKeyVersionAlgorithm). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPemCrc32C

Integrity verification field. A CRC32C checksum of the returned
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__). An integrity check of
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__) can be performed by
computing the CRC32C checksum of
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__) 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** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Int64Value|null` |   |

### hasPemCrc32C

### clearPemCrc32C

### getPemCrc32CUnwrapped

Returns the unboxed value from `getPemCrc32C()`

Integrity verification field. A CRC32C checksum of the returned
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__). An integrity check of
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__) can be performed by
computing the CRC32C checksum of
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__) 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** ||
|---|---|
| **Type** | **Description** |
| `int|string|null` |   |

### setPemCrc32C

Integrity verification field. A CRC32C checksum of the returned
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__). An integrity check of
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__) can be performed by
computing the CRC32C checksum of
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__) 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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Int64Value` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### setPemCrc32CUnwrapped

Sets the field by wrapping a primitive type in a Google\\Protobuf\\Int64Value object.

Integrity verification field. A CRC32C checksum of the returned
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__). An integrity check of
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__) can be performed by
computing the CRC32C checksum of
[PublicKey.pem](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPem__) 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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string|null` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getName

The [name](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion#_Google_Cloud_Kms_V1_CryptoKeyVersion__getName__) of the
[CryptoKeyVersion](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) public key.

Provided here for verification.
NOTE: This field is in Beta.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

The [name](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion#_Google_Cloud_Kms_V1_CryptoKeyVersion__getName__) of the
[CryptoKeyVersion](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) public key.

Provided here for verification.
NOTE: This field is in Beta.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getProtectionLevel

The [ProtectionLevel](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel) of the
[CryptoKeyVersion](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) public key.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ProtectionLevel](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel). |

### setProtectionLevel

The [ProtectionLevel](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel) of the
[CryptoKeyVersion](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) public key.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ProtectionLevel](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPublicKeyFormat

The [PublicKey](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey) format specified by the
customer through the
[public_key_format](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.GetPublicKeyRequest#_Google_Cloud_Kms_V1_GetPublicKeyRequest__getPublicKeyFormat__)
field.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [PublicKeyFormat](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey.PublicKeyFormat). |

### setPublicKeyFormat

The [PublicKey](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey) format specified by the
customer through the
[public_key_format](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.GetPublicKeyRequest#_Google_Cloud_Kms_V1_GetPublicKeyRequest__getPublicKeyFormat__)
field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [PublicKeyFormat](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey.PublicKeyFormat). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPublicKey

This field contains the public key (with integrity verification), formatted
according to the
[public_key_format](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPublicKeyFormat__) field.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ChecksummedData|null` |   |

### hasPublicKey

### clearPublicKey

### setPublicKey

This field contains the public key (with integrity verification), formatted
according to the
[public_key_format](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.PublicKey#_Google_Cloud_Kms_V1_PublicKey__getPublicKeyFormat__) field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ChecksummedData` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |