Backup and DR Service v1 API - Class StandardSchedule (1.2.0)

public sealed class StandardSchedule : IMessage<StandardSchedule>, IEquatable<StandardSchedule>, IDeepCloneable<StandardSchedule>, IBufferMessage, IMessage

Reference documentation and code samples for the Backup and DR Service v1 API 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.

Inheritance

object > StandardSchedule

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

StandardSchedule()

public StandardSchedule()

StandardSchedule(StandardSchedule)

public StandardSchedule(StandardSchedule other)
Parameter
Name Description
other StandardSchedule

Properties

BackupWindow

public BackupWindow BackupWindow { get; set; }

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.

Property Value
Type Description
BackupWindow

DaysOfMonth

public RepeatedField<int> DaysOfMonth { get; }

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.

Property Value
Type Description
RepeatedFieldint

DaysOfWeek

public RepeatedField<DayOfWeek> DaysOfWeek { get; }

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.

Property Value
Type Description
RepeatedFieldDayOfWeek

HourlyFrequency

public int HourlyFrequency { get; set; }

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).

Property Value
Type Description
int

Months

public RepeatedField<Month> Months { get; }

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.

Property Value
Type Description
RepeatedFieldMonth

RecurrenceType

public StandardSchedule.Types.RecurrenceType RecurrenceType { get; set; }

Required. Specifies the RecurrenceType for the schedule.

Property Value
Type Description
StandardScheduleTypesRecurrenceType

TimeZone

public string TimeZone { get; set; }

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.

Property Value
Type Description
string

WeekDayOfMonth

public WeekDayOfMonth WeekDayOfMonth { get; set; }

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.

Property Value
Type Description
WeekDayOfMonth