Package com.firecrawl.models

Class CrawlOptions

java.lang.Object

com.firecrawl.models.CrawlOptions

public class CrawlOptions
extends java.lang.Object

Options for crawling a website.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CrawlOptions.Builder

Method Summary

Modifier and Type	Method	Description
static CrawlOptions.Builder	builder()
java.lang.Boolean	getAllowExternalLinks()
java.lang.Boolean	getAllowSubdomains()
java.lang.Boolean	getCrawlEntireDomain()
java.lang.Boolean	getDeduplicateSimilarURLs()
java.lang.Integer	getDelay()
java.util.List<java.lang.String>	getExcludePaths()
java.lang.Boolean	getIgnoreQueryParameters()
java.util.List<java.lang.String>	getIncludePaths()
java.lang.String	getIntegration()
java.lang.Integer	getLimit()
java.lang.Integer	getMaxConcurrency()
java.lang.Integer	getMaxDiscoveryDepth()
java.lang.String	getPrompt()
java.lang.Boolean	getRegexOnFullURL()
ScrapeOptions	getScrapeOptions()
java.lang.String	getSitemap()
java.lang.Object	getWebhook()
java.lang.Boolean	getZeroDataRetention()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPrompt

public java.lang.String getPrompt()

getExcludePaths

public java.util.List<java.lang.String> getExcludePaths()

getIncludePaths

public java.util.List<java.lang.String> getIncludePaths()

getMaxDiscoveryDepth

public java.lang.Integer getMaxDiscoveryDepth()

getSitemap

public java.lang.String getSitemap()

getIgnoreQueryParameters

public java.lang.Boolean getIgnoreQueryParameters()

getDeduplicateSimilarURLs

public java.lang.Boolean getDeduplicateSimilarURLs()

getLimit

public java.lang.Integer getLimit()

getCrawlEntireDomain

public java.lang.Boolean getCrawlEntireDomain()

getAllowExternalLinks

public java.lang.Boolean getAllowExternalLinks()

getAllowSubdomains

public java.lang.Boolean getAllowSubdomains()

getDelay

public java.lang.Integer getDelay()

getMaxConcurrency

public java.lang.Integer getMaxConcurrency()

getWebhook

public java.lang.Object getWebhook()

getScrapeOptions

public ScrapeOptions getScrapeOptions()

getRegexOnFullURL

public java.lang.Boolean getRegexOnFullURL()

getZeroDataRetention

public java.lang.Boolean getZeroDataRetention()

getIntegration

public java.lang.String getIntegration()

builder

public static CrawlOptions.Builder builder()