Backup and DR Service V1 API - Class Google::Cloud::BackupDR::V1::StandardSchedule (v0.4.0)

Version latest

• 0.4.0 (latest)
• 0.3.0
• 0.2.1
• 0.1.0

Reference documentation and code samples for the Backup and DR Service V1 API class Google::Cloud::BackupDR::V1::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.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#backup_window

def backup_window() -> ::Google::Cloud::BackupDR::V1::BackupWindow

Returns

• (::Google::Cloud::BackupDR::V1::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 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.

#backup_window=

def backup_window=(value) -> ::Google::Cloud::BackupDR::V1::BackupWindow

Parameter

• value (::Google::Cloud::BackupDR::V1::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 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

• (::Google::Cloud::BackupDR::V1::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 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.

#days_of_month

def days_of_month() -> ::Array<::Integer>

Returns

• (::Array<::Integer>) — 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.

#days_of_month=

def days_of_month=(value) -> ::Array<::Integer>

Parameter

• value (::Array<::Integer>) — 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

• (::Array<::Integer>) — 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.

#days_of_week

def days_of_week() -> ::Array<::Google::Type::DayOfWeek>

Returns

• (::Array<::Google::Type::DayOfWeek>) — 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.

#days_of_week=

def days_of_week=(value) -> ::Array<::Google::Type::DayOfWeek>

Parameter

• value (::Array<::Google::Type::DayOfWeek>) — 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

• (::Array<::Google::Type::DayOfWeek>) — 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.

#hourly_frequency

def hourly_frequency() -> ::Integer

Returns

• (::Integer) — 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).

#hourly_frequency=

def hourly_frequency=(value) -> ::Integer

Parameter

• value (::Integer) — 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

• (::Integer) — 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).

#months

def months() -> ::Array<::Google::Type::Month>

Returns

• (::Array<::Google::Type::Month>) — 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.

#months=

def months=(value) -> ::Array<::Google::Type::Month>

Parameter

• value (::Array<::Google::Type::Month>) — 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

• (::Array<::Google::Type::Month>) — 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.

#recurrence_type

def recurrence_type() -> ::Google::Cloud::BackupDR::V1::StandardSchedule::RecurrenceType

Returns

• (::Google::Cloud::BackupDR::V1::StandardSchedule::RecurrenceType) — Required. Specifies the RecurrenceType for the schedule.

#recurrence_type=

def recurrence_type=(value) -> ::Google::Cloud::BackupDR::V1::StandardSchedule::RecurrenceType

Parameter

• value (::Google::Cloud::BackupDR::V1::StandardSchedule::RecurrenceType) — Required. Specifies the RecurrenceType for the schedule.

Returns

• (::Google::Cloud::BackupDR::V1::StandardSchedule::RecurrenceType) — Required. Specifies the RecurrenceType for the schedule.

#time_zone

def time_zone() -> ::String

Returns

• (::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.

#time_zone=

def time_zone=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#week_day_of_month

def week_day_of_month() -> ::Google::Cloud::BackupDR::V1::WeekDayOfMonth

Returns

• (::Google::Cloud::BackupDR::V1::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 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.

#week_day_of_month=

def week_day_of_month=(value) -> ::Google::Cloud::BackupDR::V1::WeekDayOfMonth

Parameter

• value (::Google::Cloud::BackupDR::V1::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 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

• (::Google::Cloud::BackupDR::V1::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 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.