string

Base uri used by the client in all requests.

@return base uri of the client requests

Duration

Connect timeout.

@return connect timeout
@see io.helidon.common.socket.SocketOptions#connectTimeout()

int

Maximal size of the connection cache. For most HTTP protocols, we may cache connections to various endpoints for keep alive (or stream reuse in case of HTTP/2). This option limits the size. Setting this number lower than the "usual" number of target services will cause connections to be closed and reopened frequently.

ContentEncodingContext

Configure the listener specific io.helidon.http.encoding.ContentEncodingContext. This method discards all previously registered ContentEncodingContext. If no content encoding context is registered, default encoding context is used.

@return content encoding context

WebClientCookieManager

WebClient cookie manager.

@return cookie manager to use

Map<string, string>

Default headers to be used in every request from configuration.

@return default headers

boolean

Whether to follow redirects.

@return whether to follow redirects

boolean

Determines if connection keep alive is enabled (NOT socket keep alive, but HTTP connection keep alive, to re-use the same connection for multiple requests).

@return keep alive for this connection
@see io.helidon.common.socket.SocketOptions#socketKeepAlive()

int

If the entity is expected to be smaller that this number of bytes, it would be buffered in memory to optimize performance. If bigger, streaming will be used.

Note that for some entity types we cannot use streaming, as they are already fully in memory (String, byte[]), for such
cases, this option is ignored. Default is 128Kb.

@return maximal number of bytes to buffer in memory for supported writers

int

Max number of followed redirects. This is ignored if #followRedirects() option is false.

@return max number of followed redirects

MediaContext

Configure the listener specific io.helidon.http.media.MediaContext. This method discards all previously registered MediaContext. If no media context is registered, default media context is used.

@return media context

ParserMode (STRICT, RELAXED)

Configure media type parsing mode for HTTP Content-Type header.

@return media type parsing mode

Map<string, string>

Properties configured for this client. These properties are propagated through client request, to be used by services (and possibly for other purposes).

@return map of client properties

io.helidon.webclient.spi.ProtocolConfig[] (service provider interface)

Configuration of client protocols.

@return client protocol configurations

Proxy

Proxy configuration to be used for requests.

@return proxy to use, defaults to Proxy#noProxy()

Duration

Socket 100-Continue read timeout. Default is 1 second. This read timeout is used when 100-Continue is sent by the client, before it sends an entity.

@return read 100-Continue timeout duration

Duration

Read timeout.

@return read timeout
@see io.helidon.common.socket.SocketOptions#readTimeout()

boolean

Can be set to true to force the use of relative URIs in all requests, regardless of the presence or absence of proxies or no-proxy lists.

@return relative URIs flag

boolean

Whether Expect-100-Continue header is sent to verify server availability before sending an entity.

Defaults to `true`.

@return whether Expect:100-Continue header should be sent on streamed transfers

io.helidon.webclient.spi.WebClientService[] (service provider interface)

WebClient services.

@return services to use with this web client

boolean

Whether to share connection cache between all the WebClient instances in JVM.

@return true if connection cache is shared

SocketOptions

Socket options for connections opened by this client. If there is a value explicitly configured on this type and on the socket options, the one configured on this type’s builder will win:

• #readTimeout()

• #connectTimeout()

@return socket options

Tls

TLS configuration for any TLS request from this client. TLS can also be configured per request. TLS is used when the protocol is set to https.

@return TLS configuration to use