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 \ V1Methods
__construct
Constructor.
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}
.
string
setParent
Required. The project to clone the database in. Format is projects/{project_id}
.
var
string
$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.
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.
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.
var
string
$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.
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.
$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 .
hasEncryptionConfig
clearEncryptionConfig
setEncryptionConfig
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 .
$this
getTags
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}
.
setTags
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}
.
$this
