View Source GoogleApi.BackupDR.V1.Model.StandardSchedule (google_api_backup_dr v0.11.0)
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.
Attributes
-
backupWindow
(type:GoogleApi.BackupDR.V1.Model.BackupWindow.t
, default:nil
) - 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 asNOT_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. -
daysOfMonth
(type:list(integer())
, default:nil
) - Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values fordays_of_month
are only applicable forrecurrence_type
,MONTHLY
andYEARLY
. A validation error will occur if other values are supplied. -
daysOfWeek
(type:list(String.t)
, default:nil
) - Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required forrecurrence_type
,WEEKLY
and is not applicable otherwise. A validation error will occur if a value is supplied andrecurrence_type
is notWEEKLY
. -
hourlyFrequency
(type:integer()
, default:nil
) - 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 forrecurrence_type
,HOURLY
and is not applicable otherwise. A validation error will occur if a value is supplied andrecurrence_type
is notHOURLY
. 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). -
months
(type:list(String.t)
, default:nil
) - Optional. Specifies the months of year, likeFEBRUARY
and/orMAY
, on which jobs will run. This field is only applicable whenrecurrence_type
isYEARLY
. A validation error will occur if other values are supplied. -
recurrenceType
(type:String.t
, default:nil
) - Required. Specifies theRecurrenceType
for the schedule. -
timeZone
(type:String.t
, default:nil
) - 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. -
weekDayOfMonth
(type:GoogleApi.BackupDR.V1.Model.WeekDayOfMonth.t
, default:nil
) - 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 inWeekDayOfMonth
, one for the day, e.g.MONDAY
, and one for the week, e.g.LAST
. This field is only applicable forrecurrence_type
,MONTHLY
andYEARLY
. A validation error will occur if other values are supplied.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.BackupDR.V1.Model.StandardSchedule{ backupWindow: GoogleApi.BackupDR.V1.Model.BackupWindow.t() | nil, daysOfMonth: [integer()] | nil, daysOfWeek: [String.t()] | nil, hourlyFrequency: integer() | nil, months: [String.t()] | nil, recurrenceType: String.t() | nil, timeZone: String.t() | nil, weekDayOfMonth: GoogleApi.BackupDR.V1.Model.WeekDayOfMonth.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.