Class: ContextDev::Models::BatchSubmitParams::Input::Scrape::Data::HTML::URL

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/batch_submit_params.rb,
sig/context_dev/models/batch_submit_params.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

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(urls:, options: nil, format_: :html) ⇒ Object

Scrape the listed pages as HTML.

Parameters:



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/context_dev/models/batch_submit_params.rb', line 641

class URL < ContextDev::Internal::Type::BaseModel
  # @!attribute url
  #   Page URL to scrape.
  #
  #   @return [String]
  required :url, String

  # @!attribute item_id
  #   Your ID for this page, returned with its result. The same URL can use different
  #   IDs.
  #
  #   @return [String, nil]
  optional :item_id, String, api_name: :itemId

  # @!attribute meta
  #   Custom JSON returned unchanged with this page result.
  #
  #   @return [Hash{Symbol=>Object}, nil]
  optional :meta, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]

  # @!method initialize(url:, item_id: nil, meta: nil)
  #   Some parameter documentations has been truncated, see
  #   {ContextDev::Models::BatchSubmitParams::Input::Scrape::Data::HTML::URL} for more
  #   details.
  #
  #   A page to scrape, with optional data for matching results.
  #
  #   @param url [String] Page URL to scrape.
  #
  #   @param item_id [String] Your ID for this page, returned with its result. The same URL can use different
  #
  #   @param meta [Hash{Symbol=>Object}] Custom JSON returned unchanged with this page result.
end

Instance Attribute Details

#item_id ⇒ String?

Your ID for this page, returned with its result. The same URL can use different IDs.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :item_id, String, api_name: :itemId

#meta ⇒ Hash{Symbol=>Object}?

Custom JSON returned unchanged with this page result.

Parameters:

  • (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}, nil) 


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

optional :meta, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]

#url ⇒ String

Page URL to scrape.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :url, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {