Class: Google::Cloud::BackupDR::V1::StandardSchedule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/backupdr/v1/backupplan.rb

Overview

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.

Defined Under Namespace

Modules: RecurrenceType

Instance Attribute Summary collapse

Instance Attribute Details

#backup_window ⇒ ::Google::Cloud::BackupDR::V1::BackupWindow

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 196

class StandardSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # `RecurrenceTypes` enumerates the applicable periodicity for the schedule.
  module RecurrenceType
    # recurrence type not set
    RECURRENCE_TYPE_UNSPECIFIED = 0

    # The `BackupRule` is to be applied hourly.
    HOURLY = 1

    # The `BackupRule` is to be applied daily.
    DAILY = 2

    # The `BackupRule` is to be applied weekly.
    WEEKLY = 3

    # The `BackupRule` is to be applied monthly.
    MONTHLY = 4

    # The `BackupRule` is to be applied yearly.
    YEARLY = 5
  end
end

#days_of_month ⇒ ::Array<::Integer>

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 196

class StandardSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # `RecurrenceTypes` enumerates the applicable periodicity for the schedule.
  module RecurrenceType
    # recurrence type not set
    RECURRENCE_TYPE_UNSPECIFIED = 0

    # The `BackupRule` is to be applied hourly.
    HOURLY = 1

    # The `BackupRule` is to be applied daily.
    DAILY = 2

    # The `BackupRule` is to be applied weekly.
    WEEKLY = 3

    # The `BackupRule` is to be applied monthly.
    MONTHLY = 4

    # The `BackupRule` is to be applied yearly.
    YEARLY = 5
  end
end

#days_of_week ⇒ ::Array<::Google::Type::DayOfWeek>

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 196

class StandardSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # `RecurrenceTypes` enumerates the applicable periodicity for the schedule.
  module RecurrenceType
    # recurrence type not set
    RECURRENCE_TYPE_UNSPECIFIED = 0

    # The `BackupRule` is to be applied hourly.
    HOURLY = 1

    # The `BackupRule` is to be applied daily.
    DAILY = 2

    # The `BackupRule` is to be applied weekly.
    WEEKLY = 3

    # The `BackupRule` is to be applied monthly.
    MONTHLY = 4

    # The `BackupRule` is to be applied yearly.
    YEARLY = 5
  end
end

#hourly_frequency ⇒ ::Integer

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 196

class StandardSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # `RecurrenceTypes` enumerates the applicable periodicity for the schedule.
  module RecurrenceType
    # recurrence type not set
    RECURRENCE_TYPE_UNSPECIFIED = 0

    # The `BackupRule` is to be applied hourly.
    HOURLY = 1

    # The `BackupRule` is to be applied daily.
    DAILY = 2

    # The `BackupRule` is to be applied weekly.
    WEEKLY = 3

    # The `BackupRule` is to be applied monthly.
    MONTHLY = 4

    # The `BackupRule` is to be applied yearly.
    YEARLY = 5
  end
end

#months ⇒ ::Array<::Google::Type::Month>

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 196

class StandardSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # `RecurrenceTypes` enumerates the applicable periodicity for the schedule.
  module RecurrenceType
    # recurrence type not set
    RECURRENCE_TYPE_UNSPECIFIED = 0

    # The `BackupRule` is to be applied hourly.
    HOURLY = 1

    # The `BackupRule` is to be applied daily.
    DAILY = 2

    # The `BackupRule` is to be applied weekly.
    WEEKLY = 3

    # The `BackupRule` is to be applied monthly.
    MONTHLY = 4

    # The `BackupRule` is to be applied yearly.
    YEARLY = 5
  end
end

#recurrence_type ⇒ ::Google::Cloud::BackupDR::V1::StandardSchedule::RecurrenceType

Returns Required. Specifies the RecurrenceType for the schedule.

Returns:



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 196

class StandardSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # `RecurrenceTypes` enumerates the applicable periodicity for the schedule.
  module RecurrenceType
    # recurrence type not set
    RECURRENCE_TYPE_UNSPECIFIED = 0

    # The `BackupRule` is to be applied hourly.
    HOURLY = 1

    # The `BackupRule` is to be applied daily.
    DAILY = 2

    # The `BackupRule` is to be applied weekly.
    WEEKLY = 3

    # The `BackupRule` is to be applied monthly.
    MONTHLY = 4

    # The `BackupRule` is to be applied yearly.
    YEARLY = 5
  end
end

#time_zone ⇒ ::String

Returns 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:



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 196

class StandardSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # `RecurrenceTypes` enumerates the applicable periodicity for the schedule.
  module RecurrenceType
    # recurrence type not set
    RECURRENCE_TYPE_UNSPECIFIED = 0

    # The `BackupRule` is to be applied hourly.
    HOURLY = 1

    # The `BackupRule` is to be applied daily.
    DAILY = 2

    # The `BackupRule` is to be applied weekly.
    WEEKLY = 3

    # The `BackupRule` is to be applied monthly.
    MONTHLY = 4

    # The `BackupRule` is to be applied yearly.
    YEARLY = 5
  end
end

#week_day_of_month ⇒ ::Google::Cloud::BackupDR::V1::WeekDayOfMonth

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 196

class StandardSchedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # `RecurrenceTypes` enumerates the applicable periodicity for the schedule.
  module RecurrenceType
    # recurrence type not set
    RECURRENCE_TYPE_UNSPECIFIED = 0

    # The `BackupRule` is to be applied hourly.
    HOURLY = 1

    # The `BackupRule` is to be applied daily.
    DAILY = 2

    # The `BackupRule` is to be applied weekly.
    WEEKLY = 3

    # The `BackupRule` is to be applied monthly.
    MONTHLY = 4

    # The `BackupRule` is to be applied yearly.
    YEARLY = 5
  end
end