Class: ContextDev::Models::WebWebScrapeSitemapResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/web_web_scrape_sitemap_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Success Classes: KeyMetadata, Meta

Instance Attribute Summary collapse

Class Method 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(errors:, sitemaps_discovered:, sitemaps_fetched:, sitemaps_skipped:) ⇒ Object

Metadata about the sitemap crawl operation

Parameters:

  • errors (Integer) —

    Number of errors encountered during crawling

  • sitemaps_discovered (Integer) —

    Total number of sitemap files discovered

  • sitemaps_fetched (Integer) —

    Number of sitemap files successfully fetched and parsed

  • sitemaps_skipped (Integer) —

    Number of sitemap files skipped (due to errors, timeouts, or limits)




# File 'lib/context_dev/models/web_web_scrape_sitemap_response.rb', line 38

Instance Attribute Details

#domain ⇒ String

The normalized domain that was crawled

Returns:

  • (String) 


11
 
# File 'lib/context_dev/models/web_web_scrape_sitemap_response.rb', line 11

required :domain, String

#key_metadata ⇒ ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata?

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.

Returns:



36
 
# File 'lib/context_dev/models/web_web_scrape_sitemap_response.rb', line 36

optional :key_metadata, -> { ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata }

#meta ⇒ ContextDev::Models::WebWebScrapeSitemapResponse::Meta

Metadata about the sitemap crawl operation

Returns:



17
 
# File 'lib/context_dev/models/web_web_scrape_sitemap_response.rb', line 17

required :meta, -> { ContextDev::Models::WebWebScrapeSitemapResponse::Meta }

#success ⇒ Boolean, ContextDev::Models::WebWebScrapeSitemapResponse::Success

Indicates success

Returns:



23
 
# File 'lib/context_dev/models/web_web_scrape_sitemap_response.rb', line 23

required :success, enum: -> { ContextDev::Models::WebWebScrapeSitemapResponse::Success }

#urls ⇒ Array<String>

Array of discovered page URLs from the sitemap (max 500)

Returns:

  • (Array<String>) 


29
 
# File 'lib/context_dev/models/web_web_scrape_sitemap_response.rb', line 29

required :urls, ContextDev::Internal::Type::ArrayOf[String]

Class Method Details

.values ⇒ Array<Boolean>

Returns:

  • (Array<Boolean>) 



# File 'lib/context_dev/models/web_web_scrape_sitemap_response.rb', line 98