Show / Hide Table of Contents

Class Backup

A backup of a Cloud Spanner database.

Inheritance
object
Backup
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Spanner.v1.Data
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class Backup : IDirectResponseSchema

Properties

CreateTime

Output only. The time the 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.

Declaration
[JsonProperty("createTime")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

Database

Required for the 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//instances//databases/.

Declaration
[JsonProperty("database")]
public virtual string Database { get; set; }
Property Value
Type Description
string

DatabaseDialect

Output only. The database dialect information for the backup.

Declaration
[JsonProperty("databaseDialect")]
public virtual string DatabaseDialect { get; set; }
Property Value
Type Description
string

EncryptionInfo

Output only. The encryption information for the backup.

Declaration
[JsonProperty("encryptionInfo")]
public virtual EncryptionInfo EncryptionInfo { get; set; }
Property Value
Type Description
EncryptionInfo

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExpireTime

Required for the 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.

Declaration
[JsonProperty("expireTime")]
public virtual object ExpireTime { get; set; }
Property Value
Type Description
object

MaxExpireTime

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.

Declaration
[JsonProperty("maxExpireTime")]
public virtual object MaxExpireTime { get; set; }
Property Value
Type Description
object

Name

Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form projects//instances//backups/a-z*[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//instances/.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

ReferencingBackups

Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects//instances//backups/. 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.

Declaration
[JsonProperty("referencingBackups")]
public virtual IList<string> ReferencingBackups { get; set; }
Property Value
Type Description
IList<string>

ReferencingDatabases

Output only. The names of the restored databases that reference the backup. The database names are of the form projects//instances//databases/. 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.

Declaration
[JsonProperty("referencingDatabases")]
public virtual IList<string> ReferencingDatabases { get; set; }
Property Value
Type Description
IList<string>

SizeBytes

Output only. Size of the backup in bytes.

Declaration
[JsonProperty("sizeBytes")]
public virtual long? SizeBytes { get; set; }
Property Value
Type Description
long?

State

Output only. The current state of the backup.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

VersionTime

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.

Declaration
[JsonProperty("versionTime")]
public virtual object VersionTime { get; set; }
Property Value
Type Description
object

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX