Google Cloud Gke Backup V1 Client - Class Schedule (0.3.1)

Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class Schedule.

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
NameDescription
data array

Optional. Data for populating the Message object.

↳ cron_schedule string

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined. Default (empty): no automatic backup creation will occur.

↳ paused bool

This flag denotes whether automatic Backup creation is paused for this BackupPlan. Default: False

getCronSchedule

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined.

Default (empty): no automatic backup creation will occur.

Returns
TypeDescription
string

setCronSchedule

A standard cron string that defines a repeating schedule for creating Backups via this BackupPlan. If this is defined, then backup_retain_days must also be defined.

Default (empty): no automatic backup creation will occur.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPaused

This flag denotes whether automatic Backup creation is paused for this BackupPlan.

Default: False

Returns
TypeDescription
bool

setPaused

This flag denotes whether automatic Backup creation is paused for this BackupPlan.

Default: False

Parameter
NameDescription
var bool
Returns
TypeDescription
$this