Google Cloud Spanner Database Administration v1 API - Class Backup (5.0.0-beta03) 

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

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

A backup of a Cloud Spanner database.

Inheritance

object > Backup

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

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

Constructors

Backup()

public Backup()

Backup(Backup)

public Backup(Backup other)
Parameter
Name Description
other Backup

Properties

BackupName

public BackupName BackupName { get; set; }

BackupName-typed view over the Name resource name property.

Property Value
Type Description
BackupName

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received. If the request does not specify version_time, the version_time of the backup will be equivalent to the create_time.

Property Value
Type Description
Timestamp

Database

public string Database { get; set; }

Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

Property Value
Type Description
string

DatabaseAsDatabaseName

public DatabaseName DatabaseAsDatabaseName { get; set; }

Google.Cloud.Spanner.Common.V1.DatabaseName-typed view over the Database resource name property.

Property Value
Type Description
Google.Cloud.Spanner.Common.V1.DatabaseName

DatabaseDialect

public DatabaseDialect DatabaseDialect { get; set; }

Output only. The database dialect information for the backup.

Property Value
Type Description
DatabaseDialect

EncryptionInfo

public EncryptionInfo EncryptionInfo { get; set; }

Output only. The encryption information for the backup.

Property Value
Type Description
EncryptionInfo

ExpireTime

public Timestamp ExpireTime { get; set; }

Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

Property Value
Type Description
Timestamp

MaxExpireTime

public Timestamp MaxExpireTime { get; set; }

Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than Backup.max_expire_time.

Property Value
Type Description
Timestamp

Name

public string Name { get; set; }

Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation. Required for the [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup] operation.

A globally unique identifier for the backup which cannot be changed. Values are of the form projects/<project>/instances/<instance>/backups/[a-z][a-z0-9_\-]*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length.

The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects/<project>/instances/<instance>.

Property Value
Type Description
string

ReferencingBackups

public RepeatedField<string> ReferencingBackups { get; }

Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects/<project>/instances/<instance>/backups/<backup>. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.

Property Value
Type Description
RepeatedFieldstring

ReferencingBackupsAsBackupNames

public ResourceNameList<BackupName> ReferencingBackupsAsBackupNames { get; }

BackupName-typed view over the ReferencingBackups resource name property.

Property Value
Type Description
ResourceNameListBackupName

ReferencingDatabases

public RepeatedField<string> ReferencingDatabases { get; }

Output only. The names of the restored databases that reference the backup. The database names are of the form projects/<project>/instances/<instance>/databases/<database>. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.

Property Value
Type Description
RepeatedFieldstring

ReferencingDatabasesAsDatabaseNames

public ResourceNameList<DatabaseName> ReferencingDatabasesAsDatabaseNames { get; }

Google.Cloud.Spanner.Common.V1.DatabaseName-typed view over the ReferencingDatabases resource name property.

Property Value
Type Description
ResourceNameListGoogle.Cloud.Spanner.Common.V1.DatabaseName

SizeBytes

public long SizeBytes { get; set; }

Output only. Size of the backup in bytes.

Property Value
Type Description
long

State

public Backup.Types.State State { get; set; }

Output only. The current state of the backup.

Property Value
Type Description
BackupTypesState

VersionTime

public Timestamp VersionTime { get; set; }

The backup will contain an externally consistent copy of the database at the timestamp specified by version_time. If version_time is not specified, the system will set version_time to the create_time of the backup.

Property Value
Type Description
Timestamp