publicinterfaceRestoreDatabaseEncryptionConfigOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
getEncryptionType()
publicabstractRestoreDatabaseEncryptionConfig.EncryptionTypegetEncryptionType()Required. The encryption type of the restored database.
.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
RestoreDatabaseEncryptionConfig.EncryptionType | The encryptionType. |
getEncryptionTypeValue()
publicabstractintgetEncryptionTypeValue()Required. The encryption type of the restored database.
.google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.EncryptionType encryption_type = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for encryptionType. |
getKmsKeyName()
publicabstractStringgetKmsKeyName() Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. 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>.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The kmsKeyName. |
getKmsKeyNameBytes()
publicabstractByteStringgetKmsKeyNameBytes() Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. 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>.
string kms_key_name = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for kmsKeyName. |
getKmsKeyNames(int index)
publicabstractStringgetKmsKeyNames(intindex) Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:
- For single region database instance configs, specify a single regional location KMS key.
- For multi-regional database 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 a database 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.
repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The kmsKeyNames at the given index. |
getKmsKeyNamesBytes(int index)
publicabstractByteStringgetKmsKeyNamesBytes(intindex) Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:
- For single region database instance configs, specify a single regional location KMS key.
- For multi-regional database 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 a database 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.
repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the kmsKeyNames at the given index. |
getKmsKeyNamesCount()
publicabstractintgetKmsKeyNamesCount() Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:
- For single region database instance configs, specify a single regional location KMS key.
- For multi-regional database 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 a database 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.
repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
int | The count of kmsKeyNames. |
getKmsKeyNamesList()
publicabstractList<String>getKmsKeyNamesList() Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.
The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples:
- For single region database instance configs, specify a single regional location KMS key.
- For multi-regional database 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 a database 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.
repeated string kms_key_names = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the kmsKeyNames. |
