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 \ BackupPlanMethods
__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 |
↳ rpo_config |
Google\Cloud\GkeBackup\V1\RpoConfig
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. |
↳ next_scheduled_backup_time |
Google\Protobuf\Timestamp
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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\RpoConfig|null |
|
hasRpoConfig
clearRpoConfig
setRpoConfig
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeBackup\V1\RpoConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextScheduledBackupTime
Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasNextScheduledBackupTime
clearNextScheduledBackupTime
setNextScheduledBackupTime
Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|