Class: SwaggerClient::ScanTemplateWebSpider

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScanTemplateWebSpider

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 73

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

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

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

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

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

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

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

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

Instance Attribute Details

#dont_scan_multi_use_devices ⇒ Object

Whether scanning of multi-use devices, such as printers or print servers should be avoided.



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

def dont_scan_multi_use_devices
  @dont_scan_multi_use_devices
end

#include_query_strings ⇒ Object

Whether query strings are using in URLs when web spidering. This causes the web spider to make many more requests to the Web server. This will increase overall scan time and possibly affect the Web server’s performance for legitimate users.



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

def include_query_strings
  @include_query_strings
end

#paths ⇒ Object

Returns the value of attribute paths.



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

def paths
  @paths
end

#patterns ⇒ Object

Returns the value of attribute patterns.



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

def patterns
  @patterns
end

#performance ⇒ Object

Returns the value of attribute performance.



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

def performance
  @performance
end

#test_common_usernames_and_passwords ⇒ Object

Whether to determine if discovered logon forms accept commonly used user names or passwords. The process may cause authentication services with certain security policies to lock out accounts with these credentials.



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

def test_common_usernames_and_passwords
  @test_common_usernames_and_passwords
end

#test_xss_in_single_scan ⇒ Object

Whether to test for persistent cross-site scripting during a single scan. This test helps to reduce the risk of dangerous attacks via malicious code stored on Web servers. Enabling it may increase Web spider scan times.



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

def test_xss_in_single_scan
  @test_xss_in_single_scan
end

#user_agent ⇒ Object

The ‘User-Agent` to use when web spidering. Defaults to `"Mozilla/5.0 (compatible; MSIE 7.0; Windows NT 6.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727)"`.



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

def user_agent
  @user_agent
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 38

def self.attribute_map
  {
    :'dont_scan_multi_use_devices' => :'dontScanMultiUseDevices',
    :'include_query_strings' => :'includeQueryStrings',
    :'paths' => :'paths',
    :'patterns' => :'patterns',
    :'performance' => :'performance',
    :'test_common_usernames_and_passwords' => :'testCommonUsernamesAndPasswords',
    :'test_xss_in_single_scan' => :'testXssInSingleScan',
    :'user_agent' => :'userAgent'
  }
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



162
163
164
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 162

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



66
67
68
69
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 66

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 52

def self.openapi_types
  {
    :'dont_scan_multi_use_devices' => :'Object',
    :'include_query_strings' => :'Object',
    :'paths' => :'Object',
    :'patterns' => :'Object',
    :'performance' => :'Object',
    :'test_common_usernames_and_passwords' => :'Object',
    :'test_xss_in_single_scan' => :'Object',
    :'user_agent' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 134

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      dont_scan_multi_use_devices == o.dont_scan_multi_use_devices &&
      include_query_strings == o.include_query_strings &&
      paths == o.paths &&
      patterns == o.patterns &&
      performance == o.performance &&
      test_common_usernames_and_passwords == o.test_common_usernames_and_passwords &&
      test_xss_in_single_scan == o.test_xss_in_single_scan &&
      user_agent == o.user_agent
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



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

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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 261

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 169

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


149
150
151
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 155

def hash
  [dont_scan_multi_use_devices, include_query_strings, paths, patterns, performance, test_common_usernames_and_passwords, test_xss_in_single_scan, user_agent].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



121
122
123
124
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 121

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



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

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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 243

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



231
232
233
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 231

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



128
129
130
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider.rb', line 128

def valid?
  true
end