Interface WebCrawlerParameters.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WebCrawlerParameters.Builder,WebCrawlerParameters>, SdkBuilder<WebCrawlerParameters.Builder,WebCrawlerParameters>, SdkPojo
Enclosing class:
WebCrawlerParameters
@Mutable @NotThreadSafe public static interface WebCrawlerParameters.Builder extends SdkPojo, CopyableBuilder<WebCrawlerParameters.Builder,WebCrawlerParameters>

  • Method Details

    • webCrawlerAuthType

      WebCrawlerParameters.Builder webCrawlerAuthType(String webCrawlerAuthType)

      The authentication type for the web crawler. The type can be one of the following:

      • NO_AUTH: No authentication required.

      • BASIC_AUTH: Basic authentication using username and password.

      • SAML: SAML-based authentication.

      • FORM: Form-based authentication.

      Parameters:
      webCrawlerAuthType - The authentication type for the web crawler. The type can be one of the following:

      • NO_AUTH: No authentication required.

      • BASIC_AUTH: Basic authentication using username and password.

      • SAML: SAML-based authentication.

      • FORM: Form-based authentication.

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

    • webCrawlerAuthType

      WebCrawlerParameters.Builder webCrawlerAuthType(WebCrawlerAuthType webCrawlerAuthType)

      The authentication type for the web crawler. The type can be one of the following:

      • NO_AUTH: No authentication required.

      • BASIC_AUTH: Basic authentication using username and password.

      • SAML: SAML-based authentication.

      • FORM: Form-based authentication.

      Parameters:
      webCrawlerAuthType - The authentication type for the web crawler. The type can be one of the following:

      • NO_AUTH: No authentication required.

      • BASIC_AUTH: Basic authentication using username and password.

      • SAML: SAML-based authentication.

      • FORM: Form-based authentication.

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

    • usernameFieldXpath

      WebCrawlerParameters.Builder usernameFieldXpath(String usernameFieldXpath)

      The XPath expression for locating the username field on the login page.

      Parameters:
      usernameFieldXpath - The XPath expression for locating the username field on the login page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • passwordFieldXpath

      WebCrawlerParameters.Builder passwordFieldXpath(String passwordFieldXpath)

      The XPath expression for locating the password field on the login page.

      Parameters:
      passwordFieldXpath - The XPath expression for locating the password field on the login page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usernameButtonXpath

      WebCrawlerParameters.Builder usernameButtonXpath(String usernameButtonXpath)

      The XPath expression for locating the username submit button on the login page.

      Parameters:
      usernameButtonXpath - The XPath expression for locating the username submit button on the login page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • passwordButtonXpath

      WebCrawlerParameters.Builder passwordButtonXpath(String passwordButtonXpath)

      The XPath expression for locating the password submit button on the login page.

      Parameters:
      passwordButtonXpath - The XPath expression for locating the password submit button on the login page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loginPageUrl

      WebCrawlerParameters.Builder loginPageUrl(String loginPageUrl)

      The URL of the login page for the web crawler to authenticate.

      Parameters:
      loginPageUrl - The URL of the login page for the web crawler to authenticate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • webProxyHostName

      WebCrawlerParameters.Builder webProxyHostName(String webProxyHostName)

      The hostname of the web proxy server for the web crawler.

      Parameters:
      webProxyHostName - The hostname of the web proxy server for the web crawler.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • webProxyPortNumber

      WebCrawlerParameters.Builder webProxyPortNumber(Integer webProxyPortNumber)

      The port number of the web proxy server for the web crawler.

      Parameters:
      webProxyPortNumber - The port number of the web proxy server for the web crawler.
      Returns:
      Returns a reference to this object so that method calls can be chained together.