Class: SwaggerClient::OperatingSystemCpe

Inherits:
Object
  • Object
show all
Defined in:
lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OperatingSystemCpe

Initializes the object

Parameters:

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

    Model attributes in the form of hash



123
124
125
126
127
128
129
130
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
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 123

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SwaggerClient::OperatingSystemCpe` 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.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SwaggerClient::OperatingSystemCpe`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#edition ⇒ Object

Edition-related terms applied by the vendor to the product.



17
18
19
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 17

def edition
  @edition
end

#language ⇒ Object

Defines the language supported in the user interface of the product being described. The format is of the language tag adheres to <a target="_blank" rel="noopener noreferrer" href="tools.ietf.org/html/rfc5646">RFC5646</a>.



20
21
22
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 20

def language
  @language
end

#other ⇒ Object

Captures any other general descriptive or identifying information which is vendor- or product-specific and which does not logically fit in any other attribute value.



23
24
25
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 23

def other
  @other
end

#part ⇒ Object

A single letter code that designates the particular platform part that is being identified.



26
27
28
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 26

def part
  @part
end

#product ⇒ Object

the most common and recognizable title or name of the product.



29
30
31
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 29

def product
  @product
end

#sw_edition ⇒ Object

Characterizes how the product is tailored to a particular market or class of end users.



32
33
34
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 32

def sw_edition
  @sw_edition
end

#target_hw ⇒ Object

Characterize the instruction set architecture on which the product operates.



35
36
37
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 35

def target_hw
  @target_hw
end

#target_sw ⇒ Object

Characterize the software computing environment within which the product operates.



38
39
40
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 38

def target_sw
  @target_sw
end

#update ⇒ Object

Vendor-specific alphanumeric strings characterizing the particular update, service pack, or point release of the product.



41
42
43
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 41

def update
  @update
end

#v2_2 ⇒ Object

The full CPE string in the <a target="_blank" rel="noopener noreferrer" href="cpe.mitre.org/files/cpe-specification_2.2.pdf">CPE 2.2</a> format.



44
45
46
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 44

def v2_2
  @v2_2
end

#v2_3 ⇒ Object

The full CPE string in the <a target="_blank" rel="noopener noreferrer" href="nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7695.pdf">CPE 2.3</a> format.



47
48
49
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 47

def v2_3
  @v2_3
end

#vendor ⇒ Object

The person or organization that manufactured or created the product.



50
51
52
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 50

def vendor
  @vendor
end

#version ⇒ Object

Vendor-specific alphanumeric strings characterizing the particular release version of the product.



53
54
55
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 53

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 78

def self.attribute_map
  {
    :'edition' => :'edition',
    :'language' => :'language',
    :'other' => :'other',
    :'part' => :'part',
    :'product' => :'product',
    :'sw_edition' => :'swEdition',
    :'target_hw' => :'targetHW',
    :'target_sw' => :'targetSW',
    :'update' => :'update',
    :'v2_2' => :'v2.2',
    :'v2_3' => :'v2.3',
    :'vendor' => :'vendor',
    :'version' => :'version'
  }
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



254
255
256
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 254

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 97

def self.openapi_types
  {
    :'edition' => :'Object',
    :'language' => :'Object',
    :'other' => :'Object',
    :'part' => :'Object',
    :'product' => :'Object',
    :'sw_edition' => :'Object',
    :'target_hw' => :'Object',
    :'target_sw' => :'Object',
    :'update' => :'Object',
    :'v2_2' => :'Object',
    :'v2_3' => :'Object',
    :'vendor' => :'Object',
    :'version' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      edition == o.edition &&
      language == o.language &&
      other == o.other &&
      part == o.part &&
      product == o.product &&
      sw_edition == o.sw_edition &&
      target_hw == o.target_hw &&
      target_sw == o.target_sw &&
      update == o.update &&
      v2_2 == o.v2_2 &&
      v2_3 == o.v2_3 &&
      vendor == o.vendor &&
      version == o.version
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



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
319
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 284

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    SwaggerClient.const_get(type).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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 353

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 261

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 247

def hash
  [edition, language, other, part, product, sw_edition, target_hw, target_sw, update, v2_2, v2_3, vendor, version].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



191
192
193
194
195
196
197
198
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 191

def list_invalid_properties
  invalid_properties = Array.new
  if @part.nil?
    invalid_properties.push('invalid value for "part", part 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



329
330
331
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 329

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 335

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



323
324
325
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 323

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



202
203
204
205
206
207
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/operating_system_cpe.rb', line 202

def valid?
  return false if @part.nil?
  part_validator = EnumAttributeValidator.new('Object', ['o', 'a', 'h'])
  return false unless part_validator.valid?(@part)
  true
end