Compute V1 Client - Class CustomerEncryptionKey (1.5.0)

Reference documentation and code samples for the Compute V1 Client class CustomerEncryptionKey.

Generated from protobuf message google.cloud.compute.v1.CustomerEncryptionKey

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ kms_key_name`	`string` The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key
`↳ kms_key_service_account`	`string` The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
`↳ raw_key`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
`↳ rsa_encrypted_key`	`string` Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
`↳ sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

getKmsKeyName

The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

Generated from protobuf field optional string kms_key_name = 484373913;

Returns
Type	Description
`string`

hasKmsKeyName

clearKmsKeyName

setKmsKeyName

The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

Generated from protobuf field optional string kms_key_name = 484373913;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getKmsKeyServiceAccount

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

Generated from protobuf field optional string kms_key_service_account = 209986261;

Returns
Type	Description
`string`

hasKmsKeyServiceAccount

clearKmsKeyServiceAccount

setKmsKeyServiceAccount

Generated from protobuf field optional string kms_key_service_account = 209986261;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRawKey

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

Generated from protobuf field optional string raw_key = 449196488;

Returns
Type	Description
`string`

hasRawKey

clearRawKey

setRawKey

Generated from protobuf field optional string raw_key = 449196488;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRsaEncryptedKey

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Generated from protobuf field optional string rsa_encrypted_key = 335487397;

Returns
Type	Description
`string`

hasRsaEncryptedKey

clearRsaEncryptedKey

setRsaEncryptedKey

Generated from protobuf field optional string rsa_encrypted_key = 335487397;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSha256

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Generated from protobuf field optional string sha256 = 170112551;

Returns
Type	Description
`string`

hasSha256

clearSha256

setSha256

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Generated from protobuf field optional string sha256 = 170112551;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`