public sealed class CloneDatabaseRequest : IMessage<CloneDatabaseRequest>, IEquatable<CloneDatabaseRequest>, IDeepCloneable<CloneDatabaseRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Firestore Admin v1 API class CloneDatabaseRequest.
The request message for [FirestoreAdmin.CloneDatabase][google.firestore.admin.v1.FirestoreAdmin.CloneDatabase].
Implements
IMessageCloneDatabaseRequest, IEquatableCloneDatabaseRequest, IDeepCloneableCloneDatabaseRequest, IBufferMessage, IMessageNamespace
Google.Cloud.Firestore.Admin.V1Assembly
Google.Cloud.Firestore.Admin.V1.dll
Constructors
CloneDatabaseRequest()
public CloneDatabaseRequest()
CloneDatabaseRequest(CloneDatabaseRequest)
public CloneDatabaseRequest(CloneDatabaseRequest other)
Parameter | |
---|---|
Name | Description |
other |
CloneDatabaseRequest |
Properties
DatabaseId
public string DatabaseId { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
EncryptionConfig
public Database.Types.EncryptionConfig EncryptionConfig { get; set; }
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][google.firestore.admin.v1.Database.EncryptionConfig.use_source_encryption].
Property Value | |
---|---|
Type | Description |
DatabaseTypesEncryptionConfig |
Parent
public string Parent { get; set; }
Required. The project to clone the database in. Format is
projects/{project_id}
.
Property Value | |
---|---|
Type | Description |
string |
ParentAsProjectName
public ProjectName ParentAsProjectName { get; set; }
ProjectName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
ProjectName |
PitrSnapshot
public PitrSnapshot PitrSnapshot { get; set; }
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.
Property Value | |
---|---|
Type | Description |
PitrSnapshot |
Tags
public MapField<string, string> Tags { get; }
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}
.
Property Value | |
---|---|
Type | Description |
MapFieldstringstring |