Class: SwaggerClient::ScanTemplateWebSpiderPerformance

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScanTemplateWebSpiderPerformance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 81

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#http_daemons_to_skip ⇒ Object

The names of HTTP Daemons (HTTPd) to skip when spidering. For example, ‘"CUPS"`.



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

def http_daemons_to_skip
  @http_daemons_to_skip
end

#maximum_directory_levels ⇒ Object

The directory depth limit for web spidering. Limiting directory depth can save significant time, especially with large sites. A value of ‘0` signifies unlimited directory traversal. Defaults to `6`.



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

def maximum_directory_levels
  @maximum_directory_levels
end

#maximum_foreign_hosts ⇒ Object

The maximum number of unique host names that the spider may resolve. This function adds substantial time to the spidering process, especially with large Web sites, because of frequent cross-link checking involved. Defaults to ‘100`.



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

def maximum_foreign_hosts
  @maximum_foreign_hosts
end

#maximum_link_depth ⇒ Object

The maximum depth of links to traverse when spidering. Defaults to ‘6`.



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

def maximum_link_depth
  @maximum_link_depth
end

#maximum_pages ⇒ Object

The maximum the number of pages that are spidered. This is a time-saving measure for large sites. Defaults to ‘3000`.



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

def maximum_pages
  @maximum_pages
end

#maximum_retries ⇒ Object

The maximum the number of times to retry a request after a failure. A value of ‘0` means no retry attempts are made. Defaults to `2`.



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

def maximum_retries
  @maximum_retries
end

#maximum_time ⇒ Object

The maximum length of time to web spider. This limit prevents scans from taking longer than the allotted scan schedule. A value of ‘PT0S` means no limit is applied. The acceptable range is `PT1M` to `PT16666.6667H`.



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

def maximum_time
  @maximum_time
end

#response_timeout ⇒ Object

The duration to wait for a response from a target web server. The value is specified as a ISO8601 duration and can range from ‘PT0S` (0ms) to `P1H` (1 hour). Defaults to `PT2M`.



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

def response_timeout
  @response_timeout
end

#threads_per_server ⇒ Object

The number of threads to use per web server being spidered. Defaults to ‘3`.



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

def threads_per_server
  @threads_per_server
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 44

def self.attribute_map
  {
    :'http_daemons_to_skip' => :'httpDaemonsToSkip',
    :'maximum_directory_levels' => :'maximumDirectoryLevels',
    :'maximum_foreign_hosts' => :'maximumForeignHosts',
    :'maximum_link_depth' => :'maximumLinkDepth',
    :'maximum_pages' => :'maximumPages',
    :'maximum_retries' => :'maximumRetries',
    :'maximum_time' => :'maximumTime',
    :'response_timeout' => :'responseTimeout',
    :'threads_per_server' => :'threadsPerServer'
  }
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



177
178
179
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 177

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



74
75
76
77
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 74

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

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 59

def self.openapi_types
  {
    :'http_daemons_to_skip' => :'Object',
    :'maximum_directory_levels' => :'Object',
    :'maximum_foreign_hosts' => :'Object',
    :'maximum_link_depth' => :'Object',
    :'maximum_pages' => :'Object',
    :'maximum_retries' => :'Object',
    :'maximum_time' => :'Object',
    :'response_timeout' => :'Object',
    :'threads_per_server' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 148

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      http_daemons_to_skip == o.http_daemons_to_skip &&
      maximum_directory_levels == o.maximum_directory_levels &&
      maximum_foreign_hosts == o.maximum_foreign_hosts &&
      maximum_link_depth == o.maximum_link_depth &&
      maximum_pages == o.maximum_pages &&
      maximum_retries == o.maximum_retries &&
      maximum_time == o.maximum_time &&
      response_timeout == o.response_timeout &&
      threads_per_server == o.threads_per_server
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



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

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 276

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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 184

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


164
165
166
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



170
171
172
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 170

def hash
  [http_daemons_to_skip, maximum_directory_levels, maximum_foreign_hosts, maximum_link_depth, maximum_pages, maximum_retries, maximum_time, response_timeout, threads_per_server].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



135
136
137
138
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 135

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



252
253
254
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 252

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 258

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



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

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



142
143
144
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/scan_template_web_spider_performance.rb', line 142

def valid?
  true
end