Class: OCI::StackMonitoring::Models::MaintenanceWindowSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/stack_monitoring/models/maintenance_window_summary.rb

Overview

General information of a Maintenance Window

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_DETAILS_ENUM = 
[
  LIFECYCLE_DETAILS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_DETAILS_SCHEDULED = 'SCHEDULED'.freeze,
  LIFECYCLE_DETAILS_COMPLETED = 'COMPLETED'.freeze,
  LIFECYCLE_DETAILS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_UPDATE = 'UPDATE'.freeze,
  OPERATION_TYPE_CREATE = 'CREATE'.freeze,
  OPERATION_TYPE_DELETE = 'DELETE'.freeze,
  OPERATION_TYPE_STOP = 'STOP'.freeze,
  OPERATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OPERATION_STATUS_ENUM = 
[
  OPERATION_STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  OPERATION_STATUS_FAILED = 'FAILED'.freeze,
  OPERATION_STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  OPERATION_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MaintenanceWindowSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
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
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 161

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

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

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

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

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

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

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

  self.operation_status = attributes[:'operationStatus'] if attributes[:'operationStatus']

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

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

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

  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

Compartment Identifier OCID.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 57

def compartment_id
  @compartment_id
end

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

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


95
96
97
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 95

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

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


89
90
91
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 89

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of maintenance window.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 48

def id
  @id
end

#lifecycle_details ⇒ String

Lifecycle Details of the Maintenance Window.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 70

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

Lifecycle state of the monitored resource.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 66

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] Maintenance Window name.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 52

def name
  @name
end

#number_of_resources ⇒ Integer

Number of resources of the Maintenance window.

Returns:

  • (Integer) 


62
63
64
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 62

def number_of_resources
  @number_of_resources
end

#operation_status ⇒ String

Status of the most recent operation of the Maintenance Window.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 80

def operation_status
  @operation_status
end

#operation_type ⇒ String

The name of the most recent operation of the Maintenance window.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 75

def operation_type
  @operation_type
end

#schedule ⇒ OCI::StackMonitoring::Models::MaintenanceWindowSchedule

Returns:



83
84
85
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 83

def schedule
  @schedule
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


101
102
103
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 101

def system_tags
  @system_tags
end

Class Method Details

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 104

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'compartment_id': :'compartmentId',
    'number_of_resources': :'numberOfResources',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'operation_type': :'operationType',
    'operation_status': :'operationStatus',
    'schedule': :'schedule',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 124

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'compartment_id': :'String',
    'number_of_resources': :'Integer',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'operation_type': :'String',
    'operation_status': :'String',
    'schedule': :'OCI::StackMonitoring::Models::MaintenanceWindowSchedule',
    '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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 287

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    number_of_resources == other.number_of_resources &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    operation_type == other.operation_type &&
    operation_status == other.operation_status &&
    schedule == other.schedule &&
    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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 328

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


308
309
310
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 308

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



317
318
319
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 317

def hash
  [id, name, compartment_id, number_of_resources, lifecycle_state, lifecycle_details, operation_type, operation_status, schedule, 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



361
362
363
364
365
366
367
368
369
370
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 361

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



355
356
357
 
# File 'lib/oci/stack_monitoring/models/maintenance_window_summary.rb', line 355

def to_s
  to_hash.to_s
end