Google Cloud Spanner Database Administration v1 API - Class BackupSchedule (5.0.0-beta04)

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 > BackupSchedule

Namespace

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 BackupSchedule

Properties

BackupScheduleName

public BackupScheduleName BackupScheduleName { get; set; }

BackupScheduleName-typed view over the Name resource name property.

Property Value
Type Description
BackupScheduleName

BackupTypeSpecCase

public BackupSchedule.BackupTypeSpecOneofCase BackupTypeSpecCase { get; }
Property Value
Type Description
BackupScheduleBackupTypeSpecOneofCase

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
CreateBackupEncryptionConfig

FullBackupSpec

public FullBackupSpec FullBackupSpec { get; set; }

The schedule creates only full backups.

Property Value
Type Description
FullBackupSpec

IncrementalBackupSpec

public IncrementalBackupSpec IncrementalBackupSpec { get; set; }

The schedule creates incremental backup chains.

Property Value
Type Description
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
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
Duration

Spec

public BackupScheduleSpec Spec { get; set; }

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

Property Value
Type Description
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
Timestamp