ProxySettings

Proxy server connection settings including host, credentials, and scheme.

sharedJavadoc: ProxySettings

Notes

Configures an HTTP or HTTPS proxy through which the crawler routes outbound requests. Settings include the proxy host, port, authentication credentials, realm, and URL scheme, enabling the crawler to operate within networks that require a proxy for external access.

Usage

YAML

credentials:
  password: string
  passwordKey:
    size: 0
    source: KEY
    value: string
  username: string
host:
  name: string
  port: 0
realm: string
scheme: string

JSON

{
  "credentials": {
    "password": "string",
    "passwordKey": {
      "size": 0,
      "source": "KEY",
      "value": "string"
    },
    "username": "string"
  },
  "host": {
    "name": "string",
    "port": 0
  },
  "realm": "string",
  "scheme": "string"
}

XML

<proxySettings>
  <credentials>
    <password>string</password>
    <passwordKey>
      <size>0</size>
      <source>KEY</source>
      <value>string</value>
    </passwordKey>
    <username>string</username>
  </credentials>
  <host>
    <name>string</name>
    <port>0</port>
  </host>
  <realm>string</realm>
  <scheme>string</scheme>
</proxySettings>

Properties

Property	Type	Required	Default
credentials	Credentials	No	Credentials
host	Host	No	-
realm	string	No	-
scheme	string	No	-

Property Details

credentials

Username and password when required by the proxy.

host

Proxy host.

realm

Authentication realm name. Leave blank (default) to indicate "any realm".

scheme

Proxy URL scheme. Defaults to http.