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
Namespace
Google \ Cloud \ Spanner \ Admin \ Database \ V1Methods
__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 |
↳ kms_key_names |
array
Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form |
getEncryptionType
Required. The encryption type of the backup.
| Returns | |
|---|---|
| Type | Description |
int |
|
setEncryptionType
Required. The encryption type of the backup.
| 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>.
| 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>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKmsKeyNames
Optional. Specifies the KMS configuration for the one or more keys used to
protect the backup. Values are of the form
projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
Kms keys specified can be in any order. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples:
- For single region instance configs, specify a single regional location KMS key.
- For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
- For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setKmsKeyNames
Optional. Specifies the KMS configuration for the one or more keys used to
protect the backup. Values are of the form
projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
Kms keys specified can be in any order. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples:
- For single region instance configs, specify a single regional location KMS key.
- For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config.
- For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|