com.databricks.sdk.core.commons

Class CommonsHttpClient.Builder

java.lang.Object

com.databricks.sdk.core.commons.CommonsHttpClient.Builder

Enclosing class:

CommonsHttpClient

public static class CommonsHttpClient.Builder
extends Object

Builder for CommonsHttpClient. This class is used to construct instances of CommonsHttpClient with configurable parameters for the underlying Apache HttpClient.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CommonsHttpClient	build() Builds a new instance of CommonsHttpClient with the configured parameters.
CommonsHttpClient.Builder	withConnectionManager(org.apache.http.impl.conn.PoolingHttpClientConnectionManager connectionManager)
CommonsHttpClient.Builder	withDatabricksConfig(DatabricksConfig databricksConfig)
CommonsHttpClient.Builder	withProxyConfig(ProxyConfig proxyConfig)
CommonsHttpClient.Builder	withRequestConfig(org.apache.http.client.config.RequestConfig requestConfig)
CommonsHttpClient.Builder	withRequestRetryHandler(org.apache.http.client.HttpRequestRetryHandler requestRetryHandler)
CommonsHttpClient.Builder	withSslSocketFactory(org.apache.http.conn.ssl.SSLConnectionSocketFactory sslSocketFactory)
CommonsHttpClient.Builder	withTimeoutSeconds(int timeoutSeconds)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withDatabricksConfig

public CommonsHttpClient.Builder withDatabricksConfig(DatabricksConfig databricksConfig)

Parameters:

databricksConfig - The DatabricksConfig to use for the HttpClient. If the DatabricksConfig has an httpTimeoutSeconds set, it will be used as the default timeout for the HttpClient.

Returns:

This builder.

withTimeoutSeconds

public CommonsHttpClient.Builder withTimeoutSeconds(int timeoutSeconds)

Parameters:

timeoutSeconds - The timeout in seconds to use for the HttpClient. This will override any timeout set in the DatabricksConfig. Sets all three Apache HttpClient timeouts (connect, socket, connection request) to the same value. For fine-grained control, use withRequestConfig(RequestConfig) instead.

Returns:

This builder.

withRequestConfig

public CommonsHttpClient.Builder withRequestConfig(org.apache.http.client.config.RequestConfig requestConfig)

Parameters:

requestConfig - The Apache RequestConfig to use for the HttpClient. When set, this takes precedence over withTimeoutSeconds(int) and any timeout from DatabricksConfig.

Returns:

This builder.

withProxyConfig

public CommonsHttpClient.Builder withProxyConfig(ProxyConfig proxyConfig)

Parameters:

proxyConfig - the proxy configuration to use for the HttpClient.

Returns:

This builder.

withSslSocketFactory

public CommonsHttpClient.Builder withSslSocketFactory(org.apache.http.conn.ssl.SSLConnectionSocketFactory sslSocketFactory)

Parameters:

sslSocketFactory - the SSLConnectionSocketFactory to use for the HttpClient.

Returns:

This builder.

withConnectionManager

public CommonsHttpClient.Builder withConnectionManager(org.apache.http.impl.conn.PoolingHttpClientConnectionManager connectionManager)

Parameters:

connectionManager - the PoolingHttpClientConnectionManager to use for the HttpClient.

Returns:

This builder.

withRequestRetryHandler

public CommonsHttpClient.Builder withRequestRetryHandler(org.apache.http.client.HttpRequestRetryHandler requestRetryHandler)

Parameters:

requestRetryHandler - the HttpRequestRetryHandler to use for the HttpClient.

Returns:

This builder.

Note: This API is experimental and may change or be removed in future releases without notice.

build

public CommonsHttpClient build()

Builds a new instance of CommonsHttpClient with the configured parameters.