Firestore Admin v1 API - Class BackupSchedule (3.8.0)

public sealed class BackupSchedule : IMessage<BackupSchedule>, IEquatable<BackupSchedule>, IDeepCloneable<BackupSchedule>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore Admin v1 API class BackupSchedule.

A backup schedule for a Cloud Firestore Database.

This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.

Inheritance

object > BackupSchedule

Implements

IMessage BackupSchedule, IEquatable BackupSchedule, IDeepCloneable BackupSchedule, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.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`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The timestamp at which this backup schedule was created and effective since.

No backups will be created for this schedule before this time.

Property Value
Type	Description
`Timestamp`

DailyRecurrence

public DailyRecurrence DailyRecurrence { get; set; }

For a schedule that runs daily at a specified time.

Property Value
Type	Description
`DailyRecurrence`

Name

public string Name { get; set; }

Output only. The unique backup schedule identifier across all locations and databases for the given project.

This will be auto-assigned.

Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

Property Value
Type	Description
`string`

RecurrenceCase

public BackupSchedule.RecurrenceOneofCase RecurrenceCase { get; }

Property Value
Type	Description
`BackupScheduleRecurrenceOneofCase`

Retention

public Duration Retention { get; set; }

At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.

Property Value
Type	Description
`Duration`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.

Property Value
Type	Description
`Timestamp`

WeeklyRecurrence

public WeeklyRecurrence WeeklyRecurrence { get; set; }

For a schedule that runs weekly on a specific day and time.

Property Value
Type	Description
`WeeklyRecurrence`