Cloud KMS V1 Client - Class AsymmetricDecryptRequest (1.15.3)

Reference documentation and code samples for the Cloud KMS V1 Client class AsymmetricDecryptRequest.

Request message for KeyManagementService.AsymmetricDecrypt.

Generated from protobuf message google.cloud.kms.v1.AsymmetricDecryptRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the CryptoKeyVersion to use for decryption.

↳ ciphertext string

Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP.

↳ ciphertext_crc32c Google\Protobuf\Int64Value

Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received AsymmetricDecryptRequest.ciphertext 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(AsymmetricDecryptRequest.ciphertext) is equal to AsymmetricDecryptRequest.ciphertext_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 CryptoKeyVersion to use for decryption.

Returns
TypeDescription
string

setName

Required. The resource name of the CryptoKeyVersion to use for decryption.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCiphertext

Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP.

Returns
TypeDescription
string

setCiphertext

Required. The data encrypted with the named CryptoKeyVersion's public key using OAEP.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCiphertextCrc32C

Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.ciphertext.

If specified, KeyManagementService will verify the integrity of the received AsymmetricDecryptRequest.ciphertext 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(AsymmetricDecryptRequest.ciphertext) is equal to AsymmetricDecryptRequest.ciphertext_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.

Returns
TypeDescription
Google\Protobuf\Int64Value|null

hasCiphertextCrc32C

clearCiphertextCrc32C

getCiphertextCrc32CValue

Returns the unboxed value from getCiphertextCrc32C()

Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received AsymmetricDecryptRequest.ciphertext 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(AsymmetricDecryptRequest.ciphertext) is equal to AsymmetricDecryptRequest.ciphertext_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.

Returns
TypeDescription
int|string|null

setCiphertextCrc32C

Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.ciphertext.

If specified, KeyManagementService will verify the integrity of the received AsymmetricDecryptRequest.ciphertext 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(AsymmetricDecryptRequest.ciphertext) is equal to AsymmetricDecryptRequest.ciphertext_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.

Parameter
NameDescription
var Google\Protobuf\Int64Value
Returns
TypeDescription
$this

setCiphertextCrc32CValue

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

Optional. An optional CRC32C checksum of the AsymmetricDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received AsymmetricDecryptRequest.ciphertext 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(AsymmetricDecryptRequest.ciphertext) is equal to AsymmetricDecryptRequest.ciphertext_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.

Parameter
NameDescription
var int|string|null
Returns
TypeDescription
$this