Struct WebCrawlerParameters 

#[non_exhaustive]
pub struct WebCrawlerParameters {
    pub web_crawler_auth_type: WebCrawlerAuthType,
    pub username_field_xpath: Option<String>,
    pub password_field_xpath: Option<String>,
    pub username_button_xpath: Option<String>,
    pub password_button_xpath: Option<String>,
    pub login_page_url: Option<String>,
    pub web_proxy_host_name: Option<String>,
    pub web_proxy_port_number: i32,
}

The parameters for a web crawler data source.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

web_crawler_auth_type: 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.

username_field_xpath: Option<String>

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

password_field_xpath: Option<String>

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

username_button_xpath: Option<String>

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

password_button_xpath: Option<String>

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

login_page_url: Option<String>

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

web_proxy_host_name: Option<String>

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

web_proxy_port_number: i32

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

Implementations

impl WebCrawlerParameters

pub fn web_crawler_auth_type(&self) -> &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.

pub fn username_field_xpath(&self) -> Option<&str>

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

pub fn password_field_xpath(&self) -> Option<&str>

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

pub fn username_button_xpath(&self) -> Option<&str>

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

pub fn password_button_xpath(&self) -> Option<&str>

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

pub fn login_page_url(&self) -> Option<&str>

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

pub fn web_proxy_host_name(&self) -> Option<&str>

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

pub fn web_proxy_port_number(&self) -> i32

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

impl WebCrawlerParameters

pub fn builder() -> WebCrawlerParametersBuilder

Creates a new builder-style object to manufacture WebCrawlerParameters.

Trait Implementations

impl Clone for WebCrawlerParameters

fn clone(&self) -> WebCrawlerParameters

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebCrawlerParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for WebCrawlerParameters

fn eq(&self, other: &WebCrawlerParameters) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WebCrawlerParameters