Class Backup

A backup of a Cloud Spanner database.

Inheritance
object
Backup
Implements
Inherited Members
Namespace: Google.Apis.Spanner.v1.Data
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class Backup : IDirectResponseSchema

Properties

BackupSchedules

Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.

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

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

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 string CreateTimeRaw { get; set; }
Property Value
Type Description
string

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

ETag

The ETag of the item.

Declaration
public virtual string ETag { 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

EncryptionInformation

Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The encryption_status field inside of each EncryptionInfo is not populated. At least one of the key versions must be available for the backup to be restored. If a key version is revoked in the middle of a restore, the restore behavior is undefined.

Declaration
[JsonProperty("encryptionInformation")]
public virtual IList<EncryptionInfo> EncryptionInformation { get; set; }
Property Value
Type Description
IList<EncryptionInfo>

ExclusiveSizeBytes

Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.

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

ExpireTime

object representation of ExpireTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime { get; set; }
Property Value
Type Description
object

ExpireTimeDateTimeOffset

DateTimeOffset representation of ExpireTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ExpireTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ExpireTimeRaw

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 string ExpireTimeRaw { get; set; }
Property Value
Type Description
string

FreeableSizeBytes

Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.

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

IncrementalBackupChainId

Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup version_time.

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

InstancePartitions

Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's version_time.

Declaration
[JsonProperty("instancePartitions")]
public virtual IList<BackupInstancePartition> InstancePartitions { get; set; }
Property Value
Type Description
IList<BackupInstancePartition>

MaxExpireTime

object representation of MaxExpireTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use MaxExpireTimeDateTimeOffset instead.")]
public virtual object MaxExpireTime { get; set; }
Property Value
Type Description
object

MaxExpireTimeDateTimeOffset

DateTimeOffset representation of MaxExpireTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? MaxExpireTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

MaxExpireTimeRaw

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 string MaxExpireTimeRaw { get; set; }
Property Value
Type Description
string

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

OldestVersionTime

object representation of OldestVersionTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use OldestVersionTimeDateTimeOffset instead.")]
public virtual object OldestVersionTime { get; set; }
Property Value
Type Description
object

OldestVersionTimeDateTimeOffset

DateTimeOffset representation of OldestVersionTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? OldestVersionTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

OldestVersionTimeRaw

Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.

Declaration
[JsonProperty("oldestVersionTime")]
public virtual string OldestVersionTimeRaw { 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. For a backup in an incremental backup chain, this is the sum of the exclusive_size_bytes of itself and all older backups in the chain.

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

object representation of VersionTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use VersionTimeDateTimeOffset instead.")]
public virtual object VersionTime { get; set; }
Property Value
Type Description
object

VersionTimeDateTimeOffset

DateTimeOffset representation of VersionTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? VersionTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

VersionTimeRaw

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 string VersionTimeRaw { get; set; }
Property Value
Type Description
string

Implements