# Google Cloud Spanner Database Administration v1 API - Class Backup (5.13.0-beta07)

5.13.0-beta07 5.13.0-beta06 5.12.0 (latest) 5.11.0 5.10.0 5.9.0 5.8.0 5.7.0 5.6.0 5.5.0 5.4.0 5.3.0 5.2.0 5.1.0 5.0.0 4.6.0 4.5.0 4.4.0 4.3.0 4.2.0 4.1.0 4.0.0 3.15.1 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0

    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](https://learn.microsoft.com/dotnet/api/system.object) \> Backup

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Backup](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backup), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Backup](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backup), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Backup](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backup), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Spanner.Admin.Database.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/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` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backup` |

## Properties

### BackupName

    public BackupName BackupName { get; set; }

[BackupName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backup#Google_Cloud_Spanner_Admin_Database_V1_Backup_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupName` |   |

### BackupSchedules

    public RepeatedField<string> BackupSchedules { get; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### BackupSchedulesAsBackupScheduleNames

    public ResourceNameList<BackupScheduleName> BackupSchedulesAsBackupScheduleNames { get; }

[BackupScheduleName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupScheduleName)-typed view over the [BackupSchedules](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backup#Google_Cloud_Spanner_Admin_Database_V1_Backup_BackupSchedules) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNameList-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupScheduleName` |   |

### 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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### DatabaseAsDatabaseName

    public DatabaseName DatabaseAsDatabaseName { get; set; }

Google.Cloud.Spanner.Common.V1.DatabaseName-typed view over the [Database](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backup#Google_Cloud_Spanner_Admin_Database_V1_Backup_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** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.DatabaseDialect` |   |

### EncryptionInfo

    public EncryptionInfo EncryptionInfo { get; set; }

Output only. The encryption information for the backup.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.EncryptionInfo` |   |

### EncryptionInformation

    public RepeatedField<EncryptionInfo> EncryptionInformation { get; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.EncryptionInfo` |   |

### ExclusiveSizeBytes

    public long ExclusiveSizeBytes { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### 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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### FreeableSizeBytes

    public long FreeableSizeBytes { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### IncrementalBackupChainId

    public string IncrementalBackupChainId { get; set; }

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`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### InstancePartitions

    public RepeatedField<BackupInstancePartition> InstancePartitions { get; }

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`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupInstancePartition` |   |

### 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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### OldestVersionTime

    public Timestamp OldestVersionTime { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### 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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### ReferencingBackupsAsBackupNames

    public ResourceNameList<BackupName> ReferencingBackupsAsBackupNames { get; }

[BackupName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupName)-typed view over the [ReferencingBackups](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backup#Google_Cloud_Spanner_Admin_Database_V1_Backup_ReferencingBackups) resource name
property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNameList-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupName` |   |

### 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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### ReferencingDatabasesAsDatabaseNames

    public ResourceNameList<DatabaseName> ReferencingDatabasesAsDatabaseNames { get; }

Google.Cloud.Spanner.Common.V1.DatabaseName-typed view over the [ReferencingDatabases](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backup#Google_Cloud_Spanner_Admin_Database_V1_Backup_ReferencingDatabases) resource name
property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNameList-1.htmlGoogle.Cloud.Spanner.Common.V1.DatabaseName` |   |

### SizeBytes

    public long SizeBytes { get; set; }

Output only. Size of the backup in bytes.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### State

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

Output only. The current state of the backup.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backuphttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backup.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.Backup.Types.State` |   |

### 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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |