Class: IntersightClient::TamAdvisoryInstance

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/tam_advisory_instance.rb

Overview

Instance of an Intersight advisory applicable for an Intersight managed object. An advisory instance is created when a given advisory is found applicable for an Intersight managed object. An advisory instance is retained for some time even after being cleared for historical purposes. A ‘cleared’ advisory instance is deleted after the retention time is elaspsed.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TamAdvisoryInstance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
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
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 131

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::TamAdvisoryInstance` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'tam.AdvisoryInstance'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'tam.AdvisoryInstance'
  end

  if attributes.key?(:'affected_object_moid')
    self.affected_object_moid = attributes[:'affected_object_moid']
  end

  if attributes.key?(:'affected_object_type')
    self.affected_object_type = attributes[:'affected_object_type']
  end

  if attributes.key?(:'last_state_change_time')
    self.last_state_change_time = attributes[:'last_state_change_time']
  end

  if attributes.key?(:'last_verified_time')
    self.last_verified_time = attributes[:'last_verified_time']
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  else
    self.state = 'unknown'
  end

  if attributes.key?(:'advisory')
    self.advisory = attributes[:'advisory']
  end

  if attributes.key?(:'affected_object')
    self.affected_object = attributes[:'affected_object']
  end

  if attributes.key?(:'device_registration')
    self.device_registration = attributes[:'device_registration']
  end
end

Instance Attribute Details

#advisory ⇒ Object

Returns the value of attribute advisory.



40
41
42
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 40

def advisory
  @advisory
end

#affected_object ⇒ Object

Returns the value of attribute affected_object.



42
43
44
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 42

def affected_object
  @affected_object
end

#affected_object_moid ⇒ Object

Moid of the Intersight MO affected by the alert. Deprecated now and will be removed in subsequent releases.



26
27
28
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 26

def affected_object_moid
  @affected_object_moid
end

#affected_object_type ⇒ Object

Object type of the Intersight MO affected by the alert. Deprecated now and will be removed in subsequent releases.



29
30
31
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 29

def affected_object_type
  @affected_object_type
end

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 20

def class_id
  @class_id
end

#device_registration ⇒ Object

Returns the value of attribute device_registration.



44
45
46
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 44

def device_registration
  @device_registration
end

#last_state_change_time ⇒ Object

Timestamp when a state change was observed on this advisory instnace.



32
33
34
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 32

def last_state_change_time
  @last_state_change_time
end

#last_verified_time ⇒ Object

Timestamp when this advisory was last evaluated.



35
36
37
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 35

def last_verified_time
  @last_verified_time
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 23

def object_type
  @object_type
end

#state ⇒ Object

Current state of the advisory instance (Active/Cleared/Unknown etc.). * unknown - Intersight is unable to determine if the Advisory instance is applicable for the affected managed object. * active - Advisory instance is currently active and applicable for the affected managed object. * cleared - Advisory instance is no longer applicable for the affected managed object.



38
39
40
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 38

def state
  @state
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



90
91
92
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 90

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



85
86
87
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 85

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 69

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'affected_object_moid' => :'AffectedObjectMoid',
    :'affected_object_type' => :'AffectedObjectType',
    :'last_state_change_time' => :'LastStateChangeTime',
    :'last_verified_time' => :'LastVerifiedTime',
    :'state' => :'State',
    :'advisory' => :'Advisory',
    :'affected_object' => :'AffectedObject',
    :'device_registration' => :'DeviceRegistration'
  }
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



285
286
287
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 285

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



117
118
119
120
121
122
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 117

def self.openapi_all_of
  [
  :'MoBaseMo',
  :'TamAdvisoryInstanceAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



125
126
127
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 125

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 111

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 95

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'affected_object_moid' => :'String',
    :'affected_object_type' => :'String',
    :'last_state_change_time' => :'Time',
    :'last_verified_time' => :'Time',
    :'state' => :'String',
    :'advisory' => :'TamBaseAdvisoryRelationship',
    :'affected_object' => :'MoBaseMoRelationship',
    :'device_registration' => :'AssetDeviceRegistrationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 255

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      affected_object_moid == o.affected_object_moid &&
      affected_object_type == o.affected_object_type &&
      last_state_change_time == o.last_state_change_time &&
      last_verified_time == o.last_verified_time &&
      state == o.state &&
      advisory == o.advisory &&
      affected_object == o.affected_object &&
      device_registration == o.device_registration && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 316

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 387

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 292

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  TamAdvisoryInstance.openapi_types.each_pair do |key, type|
    if attributes[TamAdvisoryInstance.attribute_map[key]].nil? && TamAdvisoryInstance.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[TamAdvisoryInstance.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[TamAdvisoryInstance.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[TamAdvisoryInstance.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[TamAdvisoryInstance.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



278
279
280
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 278

def hash
  [class_id, object_type, affected_object_moid, affected_object_type, last_state_change_time, last_verified_time, state, advisory, affected_object, device_registration].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 196

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

  if @object_type.nil?
    invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



363
364
365
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 363

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 369

def to_hash
  hash = super
  TamAdvisoryInstance.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = TamAdvisoryInstance.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



357
358
359
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 357

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/intersight_client/models/tam_advisory_instance.rb', line 211

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["tam.AdvisoryInstance"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["tam.AdvisoryInstance"])
  return false unless object_type_validator.valid?(@object_type)
  state_validator = EnumAttributeValidator.new('String', ["unknown", "active", "cleared"])
  return false unless state_validator.valid?(@state)
  true && super
end