Class: SwaggerClient::ScanEngine

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScanEngine

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
188
189
190
191
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

The address the scan engine is hosted.



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

def address
  @address
end

#content_version ⇒ Object

The content version of the scan engine.



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

def content_version
  @content_version
end

#id ⇒ Object

The identifier of the scan engine.



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

def id
  @id
end

#is_aws_pre_auth_engine ⇒ Object

A boolean of whether the Engine is of type AWS Pre Authorized



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

def is_aws_pre_auth_engine
  @is_aws_pre_auth_engine
end

#last_refreshed_date ⇒ Object

The date the engine was last refreshed. Date format is in ISO 8601.



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

def last_refreshed_date
  @last_refreshed_date
end

#last_updated_date ⇒ Object

The date the engine was last updated. Date format is in ISO 8601.



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

def last_updated_date
  @last_updated_date
end

#links ⇒ Object

Hypermedia links to corresponding or related resources.



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

def links
  @links
end

#name ⇒ Object

The name of the scan engine.



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

def name
  @name
end

#port ⇒ Object

The port used by the scan engine to communicate with the Security Console.



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

def port
  @port
end

#product_version ⇒ Object

The product version of the scan engine.



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

def product_version
  @product_version
end

#serial_number ⇒ Object

${scan.engine.serial.number



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

def serial_number
  @serial_number
end

#sites ⇒ Object

A list of identifiers of each site the scan engine is assigned to.



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

def sites
  @sites
end

#status ⇒ Object

The scan engine status. Can be one of the following values: | Value | Description | | ————————- | —————————————————————————————— | | ‘"active"` | The scan engine is active. | | `"incompatible-version"` | The product version of the remote scan engine is not compatible with the Security Console. | | `"not-responding"` | The scan engine is not responding to the Security Console. | | `"pending-authorization"` | The Security Console is not yet authorized to connect to the scan engine. | | `"unknown"` | The status of the scan engine is unknown. |



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

def status
  @status
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/scan_engine.rb', line 78

def self.attribute_map
  {
    :'address' => :'address',
    :'content_version' => :'contentVersion',
    :'id' => :'id',
    :'is_aws_pre_auth_engine' => :'isAWSPreAuthEngine',
    :'last_refreshed_date' => :'lastRefreshedDate',
    :'last_updated_date' => :'lastUpdatedDate',
    :'links' => :'links',
    :'name' => :'name',
    :'port' => :'port',
    :'product_version' => :'productVersion',
    :'serial_number' => :'serialNumber',
    :'sites' => :'sites',
    :'status' => :'status'
  }
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



268
269
270
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 268

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/scan_engine.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/scan_engine.rb', line 97

def self.openapi_types
  {
    :'address' => :'Object',
    :'content_version' => :'Object',
    :'id' => :'Object',
    :'is_aws_pre_auth_engine' => :'Object',
    :'last_refreshed_date' => :'Object',
    :'last_updated_date' => :'Object',
    :'links' => :'Object',
    :'name' => :'Object',
    :'port' => :'Object',
    :'product_version' => :'Object',
    :'serial_number' => :'Object',
    :'sites' => :'Object',
    :'status' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      content_version == o.content_version &&
      id == o.id &&
      is_aws_pre_auth_engine == o.is_aws_pre_auth_engine &&
      last_refreshed_date == o.last_refreshed_date &&
      last_updated_date == o.last_updated_date &&
      links == o.links &&
      name == o.name &&
      port == o.port &&
      product_version == o.product_version &&
      serial_number == o.serial_number &&
      sites == o.sites &&
      status == o.status
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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 298

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 367

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 275

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



261
262
263
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 261

def hash
  [address, content_version, id, is_aws_pre_auth_engine, last_refreshed_date, last_updated_date, links, name, port, product_version, serial_number, sites, status].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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 195

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

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

  if @port.nil?
    invalid_properties.push('invalid value for "port", port 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



343
344
345
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 343

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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 349

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



337
338
339
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 337

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



214
215
216
217
218
219
220
221
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_engine.rb', line 214

def valid?
  return false if @address.nil?
  return false if @name.nil?
  return false if @port.nil?
  status_validator = EnumAttributeValidator.new('Object', ['active', 'incompatible-version', 'not-responding', 'pending-authorization', 'unknown'])
  return false unless status_validator.valid?(@status)
  true
end