Reference documentation and code samples for the Cloud Firestore V1 Client class EncryptionConfig.
Encryption configuration for a new database being created from another source.
The source could be a Backup .
Generated from protobuf message google.firestore.admin.v1.Database.EncryptionConfig
Namespace
Google \ Cloud \ Firestore \ Admin \ V1 \ DatabaseMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ google_default_encryption |
EncryptionConfig\GoogleDefaultEncryptionOptions
Use Google default encryption. |
↳ use_source_encryption |
EncryptionConfig\SourceEncryptionOptions
The database will use the same encryption configuration as the source. |
↳ customer_managed_encryption |
EncryptionConfig\CustomerManagedEncryptionOptions
Use Customer Managed Encryption Keys (CMEK) for encryption. |
getGoogleDefaultEncryption
Use Google default encryption.
| Returns | |
|---|---|
| Type | Description |
EncryptionConfig\GoogleDefaultEncryptionOptions|null |
|
hasGoogleDefaultEncryption
setGoogleDefaultEncryption
Use Google default encryption.
| Parameter | |
|---|---|
| Name | Description |
var |
EncryptionConfig\GoogleDefaultEncryptionOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUseSourceEncryption
The database will use the same encryption configuration as the source.
| Returns | |
|---|---|
| Type | Description |
EncryptionConfig\SourceEncryptionOptions|null |
|
hasUseSourceEncryption
setUseSourceEncryption
The database will use the same encryption configuration as the source.
| Parameter | |
|---|---|
| Name | Description |
var |
EncryptionConfig\SourceEncryptionOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCustomerManagedEncryption
Use Customer Managed Encryption Keys (CMEK) for encryption.
| Returns | |
|---|---|
| Type | Description |
EncryptionConfig\CustomerManagedEncryptionOptions|null |
|
hasCustomerManagedEncryption
setCustomerManagedEncryption
Use Customer Managed Encryption Keys (CMEK) for encryption.
| Parameter | |
|---|---|
| Name | Description |
var |
EncryptionConfig\CustomerManagedEncryptionOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncryptionType
| Returns | |
|---|---|
| Type | Description |
string |
|