Reference documentation and code samples for the Cloud Spanner V1 Client class CopyBackupEncryptionConfig.
Encryption configuration for the copied backup.
Generated from protobuf message google.spanner.admin.database.v1.CopyBackupEncryptionConfig
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
getEncryptionType
Required. The encryption type of the backup.
Generated from protobuf field .google.spanner.admin.database.v1.CopyBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
setEncryptionType
Required. The encryption type of the backup.
Generated from protobuf field .google.spanner.admin.database.v1.CopyBackupEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |