Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class StandardSchedule.
StandardSchedule defines a schedule that run within the confines of a
defined window of days. We can define recurrence type for schedule as
HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY.
Generated from protobuf message google.cloud.backupdr.v1.StandardSchedule
Namespace
Google \ Cloud \ BackupDR \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ recurrence_type |
int
Required. Specifies the |
↳ hourly_frequency |
int
Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for |
↳ days_of_week |
array
Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for |
↳ days_of_month |
array
Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for |
↳ week_day_of_month |
WeekDayOfMonth
Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in |
↳ months |
array
Optional. Specifies the months of year, like |
↳ backup_window |
BackupWindow
Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as |
↳ time_zone |
string
Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris. |
getRecurrenceType
Required. Specifies the RecurrenceType for the schedule.
| Returns | |
|---|---|
| Type | Description |
int |
|
setRecurrenceType
Required. Specifies the RecurrenceType for the schedule.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHourlyFrequency
Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined.
This is required for recurrence_type, HOURLY and is not applicable
otherwise. A validation error will occur if a value is supplied and
recurrence_type is not HOURLY.
Value of hourly frequency should be between 6 and 23.
Reason for limit : We found that there is bandwidth limitation of 3GB/S for
GMI while taking a backup and 5GB/S while doing a restore. Given the amount
of parallel backups and restore we are targeting, this will potentially
take the backup time to mins and hours (in worst case scenario).
| Returns | |
|---|---|
| Type | Description |
int |
|
setHourlyFrequency
Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined.
This is required for recurrence_type, HOURLY and is not applicable
otherwise. A validation error will occur if a value is supplied and
recurrence_type is not HOURLY.
Value of hourly frequency should be between 6 and 23.
Reason for limit : We found that there is bandwidth limitation of 3GB/S for
GMI while taking a backup and 5GB/S while doing a restore. Given the amount
of parallel backups and restore we are targeting, this will potentially
take the backup time to mins and hours (in worst case scenario).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDaysOfWeek
Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run.
This is required for recurrence_type, WEEKLY and is not applicable
otherwise. A validation error will occur if a value is supplied and
recurrence_type is not WEEKLY.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDaysOfWeek
Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run.
This is required for recurrence_type, WEEKLY and is not applicable
otherwise. A validation error will occur if a value is supplied and
recurrence_type is not WEEKLY.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDaysOfMonth
Optional. Specifies days of months like 1, 5, or 14 on which jobs will run.
Values for days_of_month are only applicable for recurrence_type,
MONTHLY and YEARLY. A validation error will occur if other values are
supplied.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDaysOfMonth
Optional. Specifies days of months like 1, 5, or 14 on which jobs will run.
Values for days_of_month are only applicable for recurrence_type,
MONTHLY and YEARLY. A validation error will occur if other values are
supplied.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWeekDayOfMonth
Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST
MONDAY, on which jobs will run. This will be specified by two fields in
WeekDayOfMonth, one for the day, e.g. MONDAY, and one for the week,
e.g. LAST.
This field is only applicable for recurrence_type, MONTHLY and
YEARLY. A validation error will occur if other values are supplied.
| Returns | |
|---|---|
| Type | Description |
WeekDayOfMonth|null |
|
hasWeekDayOfMonth
clearWeekDayOfMonth
setWeekDayOfMonth
Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST
MONDAY, on which jobs will run. This will be specified by two fields in
WeekDayOfMonth, one for the day, e.g. MONDAY, and one for the week,
e.g. LAST.
This field is only applicable for recurrence_type, MONTHLY and
YEARLY. A validation error will occur if other values are supplied.
| Parameter | |
|---|---|
| Name | Description |
var |
WeekDayOfMonth
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMonths
Optional. Specifies the months of year, like FEBRUARY and/or MAY, on
which jobs will run.
This field is only applicable when recurrence_type is YEARLY. A
validation error will occur if other values are supplied.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setMonths
Optional. Specifies the months of year, like FEBRUARY and/or MAY, on
which jobs will run.
This field is only applicable when recurrence_type is YEARLY. A
validation error will occur if other values are supplied.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupWindow
Required. A BackupWindow defines the window of day during which backup jobs
will run. Jobs are queued at the beginning of the window and will be marked
as NOT_RUN if they do not start by the end of the window.
Note: running jobs will not be cancelled at the end of the window.
| Returns | |
|---|---|
| Type | Description |
BackupWindow|null |
|
hasBackupWindow
clearBackupWindow
setBackupWindow
Required. A BackupWindow defines the window of day during which backup jobs
will run. Jobs are queued at the beginning of the window and will be marked
as NOT_RUN if they do not start by the end of the window.
Note: running jobs will not be cancelled at the end of the window.
| Parameter | |
|---|---|
| Name | Description |
var |
BackupWindow
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTimeZone
Required. The time zone to be used when interpreting the schedule.
The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTimeZone
Required. The time zone to be used when interpreting the schedule.
The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|