Class: OCI::Database::Models::MaintenanceWindow

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/maintenance_window.rb

Overview

The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.

Constant Summary collapse

PREFERENCE_ENUM =
[
  PREFERENCE_NO_PREFERENCE = 'NO_PREFERENCE'.freeze,
  PREFERENCE_CUSTOM_PREFERENCE = 'CUSTOM_PREFERENCE'.freeze,
  PREFERENCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MaintenanceWindow

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/oci/database/models/maintenance_window.rb', line 87

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.preference = attributes[:'preference'] if attributes[:'preference']
  self.preference = "NO_PREFERENCE" if preference.nil? && !attributes.key?(:'preference') # rubocop:disable Style/StringLiterals

  self.months = attributes[:'months'] if attributes[:'months']

  self.weeks_of_month = attributes[:'weeksOfMonth'] if attributes[:'weeksOfMonth']

  raise 'You cannot provide both :weeksOfMonth and :weeks_of_month' if attributes.key?(:'weeksOfMonth') && attributes.key?(:'weeks_of_month')

  self.weeks_of_month = attributes[:'weeks_of_month'] if attributes[:'weeks_of_month']

  self.days_of_week = attributes[:'daysOfWeek'] if attributes[:'daysOfWeek']

  raise 'You cannot provide both :daysOfWeek and :days_of_week' if attributes.key?(:'daysOfWeek') && attributes.key?(:'days_of_week')

  self.days_of_week = attributes[:'days_of_week'] if attributes[:'days_of_week']

  self.hours_of_day = attributes[:'hoursOfDay'] if attributes[:'hoursOfDay']

  raise 'You cannot provide both :hoursOfDay and :hours_of_day' if attributes.key?(:'hoursOfDay') && attributes.key?(:'hours_of_day')

  self.hours_of_day = attributes[:'hours_of_day'] if attributes[:'hours_of_day']

  self.lead_time_in_weeks = attributes[:'leadTimeInWeeks'] if attributes[:'leadTimeInWeeks']

  raise 'You cannot provide both :leadTimeInWeeks and :lead_time_in_weeks' if attributes.key?(:'leadTimeInWeeks') && attributes.key?(:'lead_time_in_weeks')

  self.lead_time_in_weeks = attributes[:'lead_time_in_weeks'] if attributes[:'lead_time_in_weeks']
end

Instance Attribute Details

#days_of_weekArray<OCI::Database::Models::DayOfWeek>

Days during the week when maintenance should be performed.



35
36
37
# File 'lib/oci/database/models/maintenance_window.rb', line 35

def days_of_week
  @days_of_week
end

#hours_of_dayArray<Integer>

The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC

Returns:

  • (Array<Integer>)


40
41
42
# File 'lib/oci/database/models/maintenance_window.rb', line 40

def hours_of_day
  @hours_of_day
end

#lead_time_in_weeksInteger

Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.

Returns:

  • (Integer)


45
46
47
# File 'lib/oci/database/models/maintenance_window.rb', line 45

def lead_time_in_weeks
  @lead_time_in_weeks
end

#monthsArray<OCI::Database::Models::Month>

Months during the year when maintenance should be performed.

Returns:



24
25
26
# File 'lib/oci/database/models/maintenance_window.rb', line 24

def months
  @months
end

#preferenceString

[Required] The maintenance window scheduling preference.

Returns:

  • (String)


20
21
22
# File 'lib/oci/database/models/maintenance_window.rb', line 20

def preference
  @preference
end

#weeks_of_monthArray<Integer>

Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.

Returns:

  • (Array<Integer>)


31
32
33
# File 'lib/oci/database/models/maintenance_window.rb', line 31

def weeks_of_month
  @weeks_of_month
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/oci/database/models/maintenance_window.rb', line 48

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'preference': :'preference',
    'months': :'months',
    'weeks_of_month': :'weeksOfMonth',
    'days_of_week': :'daysOfWeek',
    'hours_of_day': :'hoursOfDay',
    'lead_time_in_weeks': :'leadTimeInWeeks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/oci/database/models/maintenance_window.rb', line 62

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'preference': :'String',
    'months': :'Array<OCI::Database::Models::Month>',
    'weeks_of_month': :'Array<Integer>',
    'days_of_week': :'Array<OCI::Database::Models::DayOfWeek>',
    'hours_of_day': :'Array<Integer>',
    'lead_time_in_weeks': :'Integer'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



143
144
145
146
147
148
149
150
151
152
153
# File 'lib/oci/database/models/maintenance_window.rb', line 143

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    preference == other.preference &&
    months == other.months &&
    weeks_of_month == other.weeks_of_month &&
    days_of_week == other.days_of_week &&
    hours_of_day == other.hours_of_day &&
    lead_time_in_weeks == other.lead_time_in_weeks
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/oci/database/models/maintenance_window.rb', line 178

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


158
159
160
# File 'lib/oci/database/models/maintenance_window.rb', line 158

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



167
168
169
# File 'lib/oci/database/models/maintenance_window.rb', line 167

def hash
  [preference, months, weeks_of_month, days_of_week, hours_of_day, lead_time_in_weeks].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
220
# File 'lib/oci/database/models/maintenance_window.rb', line 211

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



205
206
207
# File 'lib/oci/database/models/maintenance_window.rb', line 205

def to_s
  to_hash.to_s
end