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

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Overview

See Also:

• ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::Markdown::Source::StartURL#controls

Instance Attribute Summary

• #follow_subdomains ⇒ Boolean^?

  Follow links to subdomains.

• #max_depth ⇒ Integer^?

  Maximum link depth.

• #max_urls ⇒ Integer^?

  Maximum pages to fetch.

• #regex ⇒ String^?

  RE2 pattern for URLs to include.

Instance Method Summary

• #initialize ⇒ Object constructor
• #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 ⇒ Object

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

def initialize: (

Instance Attribute Details

#follow_subdomains ⇒ Boolean^?

Follow links to subdomains.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

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

optional :follow_subdomains,
ContextDev::Internal::Type::Boolean,
api_name: :followSubdomains

#max_depth ⇒ Integer^?

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

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :max_depth, Integer, api_name: :maxDepth

#max_urls ⇒ Integer^?

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

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :max_urls, Integer, api_name: :maxUrls

#regex ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :regex, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {