Cloud Firestore V1 Client - Class CloneDatabaseRequest (1.53.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class CloneDatabaseRequest.

The request message for FirestoreAdmin.CloneDatabase.

Generated from protobuf message google.firestore.admin.v1.CloneDatabaseRequest

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The project to clone the database in. Format is `projects/{project_id}`.
`↳ database_id`	`string` Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid.
`↳ pitr_snapshot`	`PitrSnapshot` Required. Specification of the PITR data to clone from. The source database must exist. The cloned database will be created in the same location as the source database.
`↳ encryption_config`	`Database\EncryptionConfig` Optional. Encryption configuration for the cloned database. If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
`↳ tags`	`array\|Google\Protobuf\Internal\MapField` Optional. Immutable. Tags to be bound to the cloned database. The tags should be provided in the format of `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.

getParent

Required. The project to clone the database in. Format is projects/{project_id}.

Returns
Type	Description
`string`

setParent

Required. The project to clone the database in. Format is projects/{project_id}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDatabaseId

Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database.

This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid.

Returns
Type	Description
`string`

setDatabaseId

Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPitrSnapshot

Required. Specification of the PITR data to clone from. The source database must exist.

The cloned database will be created in the same location as the source database.

Returns
Type	Description
`PitrSnapshot\|null`

hasPitrSnapshot

clearPitrSnapshot

setPitrSnapshot

Required. Specification of the PITR data to clone from. The source database must exist.

The cloned database will be created in the same location as the source database.

Parameter
Name	Description
`var`	`PitrSnapshot`

Returns
Type	Description
`$this`

getEncryptionConfig

Optional. Encryption configuration for the cloned database.

If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.

Returns
Type	Description
`Database\EncryptionConfig\|null`

hasEncryptionConfig

clearEncryptionConfig

setEncryptionConfig