Google Cloud Spanner Database Administration v1 API - Class RestoreDatabaseRequest (5.0.0-beta02)

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

Reference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class RestoreDatabaseRequest.

The request for [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].

Inheritance

object > RestoreDatabaseRequest

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

Google.Cloud.Spanner.Admin.Database.V1.dll

Constructors

RestoreDatabaseRequest()

public RestoreDatabaseRequest()

RestoreDatabaseRequest(RestoreDatabaseRequest)

public RestoreDatabaseRequest(RestoreDatabaseRequest other)
Parameter
NameDescription
otherRestoreDatabaseRequest

Properties

Backup

public string Backup { get; set; }

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

Property Value
TypeDescription
string

BackupAsBackupName

public BackupName BackupAsBackupName { get; set; }

BackupName-typed view over the Backup resource name property.

Property Value
TypeDescription
BackupName

DatabaseId

public string DatabaseId { get; set; }

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.

Property Value
TypeDescription
string

EncryptionConfig

public RestoreDatabaseEncryptionConfig EncryptionConfig { get; set; }

Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type] = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.

Property Value
TypeDescription
RestoreDatabaseEncryptionConfig

HasBackup

public bool HasBackup { get; }

Gets whether the "backup" field is set

Property Value
TypeDescription
bool

Parent

public string Parent { get; set; }

Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.

Property Value
TypeDescription
string

ParentAsInstanceName

public InstanceName ParentAsInstanceName { get; set; }

Google.Cloud.Spanner.Common.V1.InstanceName-typed view over the Parent resource name property.

Property Value
TypeDescription
Google.Cloud.Spanner.Common.V1.InstanceName

SourceCase

public RestoreDatabaseRequest.SourceOneofCase SourceCase { get; }
Property Value
TypeDescription
RestoreDatabaseRequestSourceOneofCase