Class: Crawlberg::CrawlConfig

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

Instance Attribute Summary collapse

Class Method 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) 


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

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) 


75
76
77
 
# File 'sig/types.rbs', line 75

def allow_subdomains
  @allow_subdomains
end

#asset_types ⇒ Array[AssetCategory]?

Returns the value of attribute asset_types.

Returns:



92
93
94
 
# File 'sig/types.rbs', line 92

def asset_types
  @asset_types
end

#auth ⇒ AuthConfig?

Returns the value of attribute auth.

Returns:



85
86
87
 
# File 'sig/types.rbs', line 85

def auth
  @auth
end

#browser ⇒ BrowserConfig?

Returns the value of attribute browser.

Returns:



94
95
96
 
# File 'sig/types.rbs', line 94

def browser
  @browser
end

#browser_profile ⇒ String?

Returns the value of attribute browser_profile.

Returns:

  • (String, nil) 


104
105
106
 
# File 'sig/types.rbs', line 104

def browser_profile
  @browser_profile
end

#capture_screenshot ⇒ Boolean?

Returns the value of attribute capture_screenshot.

Returns:

  • (Boolean, nil) 


97
98
99
 
# File 'sig/types.rbs', line 97

def capture_screenshot
  @capture_screenshot
end

#content ⇒ ContentConfig?

Returns the value of attribute content.

Returns:



88
89
90
 
# File 'sig/types.rbs', line 88

def content
  @content
end

#cookies_enabled ⇒ Boolean?

Returns the value of attribute cookies_enabled.

Returns:

  • (Boolean, nil) 


84
85
86
 
# File 'sig/types.rbs', line 84

def cookies_enabled
  @cookies_enabled
end

#custom_headers ⇒ Hash[String, String]?

Returns the value of attribute custom_headers.

Returns:

  • (Hash[String, String], nil) 


78
79
80
 
# File 'sig/types.rbs', line 78

def custom_headers
  @custom_headers
end

#document_max_size ⇒ Integer?

Returns the value of attribute document_max_size.

Returns:

  • (Integer, nil) 


101
102
103
 
# File 'sig/types.rbs', line 101

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) 


102
103
104
 
# File 'sig/types.rbs', line 102

def document_mime_types
  @document_mime_types
end

#document_url_depth ⇒ Integer?

Returns the value of attribute document_url_depth.

Returns:

  • (Integer, nil) 


99
100
101
 
# File 'sig/types.rbs', line 99

def document_url_depth
  @document_url_depth
end

#download_assets ⇒ Boolean?

Returns the value of attribute download_assets.

Returns:

  • (Boolean, nil) 


91
92
93
 
# File 'sig/types.rbs', line 91

def download_assets
  @download_assets
end

#download_documents ⇒ Boolean?

Returns the value of attribute download_documents.

Returns:

  • (Boolean, nil) 


100
101
102
 
# File 'sig/types.rbs', line 100

def download_documents
  @download_documents
end

#exclude_paths ⇒ Array[String]?

Returns the value of attribute exclude_paths.

Returns:

  • (Array[String], nil) 


77
78
79
 
# File 'sig/types.rbs', line 77

def exclude_paths
  @exclude_paths
end

#follow_document_urls ⇒ Boolean?

Returns the value of attribute follow_document_urls.

Returns:

  • (Boolean, nil) 


98
99
100
 
# File 'sig/types.rbs', line 98

def follow_document_urls
  @follow_document_urls
end

#include_paths ⇒ Array[String]?

Returns the value of attribute include_paths.

Returns:

  • (Array[String], nil) 


76
77
78
 
# File 'sig/types.rbs', line 76

def include_paths
  @include_paths
end

#map_limit ⇒ Integer?

Returns the value of attribute map_limit.

Returns:

  • (Integer, nil) 


89
90
91
 
# File 'sig/types.rbs', line 89

def map_limit
  @map_limit
end

#map_search ⇒ String?

Returns the value of attribute map_search.

Returns:

  • (String, nil) 


90
91
92
 
# File 'sig/types.rbs', line 90

def map_search
  @map_search
end

#max_asset_size ⇒ Integer?

Returns the value of attribute max_asset_size.

Returns:

  • (Integer, nil) 


93
94
95
 
# File 'sig/types.rbs', line 93

def max_asset_size
  @max_asset_size
end

#max_body_size ⇒ Integer?

Returns the value of attribute max_body_size.

Returns:

  • (Integer, nil) 


86
87
88
 
# File 'sig/types.rbs', line 86

def max_body_size
  @max_body_size
end

#max_concurrent ⇒ Integer?

Returns the value of attribute max_concurrent.

Returns:

  • (Integer, nil) 


70
71
72
 
# File 'sig/types.rbs', line 70

def max_concurrent
  @max_concurrent
end

#max_depth ⇒ Integer?

Returns the value of attribute max_depth.

Returns:

  • (Integer, nil) 


68
69
70
 
# File 'sig/types.rbs', line 68

def max_depth
  @max_depth
end

#max_pages ⇒ Integer?

Returns the value of attribute max_pages.

Returns:

  • (Integer, nil) 


69
70
71
 
# File 'sig/types.rbs', line 69

def max_pages
  @max_pages
end

#max_redirects ⇒ Integer?

Returns the value of attribute max_redirects.

Returns:

  • (Integer, nil) 


81
82
83
 
# File 'sig/types.rbs', line 81

def max_redirects
  @max_redirects
end

#proxy ⇒ ProxyConfig?

Returns the value of attribute proxy.

Returns:



95
96
97
 
# File 'sig/types.rbs', line 95

def proxy
  @proxy
end

#rate_limit_ms ⇒ Integer?

Returns the value of attribute rate_limit_ms.

Returns:

  • (Integer, nil) 


80
81
82
 
# File 'sig/types.rbs', line 80

def rate_limit_ms
  @rate_limit_ms
end

#remove_tags ⇒ Array[String]?

Returns the value of attribute remove_tags.

Returns:

  • (Array[String], nil) 


87
88
89
 
# File 'sig/types.rbs', line 87

def remove_tags
  @remove_tags
end

#request_timeout ⇒ Integer?

Returns the value of attribute request_timeout.

Returns:

  • (Integer, nil) 


79
80
81
 
# File 'sig/types.rbs', line 79

def request_timeout
  @request_timeout
end

#respect_robots_txt ⇒ Boolean?

Returns the value of attribute respect_robots_txt.

Returns:

  • (Boolean, nil) 


71
72
73
 
# File 'sig/types.rbs', line 71

def respect_robots_txt
  @respect_robots_txt
end

#retry_codes ⇒ Array[Integer]?

Returns the value of attribute retry_codes.

Returns:

  • (Array[Integer], nil) 


83
84
85
 
# File 'sig/types.rbs', line 83

def retry_codes
  @retry_codes
end

#retry_count ⇒ Integer?

Returns the value of attribute retry_count.

Returns:

  • (Integer, nil) 


82
83
84
 
# File 'sig/types.rbs', line 82

def retry_count
  @retry_count
end

#save_browser_profile ⇒ Boolean?

Returns the value of attribute save_browser_profile.

Returns:

  • (Boolean, nil) 


105
106
107
 
# File 'sig/types.rbs', line 105

def save_browser_profile
  @save_browser_profile
end

#soft_http_errors ⇒ Boolean?

Returns the value of attribute soft_http_errors.

Returns:

  • (Boolean, nil) 


72
73
74
 
# File 'sig/types.rbs', line 72

def soft_http_errors
  @soft_http_errors
end

#ssrf ⇒ SsrfPolicy?

Returns the value of attribute ssrf.

Returns:



106
107
108
 
# File 'sig/types.rbs', line 106

def ssrf
  @ssrf
end

#stay_on_domain ⇒ Boolean?

Returns the value of attribute stay_on_domain.

Returns:

  • (Boolean, nil) 


74
75
76
 
# File 'sig/types.rbs', line 74

def stay_on_domain
  @stay_on_domain
end

#user_agent ⇒ String?

Returns the value of attribute user_agent.

Returns:

  • (String, nil) 


73
74
75
 
# File 'sig/types.rbs', line 73

def user_agent
  @user_agent
end

#user_agents ⇒ Array[String]?

Returns the value of attribute user_agents.

Returns:

  • (Array[String], nil) 


96
97
98
 
# File 'sig/types.rbs', line 96

def user_agents
  @user_agents
end

#warc_output ⇒ String?

Returns the value of attribute warc_output.

Returns:

  • (String, nil) 


103
104
105
 
# File 'sig/types.rbs', line 103

def warc_output
  @warc_output
end

Class Method Details

.default ⇒ CrawlConfig

Returns:



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

def self.default: () -> CrawlConfig

Instance Method Details

#validate ⇒ void

This method returns an undefined value.



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

def validate: () -> void