Class: OCI::FleetAppsManagement::Models::MaintenanceWindow

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

Overview

Details of Maintenance Window in Fleet Application Management.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_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):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :resource_region (String) —

    The value to assign to the #resource_region property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :is_outage (BOOLEAN) —

    The value to assign to the #is_outage property

  • :time_schedule_start (DateTime) —

    The value to assign to the #time_schedule_start property

  • :duration (String) —

    The value to assign to the #duration property

  • :is_recurring (BOOLEAN) —

    The value to assign to the #is_recurring property

  • :recurrences (String) —

    The value to assign to the #recurrences property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



182
183
184
185
186
187
188
189
190
191
192
193
194
195
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 182

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.id = attributes[:'id'] if attributes[:'id']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.resource_region = attributes[:'resourceRegion'] if attributes[:'resourceRegion']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.is_outage = attributes[:'isOutage'] unless attributes[:'isOutage'].nil?
  self.is_outage = false if is_outage.nil? && !attributes.key?(:'isOutage') # rubocop:disable Style/StringLiterals

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

  self.is_outage = attributes[:'is_outage'] unless attributes[:'is_outage'].nil?
  self.is_outage = false if is_outage.nil? && !attributes.key?(:'isOutage') && !attributes.key?(:'is_outage') # rubocop:disable Style/StringLiterals

  self.time_schedule_start = attributes[:'timeScheduleStart'] if attributes[:'timeScheduleStart']

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

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

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

  self.is_recurring = attributes[:'isRecurring'] unless attributes[:'isRecurring'].nil?
  self.is_recurring = false if is_recurring.nil? && !attributes.key?(:'isRecurring') # rubocop:disable Style/StringLiterals

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

  self.is_recurring = attributes[:'is_recurring'] unless attributes[:'is_recurring'].nil?
  self.is_recurring = false if is_recurring.nil? && !attributes.key?(:'isRecurring') && !attributes.key?(:'is_recurring') # rubocop:disable Style/StringLiterals

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment OCID

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 28

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


101
102
103
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 101

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 46

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: My new resource

Returns:

  • (String) 


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

def display_name
  @display_name
end

#duration ⇒ String

[Required] Duration of the maintenance window. Specify how long the maintenance window remains open.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 71

def duration
  @duration
end

#freeform_tags ⇒ Hash<String, String>

[Required] Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


95
96
97
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 95

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


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

def id
  @id
end

#is_outage ⇒ BOOLEAN

[Required] Does the maintenenace window cause outage? An outage indicates whether a maintenance window can consider operations that require downtime. It means a period when the application is not accessible.

Returns:

  • (BOOLEAN) 


61
62
63
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 61

def is_outage
  @is_outage
end

#is_recurring ⇒ BOOLEAN

[Required] Is this a recurring maintenance window?

Returns:

  • (BOOLEAN) 


75
76
77
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 75

def is_recurring
  @is_recurring
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 89

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the MaintenanceWindow.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 85

def lifecycle_state
  @lifecycle_state
end

#recurrences ⇒ String

Recurrence rule specification if maintenance window recurring. Specify the frequency of running the maintenance window.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 81

def recurrences
  @recurrences
end

#resource_region ⇒ String

Associated region

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 32

def resource_region
  @resource_region
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


107
108
109
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 107

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time this resource was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


50
51
52
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 50

def time_created
  @time_created
end

#time_schedule_start ⇒ DateTime

Specify the date and time of the day that the maintenance window starts.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 65

def time_schedule_start
  @time_schedule_start
end

#time_updated ⇒ DateTime

The time this resource was last updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


54
55
56
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 54

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 110

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'resource_region': :'resourceRegion',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'is_outage': :'isOutage',
    'time_schedule_start': :'timeScheduleStart',
    'duration': :'duration',
    'is_recurring': :'isRecurring',
    'recurrences': :'recurrences',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 135

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'resource_region': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'is_outage': :'BOOLEAN',
    'time_schedule_start': :'DateTime',
    'duration': :'String',
    'is_recurring': :'BOOLEAN',
    'recurrences': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 299

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    resource_region == other.resource_region &&
    display_name == other.display_name &&
    description == other.description &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    is_outage == other.is_outage &&
    time_schedule_start == other.time_schedule_start &&
    duration == other.duration &&
    is_recurring == other.is_recurring &&
    recurrences == other.recurrences &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 345

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


325
326
327
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 325

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



334
335
336
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 334

def hash
  [id, compartment_id, resource_region, display_name, description, time_created, time_updated, is_outage, time_schedule_start, duration, is_recurring, recurrences, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



378
379
380
381
382
383
384
385
386
387
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 378

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



372
373
374
 
# File 'lib/oci/fleet_apps_management/models/maintenance_window.rb', line 372

def to_s
  to_hash.to_s
end