Class: Xberg::CrawlConfig

Inherits:
Object
  • Object
show all
Defined in:
sig/types.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CrawlConfig

Returns a new instance of CrawlConfig.

Parameters:

  • max_depth: (Integer)
  • max_pages: (Integer)
  • max_concurrent: (Integer)
  • respect_robots_txt: (Boolean)
  • soft_http_errors: (Boolean)
  • user_agent: (String)
  • stay_on_domain: (Boolean)
  • allow_subdomains: (Boolean)
  • include_paths: (Array[String])
  • exclude_paths: (Array[String])
  • custom_headers: (Hash[String, String])
  • request_timeout: (Integer)
  • rate_limit_ms: (Integer)
  • max_redirects: (Integer)
  • retry_count: (Integer)
  • retry_codes: (Array[Integer])
  • cookies_enabled: (Boolean)
  • auth: (AuthConfig)
  • max_body_size: (Integer)
  • remove_tags: (Array[String])
  • content: (ContentConfig)
  • map_limit: (Integer)
  • map_search: (String)
  • download_assets: (Boolean)
  • asset_types: (Array[AssetCategory])
  • max_asset_size: (Integer)
  • browser: (BrowserConfig)
  • proxy: (ProxyConfig)
  • user_agents: (Array[String])
  • capture_screenshot: (Boolean)
  • follow_document_urls: (Boolean)
  • document_url_depth: (Integer)
  • download_documents: (Boolean)
  • document_max_size: (Integer)
  • document_mime_types: (Array[String])
  • warc_output: (String)
  • browser_profile: (String)
  • save_browser_profile: (Boolean)
  • ssrf: (SsrfPolicy) 


2285
 
# File 'sig/types.rbs', line 2285

def initialize: (?max_depth: Integer, ?max_pages: Integer, ?max_concurrent: Integer, ?respect_robots_txt: bool, ?soft_http_errors: bool, ?user_agent: String, ?stay_on_domain: bool, ?allow_subdomains: bool, ?include_paths: Array[String], ?exclude_paths: Array[String], ?custom_headers: Hash[String, String], ?request_timeout: Integer, ?rate_limit_ms: Integer, ?max_redirects: Integer, ?retry_count: Integer, ?retry_codes: Array[Integer], ?cookies_enabled: bool, ?auth: AuthConfig, ?max_body_size: Integer, ?remove_tags: Array[String], ?content: ContentConfig, ?map_limit: Integer, ?map_search: String, ?download_assets: bool, ?asset_types: Array[AssetCategory], ?max_asset_size: Integer, ?browser: BrowserConfig, ?proxy: ProxyConfig, ?user_agents: Array[String], ?capture_screenshot: bool, ?follow_document_urls: bool, ?document_url_depth: Integer, ?download_documents: bool, ?document_max_size: Integer, ?document_mime_types: Array[String], ?warc_output: String, ?browser_profile: String, ?save_browser_profile: bool, ?ssrf: SsrfPolicy) -> void

Instance Attribute Details

#allow_subdomains ⇒ Boolean?

Returns the value of attribute allow_subdomains.

Returns:

  • (Boolean, nil) 


2252
2253
2254
 
# File 'sig/types.rbs', line 2252

def allow_subdomains
  @allow_subdomains
end

#asset_types ⇒ Array[AssetCategory]?

Returns the value of attribute asset_types.

Returns:



2269
2270
2271
 
# File 'sig/types.rbs', line 2269

def asset_types
  @asset_types
end

#auth ⇒ AuthConfig?

Returns the value of attribute auth.

Returns:



2262
2263
2264
 
# File 'sig/types.rbs', line 2262

def auth
  @auth
end

#browser ⇒ BrowserConfig?

Returns the value of attribute browser.

Returns:



2271
2272
2273
 
# File 'sig/types.rbs', line 2271

def browser
  @browser
end

#browser_profile ⇒ String?

Returns the value of attribute browser_profile.

Returns:

  • (String, nil) 


2281
2282
2283
 
# File 'sig/types.rbs', line 2281

def browser_profile
  @browser_profile
end

#capture_screenshot ⇒ Boolean?

Returns the value of attribute capture_screenshot.

Returns:

  • (Boolean, nil) 


2274
2275
2276
 
# File 'sig/types.rbs', line 2274

def capture_screenshot
  @capture_screenshot
end

#content ⇒ ContentConfig?

Returns the value of attribute content.

Returns:



2265
2266
2267
 
# File 'sig/types.rbs', line 2265

def content
  @content
end

#cookies_enabled ⇒ Boolean?

Returns the value of attribute cookies_enabled.

Returns:

  • (Boolean, nil) 


2261
2262
2263
 
# File 'sig/types.rbs', line 2261

def cookies_enabled
  @cookies_enabled
end

#custom_headers ⇒ Hash[String, String]?

Returns the value of attribute custom_headers.

Returns:

  • (Hash[String, String], nil) 


2255
2256
2257
 
# File 'sig/types.rbs', line 2255

def custom_headers
  @custom_headers
end

#document_max_size ⇒ Integer?

Returns the value of attribute document_max_size.

Returns:

  • (Integer, nil) 


2278
2279
2280
 
# File 'sig/types.rbs', line 2278

def document_max_size
  @document_max_size
end

#document_mime_types ⇒ Array[String]?

Returns the value of attribute document_mime_types.

Returns:

  • (Array[String], nil) 


2279
2280
2281
 
# File 'sig/types.rbs', line 2279

def document_mime_types
  @document_mime_types
end

#document_url_depth ⇒ Integer?

Returns the value of attribute document_url_depth.

Returns:

  • (Integer, nil) 


2276
2277
2278
 
# File 'sig/types.rbs', line 2276

def document_url_depth
  @document_url_depth
end

#download_assets ⇒ Boolean?

Returns the value of attribute download_assets.

Returns:

  • (Boolean, nil) 


2268
2269
2270
 
# File 'sig/types.rbs', line 2268

def download_assets
  @download_assets
end

#download_documents ⇒ Boolean?

Returns the value of attribute download_documents.

Returns:

  • (Boolean, nil) 


2277
2278
2279
 
# File 'sig/types.rbs', line 2277

def download_documents
  @download_documents
end

#exclude_paths ⇒ Array[String]?

Returns the value of attribute exclude_paths.

Returns:

  • (Array[String], nil) 


2254
2255
2256
 
# File 'sig/types.rbs', line 2254

def exclude_paths
  @exclude_paths
end

#follow_document_urls ⇒ Boolean?

Returns the value of attribute follow_document_urls.

Returns:

  • (Boolean, nil) 


2275
2276
2277
 
# File 'sig/types.rbs', line 2275

def follow_document_urls
  @follow_document_urls
end

#include_paths ⇒ Array[String]?

Returns the value of attribute include_paths.

Returns:

  • (Array[String], nil) 


2253
2254
2255
 
# File 'sig/types.rbs', line 2253

def include_paths
  @include_paths
end

#map_limit ⇒ Integer?

Returns the value of attribute map_limit.

Returns:

  • (Integer, nil) 


2266
2267
2268
 
# File 'sig/types.rbs', line 2266

def map_limit
  @map_limit
end

#map_search ⇒ String?

Returns the value of attribute map_search.

Returns:

  • (String, nil) 


2267
2268
2269
 
# File 'sig/types.rbs', line 2267

def map_search
  @map_search
end

#max_asset_size ⇒ Integer?

Returns the value of attribute max_asset_size.

Returns:

  • (Integer, nil) 


2270
2271
2272
 
# File 'sig/types.rbs', line 2270

def max_asset_size
  @max_asset_size
end

#max_body_size ⇒ Integer?

Returns the value of attribute max_body_size.

Returns:

  • (Integer, nil) 


2263
2264
2265
 
# File 'sig/types.rbs', line 2263

def max_body_size
  @max_body_size
end

#max_concurrent ⇒ Integer?

Returns the value of attribute max_concurrent.

Returns:

  • (Integer, nil) 


2247
2248
2249
 
# File 'sig/types.rbs', line 2247

def max_concurrent
  @max_concurrent
end

#max_depth ⇒ Integer?

Returns the value of attribute max_depth.

Returns:

  • (Integer, nil) 


2245
2246
2247
 
# File 'sig/types.rbs', line 2245

def max_depth
  @max_depth
end

#max_pages ⇒ Integer?

Returns the value of attribute max_pages.

Returns:

  • (Integer, nil) 


2246
2247
2248
 
# File 'sig/types.rbs', line 2246

def max_pages
  @max_pages
end

#max_redirects ⇒ Integer?

Returns the value of attribute max_redirects.

Returns:

  • (Integer, nil) 


2258
2259
2260
 
# File 'sig/types.rbs', line 2258

def max_redirects
  @max_redirects
end

#proxy ⇒ ProxyConfig?

Returns the value of attribute proxy.

Returns:



2272
2273
2274
 
# File 'sig/types.rbs', line 2272

def proxy
  @proxy
end

#rate_limit_ms ⇒ Integer?

Returns the value of attribute rate_limit_ms.

Returns:

  • (Integer, nil) 


2257
2258
2259
 
# File 'sig/types.rbs', line 2257

def rate_limit_ms
  @rate_limit_ms
end

#remove_tags ⇒ Array[String]?

Returns the value of attribute remove_tags.

Returns:

  • (Array[String], nil) 


2264
2265
2266
 
# File 'sig/types.rbs', line 2264

def remove_tags
  @remove_tags
end

#request_timeout ⇒ Integer?

Returns the value of attribute request_timeout.

Returns:

  • (Integer, nil) 


2256
2257
2258
 
# File 'sig/types.rbs', line 2256

def request_timeout
  @request_timeout
end

#respect_robots_txt ⇒ Boolean?

Returns the value of attribute respect_robots_txt.

Returns:

  • (Boolean, nil) 


2248
2249
2250
 
# File 'sig/types.rbs', line 2248

def respect_robots_txt
  @respect_robots_txt
end

#retry_codes ⇒ Array[Integer]?

Returns the value of attribute retry_codes.

Returns:

  • (Array[Integer], nil) 


2260
2261
2262
 
# File 'sig/types.rbs', line 2260

def retry_codes
  @retry_codes
end

#retry_count ⇒ Integer?

Returns the value of attribute retry_count.

Returns:

  • (Integer, nil) 


2259
2260
2261
 
# File 'sig/types.rbs', line 2259

def retry_count
  @retry_count
end

#save_browser_profile ⇒ Boolean?

Returns the value of attribute save_browser_profile.

Returns:

  • (Boolean, nil) 


2282
2283
2284
 
# File 'sig/types.rbs', line 2282

def save_browser_profile
  @save_browser_profile
end

#soft_http_errors ⇒ Boolean?

Returns the value of attribute soft_http_errors.

Returns:

  • (Boolean, nil) 


2249
2250
2251
 
# File 'sig/types.rbs', line 2249

def soft_http_errors
  @soft_http_errors
end

#ssrf ⇒ SsrfPolicy?

Returns the value of attribute ssrf.

Returns:



2283
2284
2285
 
# File 'sig/types.rbs', line 2283

def ssrf
  @ssrf
end

#stay_on_domain ⇒ Boolean?

Returns the value of attribute stay_on_domain.

Returns:

  • (Boolean, nil) 


2251
2252
2253
 
# File 'sig/types.rbs', line 2251

def stay_on_domain
  @stay_on_domain
end

#user_agent ⇒ String?

Returns the value of attribute user_agent.

Returns:

  • (String, nil) 


2250
2251
2252
 
# File 'sig/types.rbs', line 2250

def user_agent
  @user_agent
end

#user_agents ⇒ Array[String]?

Returns the value of attribute user_agents.

Returns:

  • (Array[String], nil) 


2273
2274
2275
 
# File 'sig/types.rbs', line 2273

def user_agents
  @user_agents
end

#warc_output ⇒ String?

Returns the value of attribute warc_output.

Returns:

  • (String, nil) 


2280
2281
2282
 
# File 'sig/types.rbs', line 2280

def warc_output
  @warc_output
end