# Cloud KMS V1 Client - Class RawEncryptResponse (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 RawEncryptResponse.

Response message for
[KeyManagementService.RawEncrypt](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient#_Google_Cloud_Kms_V1_Client_KeyManagementServiceClient__rawEncrypt__).

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

## Namespace

Google \\ Cloud \\ Kms \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ ciphertext` | `string` The encrypted data. In the case of AES-GCM, the authentication tag is the [tag_length](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawEncryptResponse#_Google_Cloud_Kms_V1_RawEncryptResponse__getTagLength__) bytes at the end of this field. |
| `↳ initialization_vector` | `string` The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in [RawDecryptRequest.initialization_vector](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawDecryptRequest#_Google_Cloud_Kms_V1_RawDecryptRequest__getInitializationVector__) at decryption time. |
| `↳ tag_length` | `int` The length of the authentication tag that is appended to the end of the ciphertext. |
| `↳ ciphertext_crc32c` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Int64Value` Integrity verification field. A CRC32C checksum of the returned [RawEncryptResponse.ciphertext](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawEncryptResponse#_Google_Cloud_Kms_V1_RawEncryptResponse__getCiphertext__). An integrity check of ciphertext can be performed by computing the CRC32C checksum of ciphertext 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. |
| `↳ initialization_vector_crc32c` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Int64Value` Integrity verification field. A CRC32C checksum of the returned [RawEncryptResponse.initialization_vector](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawEncryptResponse#_Google_Cloud_Kms_V1_RawEncryptResponse__getInitializationVector__). An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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. |
| `↳ verified_plaintext_crc32c` | `bool` Integrity verification field. A flag indicating whether RawEncryptRequest.plaintext_crc32c was received by [KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient) and used for the integrity verification of the plaintext. A false value of this field indicates either that RawEncryptRequest.plaintext_crc32c was left unset or that it was not delivered to [KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient). If you've set RawEncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries. |
| `↳ verified_additional_authenticated_data_crc32c` | `bool` Integrity verification field. A flag indicating whether RawEncryptRequest.additional_authenticated_data_crc32c was received by [KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient) and used for the integrity verification of additional_authenticated_data. A false value of this field indicates either that // RawEncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to [KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient). If you've set RawEncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries. |
| `↳ verified_initialization_vector_crc32c` | `bool` Integrity verification field. A flag indicating whether RawEncryptRequest.initialization_vector_crc32c was received by [KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient) and used for the integrity verification of initialization_vector. A false value of this field indicates either that RawEncryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to [KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient). If you've set RawEncryptRequest.initialization_vector_crc32c but this field is still false, discard the response and perform a limited number of retries. |
| `↳ name` | `string` The resource name of the [CryptoKeyVersion](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) used in encryption. Check this field to verify that the intended resource was used for encryption. |
| `↳ 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) used in encryption. |

### getCiphertext

The encrypted data. In the case of AES-GCM, the authentication tag
is the [tag_length](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawEncryptResponse#_Google_Cloud_Kms_V1_RawEncryptResponse__getTagLength__)
bytes at the end of this field.

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

### setCiphertext

The encrypted data. In the case of AES-GCM, the authentication tag
is the [tag_length](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawEncryptResponse#_Google_Cloud_Kms_V1_RawEncryptResponse__getTagLength__)
bytes at the end of this field.

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

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

### getInitializationVector

The initialization vector (IV) generated by the service during
encryption. This value must be stored and provided in
[RawDecryptRequest.initialization_vector](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawDecryptRequest#_Google_Cloud_Kms_V1_RawDecryptRequest__getInitializationVector__)
at decryption time.

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

### setInitializationVector

The initialization vector (IV) generated by the service during
encryption. This value must be stored and provided in
[RawDecryptRequest.initialization_vector](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawDecryptRequest#_Google_Cloud_Kms_V1_RawDecryptRequest__getInitializationVector__)
at decryption time.

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

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

### getTagLength

The length of the authentication tag that is appended to
the end of the ciphertext.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setTagLength

The length of the authentication tag that is appended to
the end of the ciphertext.

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

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

### getCiphertextCrc32C

Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.ciphertext](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawEncryptResponse#_Google_Cloud_Kms_V1_RawEncryptResponse__getCiphertext__).

An integrity check of ciphertext can be performed by computing the CRC32C
checksum of ciphertext 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Int64Value|null` |   |

### hasCiphertextCrc32C

### clearCiphertextCrc32C

### getCiphertextCrc32CUnwrapped

Returns the unboxed value from `getCiphertextCrc32C()`

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

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

### setCiphertextCrc32C

Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.ciphertext](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawEncryptResponse#_Google_Cloud_Kms_V1_RawEncryptResponse__getCiphertext__).

An integrity check of ciphertext can be performed by computing the CRC32C
checksum of ciphertext 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.

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

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

### setCiphertextCrc32CUnwrapped

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

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

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

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

### getInitializationVectorCrc32C

Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.initialization_vector](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawEncryptResponse#_Google_Cloud_Kms_V1_RawEncryptResponse__getInitializationVector__).

An integrity check of initialization_vector can be performed by computing
the CRC32C checksum of initialization_vector 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Int64Value|null` |   |

### hasInitializationVectorCrc32C

### clearInitializationVectorCrc32C

### getInitializationVectorCrc32CUnwrapped

Returns the unboxed value from `getInitializationVectorCrc32C()`

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

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

### setInitializationVectorCrc32C

Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.initialization_vector](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.RawEncryptResponse#_Google_Cloud_Kms_V1_RawEncryptResponse__getInitializationVector__).

An integrity check of initialization_vector can be performed by computing
the CRC32C checksum of initialization_vector 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.

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

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

### setInitializationVectorCrc32CUnwrapped

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

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

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

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

### getVerifiedPlaintextCrc32C

Integrity verification field. A flag indicating whether
RawEncryptRequest.plaintext_crc32c
was received by
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient) and used
for the integrity verification of the plaintext. A false value of this
field indicates either that
RawEncryptRequest.plaintext_crc32c
was left unset or that it was not delivered to
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient). If you've
set
RawEncryptRequest.plaintext_crc32c
but this field is still false, discard the response and perform a limited
number of retries.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setVerifiedPlaintextCrc32C

Integrity verification field. A flag indicating whether
RawEncryptRequest.plaintext_crc32c
was received by
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient) and used
for the integrity verification of the plaintext. A false value of this
field indicates either that
RawEncryptRequest.plaintext_crc32c
was left unset or that it was not delivered to
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient). If you've
set
RawEncryptRequest.plaintext_crc32c
but this field is still false, discard the response and perform a limited
number of retries.

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

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

### getVerifiedAdditionalAuthenticatedDataCrc32C

Integrity verification field. A flag indicating whether
RawEncryptRequest.additional_authenticated_data_crc32c
was received by
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient) and used
for the integrity verification of additional_authenticated_data. A false
value of this field indicates either that //
RawEncryptRequest.additional_authenticated_data_crc32c
was left unset or that it was not delivered to
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient). If you've
set
RawEncryptRequest.additional_authenticated_data_crc32c
but this field is still false, discard the response and perform a limited
number of retries.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setVerifiedAdditionalAuthenticatedDataCrc32C

Integrity verification field. A flag indicating whether
RawEncryptRequest.additional_authenticated_data_crc32c
was received by
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient) and used
for the integrity verification of additional_authenticated_data. A false
value of this field indicates either that //
RawEncryptRequest.additional_authenticated_data_crc32c
was left unset or that it was not delivered to
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient). If you've
set
RawEncryptRequest.additional_authenticated_data_crc32c
but this field is still false, discard the response and perform a limited
number of retries.

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

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

### getVerifiedInitializationVectorCrc32C

Integrity verification field. A flag indicating whether
RawEncryptRequest.initialization_vector_crc32c
was received by
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient) and used
for the integrity verification of initialization_vector. A false value of
this field indicates either that
RawEncryptRequest.initialization_vector_crc32c
was left unset or that it was not delivered to
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient). If you've
set
RawEncryptRequest.initialization_vector_crc32c
but this field is still false, discard the response and perform a limited
number of retries.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setVerifiedInitializationVectorCrc32C

Integrity verification field. A flag indicating whether
RawEncryptRequest.initialization_vector_crc32c
was received by
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient) and used
for the integrity verification of initialization_vector. A false value of
this field indicates either that
RawEncryptRequest.initialization_vector_crc32c
was left unset or that it was not delivered to
[KeyManagementService](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.Client.KeyManagementServiceClient). If you've
set
RawEncryptRequest.initialization_vector_crc32c
but this field is still false, discard the response and perform a limited
number of retries.

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

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

### getName

The resource name of the
[CryptoKeyVersion](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) used in
encryption. Check this field to verify that the intended resource was used
for encryption.

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

### setName

The resource name of the
[CryptoKeyVersion](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) used in
encryption. Check this field to verify that the intended resource was used
for encryption.

| **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) used in
encryption.

| **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) used in
encryption.

| **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` |   |