# Google Cloud Spanner Database Administration v1 API - Class BackupSchedule (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 BackupSchedule : IMessage<BackupSchedule>, IEquatable<BackupSchedule>, IDeepCloneable<BackupSchedule>, IBufferMessage, IMessage

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

BackupSchedule expresses the automated backup creation specification for a
Spanner database.
Next ID: 10

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> BackupSchedule

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[BackupSchedule](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupSchedule), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[BackupSchedule](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupSchedule), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[BackupSchedule](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupSchedule), [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

### BackupSchedule()

    public BackupSchedule()

### BackupSchedule(BackupSchedule)

    public BackupSchedule(BackupSchedule 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.BackupSchedule` |

## Properties

### BackupScheduleName

    public BackupScheduleName BackupScheduleName { get; set; }

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

### BackupTypeSpecCase

    public BackupSchedule.BackupTypeSpecOneofCase BackupTypeSpecCase { get; }

| **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.BackupSchedulehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupSchedule.BackupTypeSpecOneofCase` |   |

### EncryptionConfig

    public CreateBackupEncryptionConfig EncryptionConfig { get; set; }

Optional. The encryption configuration that will be used to encrypt the
backup. If this field is not specified, the backup will use the same
encryption configuration as the database.

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

### FullBackupSpec

    public FullBackupSpec FullBackupSpec { get; set; }

The schedule creates only full backups.

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

### IncrementalBackupSpec

    public IncrementalBackupSpec IncrementalBackupSpec { get; set; }

The schedule creates incremental backup chains.

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

### Name

    public string Name { get; set; }

Identifier. Output only for the
\[CreateBackupSchedule\]\[DatabaseAdmin.CreateBackupSchededule\] operation.
Required for the
\[UpdateBackupSchedule\]\[google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackupSchedule\]
operation. A globally unique identifier for the backup schedule which
cannot be changed. Values are of the form
`projects/<project>/instances/<instance>/databases/<database>/backupSchedules/[a-z][a-z0-9_\-]*[a-z0-9]`
The final segment of the name must be between 2 and 60 characters in
length.

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

### RetentionDuration

    public Duration RetentionDuration { get; set; }

Optional. The retention duration of a backup that must be at least 6 hours
and at most 366 days. The backup is eligible to be automatically deleted
once the retention period has elapsed.

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

### Spec

    public BackupScheduleSpec Spec { get; set; }

Optional. The schedule specification based on which the backup creations
are triggered.

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

### UpdateTime

    public Timestamp UpdateTime { get; set; }

Output only. The timestamp at which the schedule was last updated.
If the schedule has never been updated, this field contains the timestamp
when the schedule was first created.

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