Cloud Firestore V1 Client - Class EncryptionConfig (1.47.0)

Version latest

• 1.47.0 (latest)
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

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 \ Database

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ google_default_encryption	Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig\GoogleDefaultEncryptionOptions Use Google default encryption.
↳ use_source_encryption	Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig\SourceEncryptionOptions The database will use the same encryption configuration as the source.
↳ customer_managed_encryption	Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig\CustomerManagedEncryptionOptions Use Customer Managed Encryption Keys (CMEK) for encryption.

getGoogleDefaultEncryption

Use Google default encryption.

Returns
Type	Description
Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig\GoogleDefaultEncryptionOptions|null

hasGoogleDefaultEncryption

setGoogleDefaultEncryption

Use Google default encryption.

Parameter
Name	Description
var	Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig\GoogleDefaultEncryptionOptions

Returns
Type	Description
$this

getUseSourceEncryption

The database will use the same encryption configuration as the source.

Returns
Type	Description
Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig\SourceEncryptionOptions|null

hasUseSourceEncryption

setUseSourceEncryption

The database will use the same encryption configuration as the source.

Parameter
Name	Description
var	Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig\SourceEncryptionOptions

Returns
Type	Description
$this

getCustomerManagedEncryption

Use Customer Managed Encryption Keys (CMEK) for encryption.

Returns
Type	Description
Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig\CustomerManagedEncryptionOptions|null

hasCustomerManagedEncryption

setCustomerManagedEncryption

Use Customer Managed Encryption Keys (CMEK) for encryption.

Parameter
Name	Description
var	Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig\CustomerManagedEncryptionOptions

Returns
Type	Description
$this

getEncryptionType

Returns
Type	Description
string