Package software.amazon.awssdk.services.kendra.model

Interface WebCrawlerConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WebCrawlerConfiguration.Builder,WebCrawlerConfiguration>, SdkBuilder<WebCrawlerConfiguration.Builder,WebCrawlerConfiguration>, SdkPojo
Enclosing class:
WebCrawlerConfiguration
public static interface WebCrawlerConfiguration.Builder extends SdkPojo, CopyableBuilder<WebCrawlerConfiguration.Builder,WebCrawlerConfiguration>

  • Method Details

    • urls

      WebCrawlerConfiguration.Builder urls(Urls urls)

      Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

      You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

      You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

      When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.

      Parameters:
      urls - Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

      You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

      You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

      When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • urls

      default WebCrawlerConfiguration.Builder urls(Consumer<Urls.Builder> urls)

      Specifies the seed or starting point URLs of the websites or the sitemap URLs of the websites you want to crawl.

      You can include website subdomains. You can list up to 100 seed URLs and up to three sitemap URLs.

      You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

      When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.

      This is a convenience method that creates an instance of the Urls.Builder avoiding the need to create one manually via Urls.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to urls(Urls).

      Parameters:
      urls - a consumer that will call methods on Urls.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • crawlDepth

      WebCrawlerConfiguration.Builder crawlDepth(Integer crawlDepth)

      The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.

      Parameters:
      crawlDepth - The 'depth' or number of levels from the seed level to crawl. For example, the seed URL page is depth 1 and any hyperlinks on this page that are also crawled are depth 2.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxLinksPerPage

      WebCrawlerConfiguration.Builder maxLinksPerPage(Integer maxLinksPerPage)

      The maximum number of URLs on a web page to include when crawling a website. This number is per web page.

      As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.

      The default maximum links per page is 100.

      Parameters:
      maxLinksPerPage - The maximum number of URLs on a web page to include when crawling a website. This number is per web page.

      As a website’s web pages are crawled, any URLs the web pages link to are also crawled. URLs on a web page are crawled in order of appearance.

      The default maximum links per page is 100.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxContentSizePerPageInMegaBytes

      WebCrawlerConfiguration.Builder maxContentSizePerPageInMegaBytes(Float maxContentSizePerPageInMegaBytes)

      The maximum size (in MB) of a web page or attachment to crawl.

      Files larger than this size (in MB) are skipped/not crawled.

      The default maximum size of a web page or attachment is set to 50 MB.

      Parameters:
      maxContentSizePerPageInMegaBytes - The maximum size (in MB) of a web page or attachment to crawl.

      Files larger than this size (in MB) are skipped/not crawled.

      The default maximum size of a web page or attachment is set to 50 MB.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxUrlsPerMinuteCrawlRate

      WebCrawlerConfiguration.Builder maxUrlsPerMinuteCrawlRate(Integer maxUrlsPerMinuteCrawlRate)

      The maximum number of URLs crawled per website host per minute.

      A minimum of one URL is required.

      The default maximum number of URLs crawled per website host per minute is 300.

      Parameters:
      maxUrlsPerMinuteCrawlRate - The maximum number of URLs crawled per website host per minute.

      A minimum of one URL is required.

      The default maximum number of URLs crawled per website host per minute is 300.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • urlInclusionPatterns

      WebCrawlerConfiguration.Builder urlInclusionPatterns(Collection<String> urlInclusionPatterns)

      A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

      Parameters:
      urlInclusionPatterns - A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • urlInclusionPatterns

      WebCrawlerConfiguration.Builder urlInclusionPatterns(String... urlInclusionPatterns)

      A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

      Parameters:
      urlInclusionPatterns - A list of regular expression patterns to include certain URLs to crawl. URLs that match the patterns are included in the index. URLs that don't match the patterns are excluded from the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • urlExclusionPatterns

      WebCrawlerConfiguration.Builder urlExclusionPatterns(Collection<String> urlExclusionPatterns)

      A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

      Parameters:
      urlExclusionPatterns - A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • urlExclusionPatterns

      WebCrawlerConfiguration.Builder urlExclusionPatterns(String... urlExclusionPatterns)

      A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.

      Parameters:
      urlExclusionPatterns - A list of regular expression patterns to exclude certain URLs to crawl. URLs that match the patterns are excluded from the index. URLs that don't match the patterns are included in the index. If a URL matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the URL file isn't included in the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proxyConfiguration

      WebCrawlerConfiguration.Builder proxyConfiguration(ProxyConfiguration proxyConfiguration)

      Configuration information required to connect to your internal websites via a web proxy.

      You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

      Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager.

      Parameters:
      proxyConfiguration - Configuration information required to connect to your internal websites via a web proxy.

      You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

      Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proxyConfiguration

      default WebCrawlerConfiguration.Builder proxyConfiguration(Consumer<ProxyConfiguration.Builder> proxyConfiguration)

      Configuration information required to connect to your internal websites via a web proxy.

      You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

      Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication. To store web proxy credentials, you use a secret in Secrets Manager.

      This is a convenience method that creates an instance of the ProxyConfiguration.Builder avoiding the need to create one manually via ProxyConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to proxyConfiguration(ProxyConfiguration).

      Parameters:
      proxyConfiguration - a consumer that will call methods on ProxyConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authenticationConfiguration

      WebCrawlerConfiguration.Builder authenticationConfiguration(AuthenticationConfiguration authenticationConfiguration)

      Configuration information required to connect to websites using authentication.

      You can connect to websites using basic authentication of user name and password. You use a secret in Secrets Manager to store your authentication credentials.

      You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

      Parameters:
      authenticationConfiguration - Configuration information required to connect to websites using authentication.

      You can connect to websites using basic authentication of user name and password. You use a secret in Secrets Manager to store your authentication credentials.

      You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationConfiguration

      default WebCrawlerConfiguration.Builder authenticationConfiguration(Consumer<AuthenticationConfiguration.Builder> authenticationConfiguration)

      Configuration information required to connect to websites using authentication.

      You can connect to websites using basic authentication of user name and password. You use a secret in Secrets Manager to store your authentication credentials.

      You must provide the website host name and port number. For example, the host name of https://a.example.com/page1.html is "a.example.com" and the port is 443, the standard port for HTTPS.

      This is a convenience method that creates an instance of the AuthenticationConfiguration.Builder avoiding the need to create one manually via AuthenticationConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticationConfiguration(AuthenticationConfiguration).

      Parameters:
      authenticationConfiguration - a consumer that will call methods on AuthenticationConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: