Module: ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::HTML::Source

Extended by:
Internal::Type::Union
Defined in:
lib/context_dev/models/batch_submit_params.rb,
sig/context_dev/models/batch_submit_params.rbs

Overview

How to find pages to crawl.

See Also:

  • ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::HTML#source

Defined Under Namespace

Classes: Sitemap, StartURL

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(follow_subdomains: nil, max_depth: nil, max_urls: nil, regex: nil) ⇒ Object

Limits and filters for page discovery.

Parameters:

  • follow_subdomains (Boolean) (defaults to: nil) —

    Follow links to subdomains.

  • max_depth (Integer) (defaults to: nil) —

    Maximum link depth. Source pages are depth 0. No limit when omitted.

  • max_urls (Integer) (defaults to: nil) —

    Maximum pages to fetch. Unused reserved credits are refunded. Maximum 25000.

  • regex (String) (defaults to: nil) —

    RE2 pattern for URLs to include. The start_url itself is always included.




# File 'lib/context_dev/models/batch_submit_params.rb', line 1869

#self?.variants ⇒ ::Array[ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::HTML::source]

Returns:

  • (::Array[ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::HTML::source]) 


2232
 
# File 'sig/context_dev/models/batch_submit_params.rbs', line 2232

def self?.variants: -> ::Array[ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::HTML::source]