Class: SwaggerClient::GlobalScan

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GlobalScan

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assets ⇒ Object

The number of assets found in the scan.



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

def assets
  @assets
end

#duration ⇒ Object

The duration of the scan in ISO8601 format.



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

def duration
  @duration
end

#end_time ⇒ Object

The end time of the scan in ISO8601 format.



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

def end_time
  @end_time
end

#engine_id ⇒ Object

The identifier of the scan engine.



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

def engine_id
  @engine_id
end

#engine_ids ⇒ Object

$SwaggerClient::GlobalScan.scanscan.enginescan.engine.ids



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

def engine_ids
  @engine_ids
end

#engine_name ⇒ Object

The name of the scan engine.



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

def engine_name
  @engine_name
end

#id ⇒ Object

The identifier of the scan.



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

def id
  @id
end

#links ⇒ Object

Hypermedia links to corresponding or related resources.



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

def links
  @links
end

#message ⇒ Object

The reason for the scan status.



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

def message
  @message
end

#scan_name ⇒ Object

The user-driven scan name for the scan.



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

def scan_name
  @scan_name
end

#scan_type ⇒ Object

The scan type (automated, manual, scheduled).



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

def scan_type
  @scan_type
end

#site_id ⇒ Object

Returns the value of attribute site_id.



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

def site_id
  @site_id
end

#site_name ⇒ Object

Returns the value of attribute site_name.



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

def site_name
  @site_name
end

#start_time ⇒ Object

The start time of the scan in ISO8601 format.



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

def start_time
  @start_time
end

#started_by ⇒ Object

The name of the user that started the scan.



57
58
59
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 57

def started_by
  @started_by
end

#started_by_username ⇒ Object

$SwaggerClient::GlobalScan.scanscan.username



60
61
62
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 60

def started_by_username
  @started_by_username
end

#status ⇒ Object

The scan status.



63
64
65
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 63

def status
  @status
end

#vulnerabilities ⇒ Object

Returns the value of attribute vulnerabilities.



65
66
67
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 65

def vulnerabilities
  @vulnerabilities
end

Class Method Details

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 90

def self.attribute_map
  {
    :'assets' => :'assets',
    :'duration' => :'duration',
    :'end_time' => :'endTime',
    :'engine_id' => :'engineId',
    :'engine_ids' => :'engineIds',
    :'engine_name' => :'engineName',
    :'id' => :'id',
    :'links' => :'links',
    :'message' => :'message',
    :'scan_name' => :'scanName',
    :'scan_type' => :'scanType',
    :'site_id' => :'siteId',
    :'site_name' => :'siteName',
    :'start_time' => :'startTime',
    :'started_by' => :'startedBy',
    :'started_by_username' => :'startedByUsername',
    :'status' => :'status',
    :'vulnerabilities' => :'vulnerabilities'
  }
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



300
301
302
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 300

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



138
139
140
141
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 138

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

.openapi_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 114

def self.openapi_types
  {
    :'assets' => :'Object',
    :'duration' => :'Object',
    :'end_time' => :'Object',
    :'engine_id' => :'Object',
    :'engine_ids' => :'Object',
    :'engine_name' => :'Object',
    :'id' => :'Object',
    :'links' => :'Object',
    :'message' => :'Object',
    :'scan_name' => :'Object',
    :'scan_type' => :'Object',
    :'site_id' => :'Object',
    :'site_name' => :'Object',
    :'start_time' => :'Object',
    :'started_by' => :'Object',
    :'started_by_username' => :'Object',
    :'status' => :'Object',
    :'vulnerabilities' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assets == o.assets &&
      duration == o.duration &&
      end_time == o.end_time &&
      engine_id == o.engine_id &&
      engine_ids == o.engine_ids &&
      engine_name == o.engine_name &&
      id == o.id &&
      links == o.links &&
      message == o.message &&
      scan_name == o.scan_name &&
      scan_type == o.scan_type &&
      site_id == o.site_id &&
      site_name == o.site_name &&
      start_time == o.start_time &&
      started_by == o.started_by &&
      started_by_username == o.started_by_username &&
      status == o.status &&
      vulnerabilities == o.vulnerabilities
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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 330

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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 399

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 307

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


287
288
289
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 287

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



293
294
295
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 293

def hash
  [assets, duration, end_time, engine_id, engine_ids, engine_name, id, links, message, scan_name, scan_type, site_id, site_name, start_time, started_by, started_by_username, status, vulnerabilities].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



237
238
239
240
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 237

def list_invalid_properties
  invalid_properties = Array.new
  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



375
376
377
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 375

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 381

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



369
370
371
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 369

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



244
245
246
247
248
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/global_scan.rb', line 244

def valid?
  status_validator = EnumAttributeValidator.new('Object', ['aborted', 'unknown', 'running', 'finished', 'stopped', 'error', 'paused', 'dispatched', 'integrating'])
  return false unless status_validator.valid?(@status)
  true
end