config.io_helidon_webclient_api_Proxy.adoc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-docs
There is a newer version: 4.1.4
///////////////////////////////////////////////////////////////////////////////

    Copyright (c) 2023 Oracle and/or its affiliates.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

///////////////////////////////////////////////////////////////////////////////

ifndef::rootdir[:rootdir: {docdir}/..]
:description: Configuration of io.helidon.webclient.api.Proxy
:keywords: helidon, config, io.helidon.webclient.api.Proxy
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.webclient.api.Proxy
include::{rootdir}/includes/attributes.adoc[]

= Proxy (webclient.api) Configuration

// tag::config[]


Type: link:{javadoc-base-url}/io.helidon.webclient.api/io/helidon/webclient/api/Proxy.html[io.helidon.webclient.api.Proxy]




== Configuration options



.Optional configuration options
[cols="3,3a,2,5a"]

|===
|key |type |default value |description

|`host` |string |{nbsp} |Sets a new host value.
|`no-proxy` |string[] |{nbsp} |Configure a host pattern that is not going through a proxy.

 Options are:

- IP Address, such as `192.168.1.1`
- IP V6 Address, such as `[2001:db8:85a3:8d3:1319:8a2e:370:7348]`
- Hostname, such as `localhost`
- Domain name, such as `helidon.io`
- Domain name and all sub-domains, such as `.helidon.io` (leading dot)
- Combination of all options from above with a port, such as `.helidon.io:80`


|`password` |string |{nbsp} |Sets a new password for the proxy.
|`port` |int |{nbsp} |Sets a port value.
|`type` |ProxyType (NONE, SYSTEM, HTTP) |`HTTP` |Sets a new proxy type.
|`username` |string |{nbsp} |Sets a new username for the proxy.

|===

// end::config[]