Reference documentation and code samples for the Cloud KMS V1 Client class EncryptRequest.
Request message for KeyManagementService.Encrypt .
Generated from protobuf message google.cloud.kms.v1.EncryptRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version .
↳ plaintext
string
Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level . For SOFTWARE , EXTERNAL , and EXTERNAL_VPC keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.
↳ additional_authenticated_data
string
Optional. Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data . The maximum size depends on the key version's protection_level . For SOFTWARE , EXTERNAL , and EXTERNAL_VPC keys the AAD must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.
↳ plaintext_crc32c
Google\Protobuf\Int64Value
Optional. An optional CRC32C checksum of the EncryptRequest.plaintext . If specified, KeyManagementService will verify the integrity of the received EncryptRequest.plaintext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C( EncryptRequest.plaintext ) is equal to EncryptRequest.plaintext_crc32c , and if so, 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.
↳ additional_authenticated_data_crc32c
Google\Protobuf\Int64Value
Optional. An optional CRC32C checksum of the EncryptRequest.additional_authenticated_data . If specified, KeyManagementService will verify the integrity of the received EncryptRequest.additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C( EncryptRequest.additional_authenticated_data ) is equal to EncryptRequest.additional_authenticated_data_crc32c , and if so, 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.
getName
Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption.
If a CryptoKey is specified, the server will use its primary version .
string
setName
Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption.
If a CryptoKey is specified, the server will use its primary version .
var
string
$this
getPlaintext
Required. The data to encrypt. Must be no larger than 64KiB.
The maximum size depends on the key version's protection_level . For SOFTWARE , EXTERNAL , and EXTERNAL_VPC keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.
string
setPlaintext
Required. The data to encrypt. Must be no larger than 64KiB.
The maximum size depends on the key version's protection_level . For SOFTWARE , EXTERNAL , and EXTERNAL_VPC keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.
var
string
$this
getAdditionalAuthenticatedData
Optional. Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data .
The maximum size depends on the key version's protection_level . For SOFTWARE , EXTERNAL , and EXTERNAL_VPC keys the AAD must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.
string
setAdditionalAuthenticatedData
Optional. Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data .
The maximum size depends on the key version's protection_level . For SOFTWARE , EXTERNAL , and EXTERNAL_VPC keys the AAD must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB.
var
string
$this
getPlaintextCrc32C
Optional. An optional CRC32C checksum of the EncryptRequest.plaintext .
If specified, KeyManagementService will verify the integrity of the received EncryptRequest.plaintext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C( EncryptRequest.plaintext ) is equal to EncryptRequest.plaintext_crc32c , and if so, 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.
hasPlaintextCrc32C
clearPlaintextCrc32C
getPlaintextCrc32CValue
Returns the unboxed value from getPlaintextCrc32C()
Optional. An optional CRC32C checksum of the EncryptRequest.plaintext . If specified, KeyManagementService will verify the integrity of the received EncryptRequest.plaintext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C( EncryptRequest.plaintext ) is equal to EncryptRequest.plaintext_crc32c , and if so, 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.
int|string|null
setPlaintextCrc32C
Optional. An optional CRC32C checksum of the EncryptRequest.plaintext .
If specified, KeyManagementService will verify the integrity of the received EncryptRequest.plaintext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C( EncryptRequest.plaintext ) is equal to EncryptRequest.plaintext_crc32c , and if so, 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.
$this
setPlaintextCrc32CValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Optional. An optional CRC32C checksum of the EncryptRequest.plaintext . If specified, KeyManagementService will verify the integrity of the received EncryptRequest.plaintext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C( EncryptRequest.plaintext ) is equal to EncryptRequest.plaintext_crc32c , and if so, 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.
var
int|string|null
$this
getAdditionalAuthenticatedDataCrc32C
Optional. An optional CRC32C checksum of the EncryptRequest.additional_authenticated_data .
If specified, KeyManagementService will verify the integrity of the received EncryptRequest.additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C( EncryptRequest.additional_authenticated_data ) is equal to EncryptRequest.additional_authenticated_data_crc32c , and if so, 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.
hasAdditionalAuthenticatedDataCrc32C
clearAdditionalAuthenticatedDataCrc32C
getAdditionalAuthenticatedDataCrc32CValue
Returns the unboxed value from getAdditionalAuthenticatedDataCrc32C()
Optional. An optional CRC32C checksum of the EncryptRequest.additional_authenticated_data . If specified, KeyManagementService will verify the integrity of the received EncryptRequest.additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C( EncryptRequest.additional_authenticated_data ) is equal to EncryptRequest.additional_authenticated_data_crc32c , and if so, 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.
int|string|null
setAdditionalAuthenticatedDataCrc32C
Optional. An optional CRC32C checksum of the EncryptRequest.additional_authenticated_data .
If specified, KeyManagementService will verify the integrity of the received EncryptRequest.additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C( EncryptRequest.additional_authenticated_data ) is equal to EncryptRequest.additional_authenticated_data_crc32c , and if so, 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.
$this
setAdditionalAuthenticatedDataCrc32CValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Optional. An optional CRC32C checksum of the EncryptRequest.additional_authenticated_data . If specified, KeyManagementService will verify the integrity of the received EncryptRequest.additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C( EncryptRequest.additional_authenticated_data ) is equal to EncryptRequest.additional_authenticated_data_crc32c , and if so, 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.
var
int|string|null
$this
