Cloud Spanner V1 Client - Class CreateBackupEncryptionConfig (1.54.2)

Reference documentation and code samples for the Cloud Spanner V1 Client class CreateBackupEncryptionConfig.

Encryption configuration for the backup to create.

Generated from protobuf message google.spanner.admin.database.v1.CreateBackupEncryptionConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ encryption_type int

Required. The encryption type of the backup.

↳ kms_key_name string

Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

getEncryptionType

Required. The encryption type of the backup.

Generated from protobuf field .google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

setEncryptionType

Required. The encryption type of the backup.

Generated from protobuf field .google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getKmsKeyName

Optional. The Cloud KMS key that will be used to protect the backup.

This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

Generated from protobuf field string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setKmsKeyName

Optional. The Cloud KMS key that will be used to protect the backup.

This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

Generated from protobuf field string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this