Firestore Admin v1 API - Class RestoreDatabaseRequest (3.11.0) 

public sealed class RestoreDatabaseRequest : IMessage<RestoreDatabaseRequest>, IEquatable<RestoreDatabaseRequest>, IDeepCloneable<RestoreDatabaseRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore Admin v1 API class RestoreDatabaseRequest.

The request message for [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.FirestoreAdmin.RestoreDatabase].

Inheritance

object > RestoreDatabaseRequest

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

RestoreDatabaseRequest()

public RestoreDatabaseRequest()

RestoreDatabaseRequest(RestoreDatabaseRequest)

public RestoreDatabaseRequest(RestoreDatabaseRequest other)
Parameter
Name Description
other RestoreDatabaseRequest

Properties

Backup

public string Backup { get; set; }

Required. Backup to restore from. Must be from the same project as the parent.

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

Format is: projects/{project_id}/locations/{location}/backups/{backup}

Property Value
Type Description
string

BackupAsBackupName

public BackupName BackupAsBackupName { get; set; }

BackupName-typed view over the Backup resource name property.

Property Value
Type Description
BackupName

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 restored database.

If this field is not specified, the restored database will use the same encryption configuration as the backup, 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 restore 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