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

Inherits:

Internal::Type::BaseModel

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

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::StartURL::Controls^?

  Limits and filters for page discovery.

• #type ⇒ Symbol, :start_url

  Start from one page.

• #url ⇒ String

  Page where crawling begins.

Instance Method Summary

• #initialize(url:, controls: nil, type: :start_url) ⇒ Object constructor

  Discover pages by following links from one URL.

• #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(url:, controls: nil, type: :start_url) ⇒ Object

Discover pages by following links from one URL.

Parameters:

• url (String) —

  Page where crawling begins. A URL without a scheme is read as https://.

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

  Limits and filters for page discovery.

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

  Start from one page.

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

Instance Attribute Details

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

Limits and filters for page discovery.

Returns:

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

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

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

#type ⇒ Symbol, :start_url

Start from one page.

Parameters:

• value (:start_url)

Returns:

• (Symbol, :start_url)

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

required :type, const: :start_url

#url ⇒ String

Page where crawling begins. A URL without a scheme is read as https://.

Parameters:

• value (String)

Returns:

• (String)

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

required :url, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {