public sealed class BackupPlan.Types.Schedule : IMessage<BackupPlan.Types.Schedule>, IEquatable<BackupPlan.Types.Schedule>, IDeepCloneable<BackupPlan.Types.Schedule>, IBufferMessage, IMessage
Reference documentation and code samples for the Backup for GKE v1 API class BackupPlan.Types.Schedule.
Defines scheduling parameters for automatically creating Backups
via this BackupPlan.
Optional. A standard cron string that
defines a repeating schedule for creating Backups via this BackupPlan.
This is mutually exclusive with the
[rpo_config][google.cloud.gkebackup.v1.BackupPlan.Schedule.rpo_config]
field since at most one schedule can be defined for a BackupPlan. If this
is defined, then
[backup_retain_days][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_retain_days]
must also be defined.
Default (empty): no automatic backup creation will occur.
Optional. Defines the RPO schedule configuration for this BackupPlan.
This is mutually exclusive with the
[cron_schedule][google.cloud.gkebackup.v1.BackupPlan.Schedule.cron_schedule]
field since at most one schedule can be defined for a BackupPLan. If this
is defined, then
[backup_retain_days][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_retain_days]
must also be defined.
Default (empty): no automatic backup creation will occur.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis document provides reference information for the \u003ccode\u003eBackupPlan.Types.Schedule\u003c/code\u003e class within the Google Cloud GKE Backup v1 API, which is used to configure automatic backup schedules.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBackupPlan.Types.Schedule\u003c/code\u003e class can be used to define repeating backup schedules, utilizing either a cron string or an RPO configuration.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCronSchedule\u003c/code\u003e property allows the definition of a custom cron string, while the \u003ccode\u003eRpoConfig\u003c/code\u003e property allows the definition of the RPO schedule, although they can't both be defined simultaneously.\u003c/p\u003e\n"],["\u003cp\u003eThe class also exposes \u003ccode\u003eNextScheduledBackupTime\u003c/code\u003e to indicate the start time of the next scheduled backup and \u003ccode\u003ePaused\u003c/code\u003e to control whether the automatic backups should be executed or not.\u003c/p\u003e\n"],["\u003cp\u003eSeveral versions of this class are listed, ranging from version \u003ccode\u003e1.0.0-beta01\u003c/code\u003e to the latest version, \u003ccode\u003e2.6.0\u003c/code\u003e, which can be seen in the top of the page.\u003c/p\u003e\n"]]],[],null,["# Backup for GKE v1 API - Class BackupPlan.Types.Schedule (2.8.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.8.0 (latest)](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.7.0/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.6.0/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.5.0/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.4.0/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.3.0/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.2.0/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule)\n- [2.1.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.1.0/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.0.0/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule)\n- [1.0.0-beta01](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/1.0.0-beta01/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule) \n\n public sealed class BackupPlan.Types.Schedule : IMessage\u003cBackupPlan.Types.Schedule\u003e, IEquatable\u003cBackupPlan.Types.Schedule\u003e, IDeepCloneable\u003cBackupPlan.Types.Schedule\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Backup for GKE v1 API class BackupPlan.Types.Schedule.\n\nDefines scheduling parameters for automatically creating Backups\nvia this BackupPlan. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e BackupPlan.Types.Schedule \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[BackupPlan](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.BackupPlan)[Types](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.BackupPlan.Types)[Schedule](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[BackupPlan](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.BackupPlan)[Types](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.BackupPlan.Types)[Schedule](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[BackupPlan](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.BackupPlan)[Types](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.BackupPlan.Types)[Schedule](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.BackupPlan.Types.Schedule), [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) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.GkeBackup.V1](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.GkeBackup.V1.dll\n\nConstructors\n------------\n\n### Schedule()\n\n public Schedule()\n\n### Schedule(Schedule)\n\n public Schedule(BackupPlan.Types.Schedule other)\n\nProperties\n----------\n\n### CronSchedule\n\n public string CronSchedule { get; set; }\n\nOptional. A standard [cron](https://wikipedia.com/wiki/cron) string that\ndefines a repeating schedule for creating Backups via this BackupPlan.\nThis is mutually exclusive with the\n\\[rpo_config\\]\\[google.cloud.gkebackup.v1.BackupPlan.Schedule.rpo_config\\]\nfield since at most one schedule can be defined for a BackupPlan. If this\nis defined, then\n\\[backup_retain_days\\]\\[google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_retain_days\\]\nmust also be defined.\n\nDefault (empty): no automatic backup creation will occur.\n\n### NextScheduledBackupTime\n\n public Timestamp NextScheduledBackupTime { get; set; }\n\nOutput only. Start time of next scheduled backup under this BackupPlan by\neither cron_schedule or rpo config.\n\n### Paused\n\n public bool Paused { get; set; }\n\nOptional. This flag denotes whether automatic Backup creation is paused\nfor this BackupPlan.\n\nDefault: False\n\n### RpoConfig\n\n public RpoConfig RpoConfig { get; set; }\n\nOptional. Defines the RPO schedule configuration for this BackupPlan.\nThis is mutually exclusive with the\n\\[cron_schedule\\]\\[google.cloud.gkebackup.v1.BackupPlan.Schedule.cron_schedule\\]\nfield since at most one schedule can be defined for a BackupPLan. If this\nis defined, then\n\\[backup_retain_days\\]\\[google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_retain_days\\]\nmust also be defined.\n\nDefault (empty): no automatic backup creation will occur."]]
