Class: ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::Markdown::Source::Sitemap

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::Markdown::Source::Sitemap

Defined in:

lib/context_dev/models/batch_submit_params.rb,
sig/context_dev/models/batch_submit_params.rbs

Defined Under Namespace

Classes: Controls

Instance Attribute Summary

• #controls ⇒ ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::Markdown::Source::Sitemap::Controls^?

  Limits and filters for the sitemap URLs.

• #domain ⇒ String

  Domain whose sitemap lists the pages to scrape.

• #type ⇒ Symbol, :sitemap

  Scrape the URLs in the domain's sitemap.

Instance Method Summary

• #initialize(domain:, controls: nil, type: :sitemap) ⇒ Object constructor

  Some parameter documentations has been truncated, see Sitemap for more details.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(domain:, controls: nil, type: :sitemap) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::Markdown::Source::Sitemap for more details.

Scrape the pages listed in a domain's sitemap. Links on those pages are not followed.

Parameters:

• domain (String) —

  Domain whose sitemap lists the pages to scrape. A full URL is reduced to its dom

• controls (ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::Markdown::Source::Sitemap::Controls) (defaults to: nil) —

  Limits and filters for the sitemap URLs. A sitemap batch scrapes exactly those U

• type (Symbol, :sitemap) (defaults to: :sitemap) —

  Scrape the URLs in the domain's sitemap.

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

Instance Attribute Details

#controls ⇒ ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::Markdown::Source::Sitemap::Controls^?

Limits and filters for the sitemap URLs. A sitemap batch scrapes exactly those URLs and never follows links off them, so there is no crawl depth here.

Returns:

• (ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::Markdown::Source::Sitemap::Controls, nil)

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

optional :controls,
-> { ContextDev::BatchSubmitParams::Input::Crawl::Data::Markdown::Source::Sitemap::Controls }

#domain ⇒ String

Domain whose sitemap lists the pages to scrape. A full URL is reduced to its domain.

Parameters:

• value (String)

Returns:

• (String)

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

required :domain, String

#type ⇒ Symbol, :sitemap

Scrape the URLs in the domain's sitemap.

Parameters:

• value (:sitemap)

Returns:

• (Symbol, :sitemap)

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

required :type, const: :sitemap

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {