Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class CustomerEncryptionKey.
A customer-supplied encryption key.
Generated from protobuf messagegoogle.cloud.backupdr.v1.CustomerEncryptionKey
Namespace
Google \ Cloud \ BackupDR \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ raw_key
string
Optional. Specifies a 256-bit customer-supplied encryption key.
↳ rsa_encrypted_key
string
Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
↳ kms_key_name
string
Optional. The name of the encryption key that is stored in Google Cloud KMS.
↳ kms_key_service_account
string
Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
getRawKey
Optional. Specifies a 256-bit customer-supplied
encryption key.
Returns
Type
Description
string
hasRawKey
setRawKey
Optional. Specifies a 256-bit customer-supplied
encryption key.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRsaEncryptedKey
Optional. RSA-wrapped 2048-bit
customer-supplied encryption key to either encrypt or decrypt this
resource.
Returns
Type
Description
string
hasRsaEncryptedKey
setRsaEncryptedKey
Optional. RSA-wrapped 2048-bit
customer-supplied encryption key to either encrypt or decrypt this
resource.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getKmsKeyName
Optional. The name of the encryption key that is stored in Google Cloud
KMS.
Returns
Type
Description
string
hasKmsKeyName
setKmsKeyName
Optional. The name of the encryption key that is stored in Google Cloud
KMS.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getKmsKeyServiceAccount
Optional. The service account being used for the encryption request for the
given KMS key. If absent, the Compute Engine default service account is
used.
Returns
Type
Description
string
hasKmsKeyServiceAccount
clearKmsKeyServiceAccount
setKmsKeyServiceAccount
Optional. The service account being used for the encryption request for the
given KMS key. If absent, the Compute Engine default service account is
used.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Backup Dr V1 Client - Class CustomerEncryptionKey (0.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.7.0 (latest)](/php/docs/reference/cloud-backupdr/latest/V1.CustomerEncryptionKey)\n- [0.6.2](/php/docs/reference/cloud-backupdr/0.6.2/V1.CustomerEncryptionKey)\n- [0.5.1](/php/docs/reference/cloud-backupdr/0.5.1/V1.CustomerEncryptionKey)\n- [0.4.2](/php/docs/reference/cloud-backupdr/0.4.2/V1.CustomerEncryptionKey)\n- [0.3.0](/php/docs/reference/cloud-backupdr/0.3.0/V1.CustomerEncryptionKey)\n- [0.2.0](/php/docs/reference/cloud-backupdr/0.2.0/V1.CustomerEncryptionKey)\n- [0.1.0](/php/docs/reference/cloud-backupdr/0.1.0/V1.CustomerEncryptionKey) \nReference documentation and code samples for the Google Cloud Backup Dr V1 Client class CustomerEncryptionKey.\n\nA customer-supplied encryption key.\n\nGenerated from protobuf message `google.cloud.backupdr.v1.CustomerEncryptionKey`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BackupDR \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getRawKey\n\nOptional. Specifies a 256-bit customer-supplied\nencryption key.\n\n### hasRawKey\n\n### setRawKey\n\nOptional. Specifies a 256-bit customer-supplied\nencryption key.\n\n### getRsaEncryptedKey\n\nOptional. RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt this\nresource.\n\n### hasRsaEncryptedKey\n\n### setRsaEncryptedKey\n\nOptional. RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt this\nresource.\n\n### getKmsKeyName\n\nOptional. The name of the encryption key that is stored in Google Cloud\nKMS.\n\n### hasKmsKeyName\n\n### setKmsKeyName\n\nOptional. The name of the encryption key that is stored in Google Cloud\nKMS.\n\n### getKmsKeyServiceAccount\n\nOptional. The service account being used for the encryption request for the\ngiven KMS key. If absent, the Compute Engine default service account is\nused.\n\n### hasKmsKeyServiceAccount\n\n### clearKmsKeyServiceAccount\n\n### setKmsKeyServiceAccount\n\nOptional. The service account being used for the encryption request for the\ngiven KMS key. If absent, the Compute Engine default service account is\nused.\n\n### getKey"]]
