Google Cloud Backup Dr V1 Client - Class CustomerEncryptionKey (0.4.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class CustomerEncryptionKey.

A customer-supplied encryption key.

Generated from protobuf message google.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.

Parameter
Name Description
var string
Returns
Type Description
$this

getKey

Returns
Type Description
string