com.microsoft.azure.kusto.data.http

Class HttpClientProperties.HttpClientPropertiesBuilder

java.lang.Object

com.microsoft.azure.kusto.data.http.HttpClientProperties.HttpClientPropertiesBuilder

Enclosing class:

HttpClientProperties

public static class HttpClientProperties.HttpClientPropertiesBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
HttpClientPropertiesBuilder()

Method Summary

Modifier and Type	Method and Description
HttpClientProperties	build()
HttpClientProperties.HttpClientPropertiesBuilder	keepAlive(boolean keepAlive) Set whether or not a custom connection keep-alive time should be used.
HttpClientProperties.HttpClientPropertiesBuilder	maxConnectionsTotal(Integer maxConnectionsTotal) Sets the total maximum number of connections the client may keep open at the same time.
HttpClientProperties.HttpClientPropertiesBuilder	maxIdleTime(Integer maxIdleTime) Set the maximum time persistent connections can stay idle while kept alive in the connection pool.
HttpClientProperties.HttpClientPropertiesBuilder	provider(Class<? extends com.azure.core.http.HttpClientProvider> provider) Sets the HTTP Client Provider used by Azure Core when constructing HTTP Client instances.
HttpClientProperties.HttpClientPropertiesBuilder	proxy(com.azure.core.http.ProxyOptions proxy) Sets a proxy server to use for the client.
HttpClientProperties.HttpClientPropertiesBuilder	readTimeout(Integer readTimeout) Sets the amount of time between each response data read from the network before timing out.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpClientPropertiesBuilder

public HttpClientPropertiesBuilder()

Method Detail

maxIdleTime

public HttpClientProperties.HttpClientPropertiesBuilder maxIdleTime(Integer maxIdleTime)

Set the maximum time persistent connections can stay idle while kept alive in the connection pool. Connections whose inactivity period exceeds this value will get closed and evicted from the pool. Defaults to 120 seconds (2 minutes).

Parameters:

maxIdleTime - the maximum idle time expressed in seconds

Returns:

the builder instance

keepAlive

public HttpClientProperties.HttpClientPropertiesBuilder keepAlive(boolean keepAlive)

Set whether or not a custom connection keep-alive time should be used. If set to false, the HTTP client will use the default connection keep-alive strategy, which is to use only the server instructions (if any) set in the Keep-Alive response header. If set to true, the HTTP client will use a custom connection keep-alive strategy which uses the server instructions set in the Keep-Alive response header; if the response doesn't contain a

Parameters:

keepAlive - set to false to use a default keep-alive strategy or to true to use a custom one

Returns:

the builder instance

See Also:

Keep-Alive

readTimeout

public HttpClientProperties.HttpClientPropertiesBuilder readTimeout(Integer readTimeout)

Sets the amount of time between each response data read from the network before timing out. Defaults to 1 hour.

Parameters:

readTimeout - the maximum custom keep-alive time expressed in seconds

Returns:

the builder instance

See Also:

azure-core timouts

maxConnectionsTotal

public HttpClientProperties.HttpClientPropertiesBuilder maxConnectionsTotal(Integer maxConnectionsTotal)

Sets the total maximum number of connections the client may keep open at the same time.

Parameters:

maxConnectionsTotal - the total maximum number of connections

Returns:

the builder instance

provider

public HttpClientProperties.HttpClientPropertiesBuilder provider(Class<? extends com.azure.core.http.HttpClientProvider> provider)

Sets the HTTP Client Provider used by Azure Core when constructing HTTP Client instances.

Parameters:

provider - the requested HTTP Client provider class

Returns:

the builder instance

proxy

public HttpClientProperties.HttpClientPropertiesBuilder proxy(com.azure.core.http.ProxyOptions proxy)

Sets a proxy server to use for the client.

Parameters:

proxy - the proxy server

Returns:

the builder instance

build

public HttpClientProperties build()