Class: OCI::OsManagementHub::Models::Event

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/os_management_hub/models/event.rb

Overview

An event is an occurrence of something of interest on a managed instance, such as a kernel crash, software package update, or software source update.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_KERNEL_OOPS = 'KERNEL_OOPS'.freeze,
  TYPE_KERNEL_CRASH = 'KERNEL_CRASH'.freeze,
  TYPE_EXPLOIT_ATTEMPT = 'EXPLOIT_ATTEMPT'.freeze,
  TYPE_SOFTWARE_UPDATE = 'SOFTWARE_UPDATE'.freeze,
  TYPE_KSPLICE_UPDATE = 'KSPLICE_UPDATE'.freeze,
  TYPE_SOFTWARE_SOURCE = 'SOFTWARE_SOURCE'.freeze,
  TYPE_AGENT = 'AGENT'.freeze,
  TYPE_MANAGEMENT_STATION = 'MANAGEMENT_STATION'.freeze,
  TYPE_SYSADMIN = 'SYSADMIN'.freeze,
  TYPE_REBOOT = 'REBOOT'.freeze,
  TYPE_SNAP_UPDATE = 'SNAP_UPDATE'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Event

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

  • :type (String) —

    The value to assign to the #type property

  • :event_summary (String) —

    The value to assign to the #event_summary property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :event_details (String) —

    The value to assign to the #event_details property

  • :resource_id (String) —

    The value to assign to the #resource_id property

  • :system_details (OCI::OsManagementHub::Models::SystemDetails) —

    The value to assign to the #system_details property

  • :time_occurred (DateTime) —

    The value to assign to the #time_occurred 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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :is_managed_by_autonomous_linux (BOOLEAN) —

    The value to assign to the #is_managed_by_autonomous_linux 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



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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/oci/os_management_hub/models/event.rb', line 225

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

  self.event_summary = attributes[:'eventSummary'] if attributes[:'eventSummary']

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

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

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

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

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

  self.resource_id = attributes[:'resourceId'] if attributes[:'resourceId']

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

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

  self.system_details = attributes[:'systemDetails'] if attributes[:'systemDetails']

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

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

  self.time_occurred = attributes[:'timeOccurred'] if attributes[:'timeOccurred']

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

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

  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.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.is_managed_by_autonomous_linux = attributes[:'isManagedByAutonomousLinux'] unless attributes[:'isManagedByAutonomousLinux'].nil?

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

  self.is_managed_by_autonomous_linux = attributes[:'is_managed_by_autonomous_linux'] unless attributes[:'is_managed_by_autonomous_linux'].nil?

  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] The OCID of the compartment.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/os_management_hub/models/event.rb', line 66

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. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


122
123
124
 
# File 'lib/oci/os_management_hub/models/event.rb', line 122

def defined_tags
  @defined_tags
end

#event_details ⇒ String

Details of an event.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/os_management_hub/models/event.rb', line 70

def event_details
  @event_details
end

#event_summary ⇒ String

[Required] Summary of the event.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/os_management_hub/models/event.rb', line 62

def event_summary
  @event_summary
end

#freeform_tags ⇒ Hash<String, String>

[Required] Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


115
116
117
 
# File 'lib/oci/os_management_hub/models/event.rb', line 115

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the event.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/os_management_hub/models/event.rb', line 43

def id
  @id
end

#is_managed_by_autonomous_linux ⇒ BOOLEAN

Indicates whether the event occurred on a resource that is managed by the Autonomous Linux service.

Returns:

  • (BOOLEAN) 


108
109
110
 
# File 'lib/oci/os_management_hub/models/event.rb', line 108

def is_managed_by_autonomous_linux
  @is_managed_by_autonomous_linux
end

#lifecycle_details ⇒ String

Describes the current state of the event in more detail. For example, the message can provide actionable information for a resource in the 'FAILED' state.

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/os_management_hub/models/event.rb', line 104

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the event.

Returns:

  • (String) 


98
99
100
 
# File 'lib/oci/os_management_hub/models/event.rb', line 98

def lifecycle_state
  @lifecycle_state
end

#resource_id ⇒ String

The OCID of the managed instance or resource where the event occurred.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/os_management_hub/models/event.rb', line 74

def resource_id
  @resource_id
end

#system_details ⇒ OCI::OsManagementHub::Models::SystemDetails

Returns:



77
78
79
 
# File 'lib/oci/os_management_hub/models/event.rb', line 77

def system_details
  @system_details
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>>) 


128
129
130
 
# File 'lib/oci/os_management_hub/models/event.rb', line 128

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the Event was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


88
89
90
 
# File 'lib/oci/os_management_hub/models/event.rb', line 88

def time_created
  @time_created
end

#time_occurred ⇒ DateTime

The date and time that the event occurred.

Returns:

  • (DateTime) 


81
82
83
 
# File 'lib/oci/os_management_hub/models/event.rb', line 81

def time_occurred
  @time_occurred
end

#time_updated ⇒ DateTime

The date and time that the event was updated (in RFC 3339 format). Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


94
95
96
 
# File 'lib/oci/os_management_hub/models/event.rb', line 94

def time_updated
  @time_updated
end

#type ⇒ String

[Required] Event type: * KERNEL_OOPS - Used to identify a kernel panic condition event * KERNEL_CRASH - Used to identify an internal fatal kernel error that cannot be safely recovered from * EXPLOIT_ATTEMPT - Used to identify a known exploit detection as identified by Ksplice * SOFTWARE_UPDATE - Software updates - Packages * KSPLICE_UPDATE - Ksplice updates * SOFTWARE_SOURCE - Software source * AGENT - Agent * MANAGEMENT_STATION - Management Station * SYSADMIN - Used to identify attempts on fixing agent errors on the instance * REBOOT - Reboot

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/os_management_hub/models/event.rb', line 58

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/os_management_hub/models/event.rb', line 131

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'type': :'type',
    'event_summary': :'eventSummary',
    'compartment_id': :'compartmentId',
    'event_details': :'eventDetails',
    'resource_id': :'resourceId',
    'system_details': :'systemDetails',
    'time_occurred': :'timeOccurred',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'is_managed_by_autonomous_linux': :'isManagedByAutonomousLinux',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/os_management_hub/models/event.rb', line 183

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::OsManagementHub::Models::SoftwareUpdateEvent' if type == 'SOFTWARE_UPDATE'
  return 'OCI::OsManagementHub::Models::KernelOopsEvent' if type == 'KERNEL_OOPS'
  return 'OCI::OsManagementHub::Models::ManagementStationEvent' if type == 'MANAGEMENT_STATION'
  return 'OCI::OsManagementHub::Models::SoftwareSourceEvent' if type == 'SOFTWARE_SOURCE'
  return 'OCI::OsManagementHub::Models::KernelCrashEvent' if type == 'KERNEL_CRASH'
  return 'OCI::OsManagementHub::Models::SysadminEvent' if type == 'SYSADMIN'
  return 'OCI::OsManagementHub::Models::SnapUpdateEvent' if type == 'SNAP_UPDATE'
  return 'OCI::OsManagementHub::Models::RebootEvent' if type == 'REBOOT'
  return 'OCI::OsManagementHub::Models::ExploitAttemptEvent' if type == 'EXPLOIT_ATTEMPT'
  return 'OCI::OsManagementHub::Models::AgentEvent' if type == 'AGENT'
  return 'OCI::OsManagementHub::Models::KspliceUpdateEvent' if type == 'KSPLICE_UPDATE'

  # TODO: Log a warning when the subtype is not found.
  'OCI::OsManagementHub::Models::Event'
end

.swagger_types ⇒ Object

Attribute type mapping.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/os_management_hub/models/event.rb', line 155

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'type': :'String',
    'event_summary': :'String',
    'compartment_id': :'String',
    'event_details': :'String',
    'resource_id': :'String',
    'system_details': :'OCI::OsManagementHub::Models::SystemDetails',
    'time_occurred': :'DateTime',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'is_managed_by_autonomous_linux': :'BOOLEAN',
    '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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/oci/os_management_hub/models/event.rb', line 353

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

  self.class == other.class &&
    id == other.id &&
    type == other.type &&
    event_summary == other.event_summary &&
    compartment_id == other.compartment_id &&
    event_details == other.event_details &&
    resource_id == other.resource_id &&
    system_details == other.system_details &&
    time_occurred == other.time_occurred &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    is_managed_by_autonomous_linux == other.is_managed_by_autonomous_linux &&
    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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/oci/os_management_hub/models/event.rb', line 398

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


378
379
380
 
# File 'lib/oci/os_management_hub/models/event.rb', line 378

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



387
388
389
 
# File 'lib/oci/os_management_hub/models/event.rb', line 387

def hash
  [id, type, event_summary, compartment_id, event_details, resource_id, system_details, time_occurred, time_created, time_updated, lifecycle_state, lifecycle_details, is_managed_by_autonomous_linux, 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



431
432
433
434
435
436
437
438
439
440
 
# File 'lib/oci/os_management_hub/models/event.rb', line 431

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



425
426
427
 
# File 'lib/oci/os_management_hub/models/event.rb', line 425

def to_s
  to_hash.to_s
end