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.

Note: The following fields are mutually exclusive: daily, single_occurrence_date, days_of_week. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Boolean) —

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

    Note: The following fields are mutually exclusive: daily, single_occurrence_date, days_of_week. If a field in that set is populated, all other fields in the set will automatically be cleared.



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 345

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.

Note: The following fields are mutually exclusive: days_of_week, single_occurrence_date, daily. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::GkeBackup::V1::ExclusionWindow::DayOfWeekList) —

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

    Note: The following fields are mutually exclusive: days_of_week, single_occurrence_date, daily. If a field in that set is populated, all other fields in the set will automatically be cleared.



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 345

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)


345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 345

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.

Note: The following fields are mutually exclusive: single_occurrence_date, daily, days_of_week. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

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

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

    Note: The following fields are mutually exclusive: single_occurrence_date, daily, days_of_week. If a field in that set is populated, all other fields in the set will automatically be cleared.



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 345

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:



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 345

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