Class: Google::Cloud::GkeBackup::V1::ExclusionWindow

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

Overview

Defines a time window during which no backup should happen. All time and date are in UTC.

Defined Under Namespace

Classes: DayOfWeekList

Instance Attribute Summary collapse

Instance Attribute Details

#daily ⇒ ::Boolean

Returns The exclusion window occurs every day if set to "True". Specifying this field to "False" is an error.

Returns:

  • (::Boolean) —

    The exclusion window occurs every day if set to "True". Specifying this field to "False" is an error.



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 326

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

  # Holds repeated DaysOfWeek values as a container.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     Optional. A list of days of week.
  class DayOfWeekList
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#days_of_week ⇒ ::Google::Cloud::GkeBackup::V1::ExclusionWindow::DayOfWeekList

Returns The exclusion window occurs on these days of each week in UTC.

Returns:



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 326

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

  # Holds repeated DaysOfWeek values as a container.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     Optional. A list of days of week.
  class DayOfWeekList
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#duration ⇒ ::Google::Protobuf::Duration

Returns Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen:

  • single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO
  • daily window: duration < 24 hours
  • weekly window:
    • days of week includes all seven days of a week: duration < 24 hours
    • all other weekly window: duration < 168 hours (i.e., 24 * 7 hours).

Returns:

  • (::Google::Protobuf::Duration) —

    Required. Specifies duration of the window. Duration must be >= 5 minutes and < (target RPO - 20 minutes). Additional restrictions based on the recurrence type to allow some time for backup to happen:

    • single_occurrence_date: no restriction, but UI may warn about this when duration >= target RPO
    • daily window: duration < 24 hours
    • weekly window:
      • days of week includes all seven days of a week: duration < 24 hours
      • all other weekly window: duration < 168 hours (i.e., 24 * 7 hours)


326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 326

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

  # Holds repeated DaysOfWeek values as a container.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     Optional. A list of days of week.
  class DayOfWeekList
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#single_occurrence_date ⇒ ::Google::Type::Date

Returns No recurrence. The exclusion window occurs only once and on this date in UTC.

Returns:

  • (::Google::Type::Date) —

    No recurrence. The exclusion window occurs only once and on this date in UTC.



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 326

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

  # Holds repeated DaysOfWeek values as a container.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     Optional. A list of days of week.
  class DayOfWeekList
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#start_time ⇒ ::Google::Type::TimeOfDay

Returns Required. Specifies the start time of the window using time of the day in UTC.

Returns:



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 326

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

  # Holds repeated DaysOfWeek values as a container.
  # @!attribute [rw] days_of_week
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     Optional. A list of days of week.
  class DayOfWeekList
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end