Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class Schedule.
Defines scheduling parameters for automatically creating Backups
via this BackupPlan.
Generated from protobuf message google.cloud.gkebackup.v1.BackupPlan.Schedule
Namespace
Google \ Cloud \ GkeBackup \ V1 \ BackupPlan
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ cron_schedule
string
Optional. A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. This is mutually exclusive with the rpo_config field since at most one schedule can be defined for a BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.
↳ paused
bool
Optional. This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False
Optional. Defines the RPO schedule configuration for this BackupPlan. This is mutually exclusive with the cron_schedule field since at most one schedule can be defined for a BackupPLan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.
Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config.
getCronSchedule
Optional. A standard cron string that
defines a repeating schedule for creating Backups via this BackupPlan.
This is mutually exclusive with the
rpo_config
field since at most one schedule can be defined for a BackupPlan. If this
is defined, then
backup_retain_days
must also be defined.
Default (empty): no automatic backup creation will occur.
Returns
Type
Description
string
setCronSchedule
Optional. A standard cron string that
defines a repeating schedule for creating Backups via this BackupPlan.
This is mutually exclusive with the
rpo_config
field since at most one schedule can be defined for a BackupPlan. If this
is defined, then
backup_retain_days
must also be defined.
Default (empty): no automatic backup creation will occur.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPaused
Optional. This flag denotes whether automatic Backup creation is paused
for this BackupPlan.
Default: False
Returns
Type
Description
bool
setPaused
Optional. This flag denotes whether automatic Backup creation is paused
for this BackupPlan.
Default: False
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getRpoConfig
Optional. Defines the RPO schedule configuration for this BackupPlan.
This is mutually exclusive with the
cron_schedule
field since at most one schedule can be defined for a BackupPLan. If this
is defined, then
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
field since at most one schedule can be defined for a BackupPLan. If this
is defined, then
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"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Gke Backup V1 Client - Class Schedule (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.Schedule)\n- [1.2.0](/php/docs/reference/cloud-gke-backup/1.2.0/V1.BackupPlan.Schedule)\n- [1.0.3](/php/docs/reference/cloud-gke-backup/1.0.3/V1.BackupPlan.Schedule)\n- [0.8.1](/php/docs/reference/cloud-gke-backup/0.8.1/V1.BackupPlan.Schedule)\n- [0.7.2](/php/docs/reference/cloud-gke-backup/0.7.2/V1.BackupPlan.Schedule)\n- [0.6.0](/php/docs/reference/cloud-gke-backup/0.6.0/V1.BackupPlan.Schedule)\n- [0.5.3](/php/docs/reference/cloud-gke-backup/0.5.3/V1.BackupPlan.Schedule)\n- [0.4.0](/php/docs/reference/cloud-gke-backup/0.4.0/V1.BackupPlan.Schedule)\n- [0.3.1](/php/docs/reference/cloud-gke-backup/0.3.1/V1.BackupPlan.Schedule)\n- [0.2.0](/php/docs/reference/cloud-gke-backup/0.2.0/V1.BackupPlan.Schedule)\n- [0.1.7](/php/docs/reference/cloud-gke-backup/0.1.7/V1.BackupPlan.Schedule) \nReference documentation and code samples for the Google Cloud Gke Backup V1 Client class Schedule.\n\nDefines scheduling parameters for automatically creating Backups\nvia this BackupPlan.\n\nGenerated from protobuf message `google.cloud.gkebackup.v1.BackupPlan.Schedule`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ GkeBackup \\\\ V1 \\\\ BackupPlan\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCronSchedule\n\nOptional. A standard [cron](https://wikipedia.com/wiki/cron) string that\ndefines a repeating schedule for creating Backups via this BackupPlan.\n\nThis is mutually exclusive with the\n[rpo_config](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.Schedule#_Google_Cloud_GkeBackup_V1_BackupPlan_Schedule__getRpoConfig__)\nfield since at most one schedule can be defined for a BackupPlan. If this\nis defined, then\n[backup_retain_days](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.RetentionPolicy#_Google_Cloud_GkeBackup_V1_BackupPlan_RetentionPolicy__getBackupRetainDays__)\nmust also be defined.\nDefault (empty): no automatic backup creation will occur.\n\n### setCronSchedule\n\nOptional. A standard [cron](https://wikipedia.com/wiki/cron) string that\ndefines a repeating schedule for creating Backups via this BackupPlan.\n\nThis is mutually exclusive with the\n[rpo_config](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.Schedule#_Google_Cloud_GkeBackup_V1_BackupPlan_Schedule__getRpoConfig__)\nfield since at most one schedule can be defined for a BackupPlan. If this\nis defined, then\n[backup_retain_days](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.RetentionPolicy#_Google_Cloud_GkeBackup_V1_BackupPlan_RetentionPolicy__getBackupRetainDays__)\nmust also be defined.\nDefault (empty): no automatic backup creation will occur.\n\n### getPaused\n\nOptional. This flag denotes whether automatic Backup creation is paused\nfor this BackupPlan.\n\nDefault: False\n\n### setPaused\n\nOptional. This flag denotes whether automatic Backup creation is paused\nfor this BackupPlan.\n\nDefault: False\n\n### getRpoConfig\n\nOptional. Defines the RPO schedule configuration for this BackupPlan.\n\nThis is mutually exclusive with the\n[cron_schedule](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.Schedule#_Google_Cloud_GkeBackup_V1_BackupPlan_Schedule__getCronSchedule__)\nfield since at most one schedule can be defined for a BackupPLan. If this\nis defined, then\n[backup_retain_days](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.RetentionPolicy#_Google_Cloud_GkeBackup_V1_BackupPlan_RetentionPolicy__getBackupRetainDays__)\nmust also be defined.\nDefault (empty): no automatic backup creation will occur.\n\n### hasRpoConfig\n\n### clearRpoConfig\n\n### setRpoConfig\n\nOptional. Defines the RPO schedule configuration for this BackupPlan.\n\nThis is mutually exclusive with the\n[cron_schedule](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.Schedule#_Google_Cloud_GkeBackup_V1_BackupPlan_Schedule__getCronSchedule__)\nfield since at most one schedule can be defined for a BackupPLan. If this\nis defined, then\n[backup_retain_days](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.RetentionPolicy#_Google_Cloud_GkeBackup_V1_BackupPlan_RetentionPolicy__getBackupRetainDays__)\nmust also be defined.\nDefault (empty): no automatic backup creation will occur.\n\n### getNextScheduledBackupTime\n\nOutput only. Start time of next scheduled backup under this BackupPlan by\neither cron_schedule or rpo config.\n\n### hasNextScheduledBackupTime\n\n### clearNextScheduledBackupTime\n\n### setNextScheduledBackupTime\n\nOutput only. Start time of next scheduled backup under this BackupPlan by\neither cron_schedule or rpo config."]]
