Class: IntersightClient::TamAdvisoryDefinition

Inherits:
TamBaseAdvisory show all
Defined in:
lib/intersight_client/models/tam_advisory_definition.rb

Overview

An Intersight Advisory. An advisory represents an identification of a potential issue and may also include a recommendation for resolving the said issue. Advisories may be of different kind and severity. for e.g. It could be a security vulnerability or a performance issue or a hardware issue with different recommendations for resolving them.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from TamBaseAdvisory

#description, #name, #severity, #state

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 = {}) ⇒ TamAdvisoryDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 158

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::TamAdvisoryDefinition` 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.AdvisoryDefinition'
  end

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

  if attributes.key?(:'actions')
    if (value = attributes[:'actions']).is_a?(Array)
      self.actions = value
    end
  end

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

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

  if attributes.key?(:'api_data_sources')
    if (value = attributes[:'api_data_sources']).is_a?(Array)
      self.api_data_sources = value
    end
  end

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

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

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

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

  if attributes.key?(:'s3_data_sources')
    if (value = attributes[:'s3_data_sources']).is_a?(Array)
      self.s3_data_sources = value
    end
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'securityAdvisory'
  end

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

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

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

Instance Attribute Details

#actions ⇒ Object

Returns the value of attribute actions.



25
26
27
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 25

def actions
  @actions
end

#advisory_details ⇒ Object

Returns the value of attribute advisory_details.



27
28
29
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 27

def advisory_details
  @advisory_details
end

#advisory_id ⇒ Object

Cisco generated identifier for the published security advisory.



30
31
32
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 30

def advisory_id
  @advisory_id
end

#api_data_sources ⇒ Object

Returns the value of attribute api_data_sources.



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

def api_data_sources
  @api_data_sources
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_definition.rb', line 20

def class_id
  @class_id
end

#date_published ⇒ Object

Date when the security advisory was first published by Cisco.



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

def date_published
  @date_published
end

#date_updated ⇒ Object

Date when the security advisory was last updated by Cisco.



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

def date_updated
  @date_updated
end

#external_url ⇒ Object

A link to an external URL describing security Advisory in more details.



41
42
43
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 41

def external_url
  @external_url
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_definition.rb', line 23

def object_type
  @object_type
end

#organization ⇒ Object

Returns the value of attribute organization.



57
58
59
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 57

def organization
  @organization
end

#recommendation ⇒ Object

Recommended action to resolve the security advisory.



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

def recommendation
  @recommendation
end

#s3_data_sources ⇒ Object

Returns the value of attribute s3_data_sources.



46
47
48
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 46

def s3_data_sources
  @s3_data_sources
end

#type ⇒ Object

The type (field notice, security advisory etc.) of Intersight advisory. * securityAdvisory - Respresents the psirt alert type (tools.cisco.com/security/center/publicationListing.x). * fieldNotice - Respresents the field notice alert type (www.cisco.com/c/en/us/support/web/tsd-products-field-notice-summary.html).



49
50
51
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 49

def type
  @type
end

#version ⇒ Object

Cisco assigned advisory version after latest revision.



52
53
54
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 52

def version
  @version
end

#workaround ⇒ Object

Workarounds available for the advisory.



55
56
57
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 55

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



108
109
110
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 108

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)



103
104
105
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 103

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.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 82

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'actions' => :'Actions',
    :'advisory_details' => :'AdvisoryDetails',
    :'advisory_id' => :'AdvisoryId',
    :'api_data_sources' => :'ApiDataSources',
    :'date_published' => :'DatePublished',
    :'date_updated' => :'DateUpdated',
    :'external_url' => :'ExternalUrl',
    :'recommendation' => :'Recommendation',
    :'s3_data_sources' => :'S3DataSources',
    :'type' => :'Type',
    :'version' => :'Version',
    :'workaround' => :'Workaround',
    :'organization' => :'Organization'
  }
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



360
361
362
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 360

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



144
145
146
147
148
149
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 144

def self.openapi_all_of
  [
  :'TamAdvisoryDefinitionAllOf',
  :'TamBaseAdvisory'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



152
153
154
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 152

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



134
135
136
137
138
139
140
141
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 134

def self.openapi_nullable
  Set.new([
    :'actions',
    :'advisory_details',
    :'api_data_sources',
    :'s3_data_sources',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 113

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'actions' => :'Array<TamAction>',
    :'advisory_details' => :'TamBaseAdvisoryDetails',
    :'advisory_id' => :'String',
    :'api_data_sources' => :'Array<TamApiDataSource>',
    :'date_published' => :'Time',
    :'date_updated' => :'Time',
    :'external_url' => :'String',
    :'recommendation' => :'String',
    :'s3_data_sources' => :'Array<TamS3DataSource>',
    :'type' => :'String',
    :'version' => :'String',
    :'workaround' => :'String',
    :'organization' => :'OrganizationOrganizationRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 325

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      actions == o.actions &&
      advisory_details == o.advisory_details &&
      advisory_id == o.advisory_id &&
      api_data_sources == o.api_data_sources &&
      date_published == o.date_published &&
      date_updated == o.date_updated &&
      external_url == o.external_url &&
      recommendation == o.recommendation &&
      s3_data_sources == o.s3_data_sources &&
      type == o.type &&
      version == o.version &&
      workaround == o.workaround &&
      organization == o.organization && 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



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 391

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



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 462

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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 367

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  TamAdvisoryDefinition.openapi_types.each_pair do |key, type|
    if attributes[TamAdvisoryDefinition.attribute_map[key]].nil? && TamAdvisoryDefinition.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[TamAdvisoryDefinition.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[TamAdvisoryDefinition.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[TamAdvisoryDefinition.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[TamAdvisoryDefinition.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


347
348
349
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 347

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



353
354
355
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 353

def hash
  [class_id, object_type, actions, advisory_details, advisory_id, api_data_sources, date_published, date_updated, external_url, recommendation, s3_data_sources, type, version, workaround, organization].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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 249

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

  pattern = Regexp.new(/^$|^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[\w\-\._~:\/?#\[\]@!\$&'\(\)\*\+,;=.]+$/)
  if !@external_url.nil? && @external_url !~ pattern
    invalid_properties.push("invalid value for \"external_url\", must conform to the pattern #{pattern}.")
  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



438
439
440
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 438

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



444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 444

def to_hash
  hash = super
  TamAdvisoryDefinition.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = TamAdvisoryDefinition.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



432
433
434
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 432

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



269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/intersight_client/models/tam_advisory_definition.rb', line 269

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["tam.AdvisoryDefinition"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["tam.AdvisoryDefinition"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@external_url.nil? && @external_url !~ Regexp.new(/^$|^(?:http(s)?:\/\/)?[\w.-]+(?:\.[\w\.-]+)+[\w\-\._~:\/?#\[\]@!\$&'\(\)\*\+,;=.]+$/)
  type_validator = EnumAttributeValidator.new('String', ["securityAdvisory", "fieldNotice"])
  return false unless type_validator.valid?(@type)
  true && super
end