All Implemented Interfaces:


public final class HiddenLayerOkHttpClient.Builder

A builder for HiddenLayerOkHttpClient.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final HiddenLayerOkHttpClient.Builder`	`dispatcherExecutorService(ExecutorService dispatcherExecutorService)`	The executor service to use for running HTTP requests.
`final HiddenLayerOkHttpClient.Builder`	`dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)`	Alias for calling Builder.dispatcherExecutorService with `dispatcherExecutorService.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`proxy(Proxy proxy)`
`final HiddenLayerOkHttpClient.Builder`	`proxy(Optional<Proxy> proxy)`	Alias for calling Builder.proxy with `proxy.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`proxyAuthenticator(ProxyAuthenticator proxyAuthenticator)`	Provides credentials when an HTTP proxy responds with `407 Proxy Authentication Required`.
`final HiddenLayerOkHttpClient.Builder`	`proxyAuthenticator(Optional<ProxyAuthenticator> proxyAuthenticator)`	Alias for calling Builder.proxyAuthenticator with `proxyAuthenticator.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`maxIdleConnections(Integer maxIdleConnections)`	The maximum number of idle connections kept by the underlying OkHttp connection pool.
`final HiddenLayerOkHttpClient.Builder`	`maxIdleConnections(Integer maxIdleConnections)`	Alias for Builder.maxIdleConnections.
`final HiddenLayerOkHttpClient.Builder`	`maxIdleConnections(Optional<Integer> maxIdleConnections)`	Alias for calling Builder.maxIdleConnections with `maxIdleConnections.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`keepAliveDuration(Duration keepAliveDuration)`	The keep-alive duration for idle connections in the underlying OkHttp connection pool.
`final HiddenLayerOkHttpClient.Builder`	`keepAliveDuration(Optional<Duration> keepAliveDuration)`	Alias for calling Builder.keepAliveDuration with `keepAliveDuration.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`sslSocketFactory(SSLSocketFactory sslSocketFactory)`	The socket factory used to secure HTTPS connections.
`final HiddenLayerOkHttpClient.Builder`	`sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)`	Alias for calling Builder.sslSocketFactory with `sslSocketFactory.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`trustManager(X509TrustManager trustManager)`	The trust manager used to secure HTTPS connections.
`final HiddenLayerOkHttpClient.Builder`	`trustManager(Optional<X509TrustManager> trustManager)`	Alias for calling Builder.trustManager with `trustManager.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`hostnameVerifier(HostnameVerifier hostnameVerifier)`	The verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
`final HiddenLayerOkHttpClient.Builder`	`hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)`	Alias for calling Builder.hostnameVerifier with `hostnameVerifier.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`checkJacksonVersionCompatibility(Boolean checkJacksonVersionCompatibility)`	Whether to throw an exception if any of the Jackson versions detected at runtime are incompatible with the SDK's minimum supported Jackson version (2.13.4).
`final HiddenLayerOkHttpClient.Builder`	`jsonMapper(JsonMapper jsonMapper)`	The Jackson JSON mapper to use for serializing and deserializing JSON.
`final HiddenLayerOkHttpClient.Builder`	`streamHandlerExecutor(Executor streamHandlerExecutor)`	The executor to use for running AsyncStreamResponse.Handler callbacks.
`final HiddenLayerOkHttpClient.Builder`	`sleeper(Sleeper sleeper)`	The interface to use for delaying execution, like during retries.
`final HiddenLayerOkHttpClient.Builder`	`clock(Clock clock)`	The clock to use for operations that require timing, like retries.
`final HiddenLayerOkHttpClient.Builder`	`baseUrl(String baseUrl)`	The base URL to use for every request.
`final HiddenLayerOkHttpClient.Builder`	`baseUrl(Optional<String> baseUrl)`	Alias for calling Builder.baseUrl with `baseUrl.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`prodEu()`	Sets baseUrl to `https://api.eu.hiddenlayer.ai`.
`final HiddenLayerOkHttpClient.Builder`	`responseValidation(Boolean responseValidation)`	Whether to call `validate` on every response before returning it.
`final HiddenLayerOkHttpClient.Builder`	`timeout(Timeout timeout)`	Sets the maximum time allowed for various parts of an HTTP call's lifecycle, excluding retries.
`final HiddenLayerOkHttpClient.Builder`	`timeout(Duration timeout)`	Sets the maximum time allowed for a complete HTTP call, not including retries.
`final HiddenLayerOkHttpClient.Builder`	`maxRetries(Integer maxRetries)`	The maximum number of times to retry failed requests, with a short exponential backoff between requests.
`final HiddenLayerOkHttpClient.Builder`	`logLevel(LogLevel logLevel)`	The level at which to log request and response information.
`final HiddenLayerOkHttpClient.Builder`	`bearerToken(String bearerToken)`
`final HiddenLayerOkHttpClient.Builder`	`bearerToken(Optional<String> bearerToken)`	Alias for calling Builder.bearerToken with `bearerToken.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`clientId(String clientId)`
`final HiddenLayerOkHttpClient.Builder`	`clientId(Optional<String> clientId)`	Alias for calling Builder.clientId with `clientId.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`clientSecret(String clientSecret)`
`final HiddenLayerOkHttpClient.Builder`	`clientSecret(Optional<String> clientSecret)`	Alias for calling Builder.clientSecret with `clientSecret.orElse(null)`.
`final HiddenLayerOkHttpClient.Builder`	`headers(Headers headers)`
`final HiddenLayerOkHttpClient.Builder`	`headers(Map<String, Iterable<String>> headers)`
`final HiddenLayerOkHttpClient.Builder`	`putHeader(String name, String value)`
`final HiddenLayerOkHttpClient.Builder`	`putHeaders(String name, Iterable<String> values)`
`final HiddenLayerOkHttpClient.Builder`	`putAllHeaders(Headers headers)`
`final HiddenLayerOkHttpClient.Builder`	`putAllHeaders(Map<String, Iterable<String>> headers)`
`final HiddenLayerOkHttpClient.Builder`	`replaceHeaders(String name, String value)`
`final HiddenLayerOkHttpClient.Builder`	`replaceHeaders(String name, Iterable<String> values)`
`final HiddenLayerOkHttpClient.Builder`	`replaceAllHeaders(Headers headers)`
`final HiddenLayerOkHttpClient.Builder`	`replaceAllHeaders(Map<String, Iterable<String>> headers)`
`final HiddenLayerOkHttpClient.Builder`	`removeHeaders(String name)`
`final HiddenLayerOkHttpClient.Builder`	`removeAllHeaders(Set<String> names)`
`final HiddenLayerOkHttpClient.Builder`	`queryParams(QueryParams queryParams)`
`final HiddenLayerOkHttpClient.Builder`	`queryParams(Map<String, Iterable<String>> queryParams)`
`final HiddenLayerOkHttpClient.Builder`	`putQueryParam(String key, String value)`
`final HiddenLayerOkHttpClient.Builder`	`putQueryParams(String key, Iterable<String> values)`
`final HiddenLayerOkHttpClient.Builder`	`putAllQueryParams(QueryParams queryParams)`
`final HiddenLayerOkHttpClient.Builder`	`putAllQueryParams(Map<String, Iterable<String>> queryParams)`
`final HiddenLayerOkHttpClient.Builder`	`replaceQueryParams(String key, String value)`
`final HiddenLayerOkHttpClient.Builder`	`replaceQueryParams(String key, Iterable<String> values)`
`final HiddenLayerOkHttpClient.Builder`	`replaceAllQueryParams(QueryParams queryParams)`
`final HiddenLayerOkHttpClient.Builder`	`replaceAllQueryParams(Map<String, Iterable<String>> queryParams)`
`final HiddenLayerOkHttpClient.Builder`	`removeQueryParams(String key)`
`final HiddenLayerOkHttpClient.Builder`	`removeAllQueryParams(Set<String> keys)`
`final HiddenLayerOkHttpClient.Builder`	`fromEnv()`	Updates configuration using system properties and environment variables.
`final HiddenLayerClient`	`build()`	Returns an immutable instance of HiddenLayerClient.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - dispatcherExecutorService
```
 final HiddenLayerOkHttpClient.Builder dispatcherExecutorService(ExecutorService dispatcherExecutorService)
```
    The executor service to use for running HTTP requests.
    Defaults to OkHttp's default executor service.
    This class takes ownership of the executor service and shuts it down when closed.
  - dispatcherExecutorService
```
 final HiddenLayerOkHttpClient.Builder dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)
```
    Alias for calling Builder.dispatcherExecutorService with dispatcherExecutorService.orElse(null).
  - proxy
```
 final HiddenLayerOkHttpClient.Builder proxy(Proxy proxy)
```
  - proxy
```
 final HiddenLayerOkHttpClient.Builder proxy(Optional<Proxy> proxy)
```
    Alias for calling Builder.proxy with proxy.orElse(null).
  - proxyAuthenticator
```
 final HiddenLayerOkHttpClient.Builder proxyAuthenticator(ProxyAuthenticator proxyAuthenticator)
```
    Provides credentials when an HTTP proxy responds with 407 Proxy Authentication Required.
  - proxyAuthenticator
```
 final HiddenLayerOkHttpClient.Builder proxyAuthenticator(Optional<ProxyAuthenticator> proxyAuthenticator)
```
    Alias for calling Builder.proxyAuthenticator with proxyAuthenticator.orElse(null).
  - maxIdleConnections
```
 final HiddenLayerOkHttpClient.Builder maxIdleConnections(Integer maxIdleConnections)
```
    The maximum number of idle connections kept by the underlying OkHttp connection pool.
    If this is set, then keepAliveDuration must also be set.
    If unset, then OkHttp's default is used.
  - maxIdleConnections
```
 final HiddenLayerOkHttpClient.Builder maxIdleConnections(Integer maxIdleConnections)
```
    Alias for Builder.maxIdleConnections.
    This unboxed primitive overload exists for backwards compatibility.
  - maxIdleConnections
```
 final HiddenLayerOkHttpClient.Builder maxIdleConnections(Optional<Integer> maxIdleConnections)
```
    Alias for calling Builder.maxIdleConnections with maxIdleConnections.orElse(null).
  - keepAliveDuration
```
 final HiddenLayerOkHttpClient.Builder keepAliveDuration(Duration keepAliveDuration)
```
    The keep-alive duration for idle connections in the underlying OkHttp connection pool.
    If this is set, then maxIdleConnections must also be set.
    If unset, then OkHttp's default is used.
  - keepAliveDuration
```
 final HiddenLayerOkHttpClient.Builder keepAliveDuration(Optional<Duration> keepAliveDuration)
```
    Alias for calling Builder.keepAliveDuration with keepAliveDuration.orElse(null).
  - sslSocketFactory
```
 final HiddenLayerOkHttpClient.Builder sslSocketFactory(SSLSocketFactory sslSocketFactory)
```
    The socket factory used to secure HTTPS connections.
    If this is set, then trustManager must also be set.
    If unset, then the system default is used. Most applications should not call this method, and instead use the system default. The default include special optimizations that can be lost if the implementation is modified.
  - sslSocketFactory
```
 final HiddenLayerOkHttpClient.Builder sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)
```
    Alias for calling Builder.sslSocketFactory with sslSocketFactory.orElse(null).
  - trustManager
```
 final HiddenLayerOkHttpClient.Builder trustManager(X509TrustManager trustManager)
```
    The trust manager used to secure HTTPS connections.
    If this is set, then sslSocketFactory must also be set.
    If unset, then the system default is used. Most applications should not call this method, and instead use the system default. The default include special optimizations that can be lost if the implementation is modified.
  - trustManager
```
 final HiddenLayerOkHttpClient.Builder trustManager(Optional<X509TrustManager> trustManager)
```
    Alias for calling Builder.trustManager with trustManager.orElse(null).
  - hostnameVerifier
```
 final HiddenLayerOkHttpClient.Builder hostnameVerifier(HostnameVerifier hostnameVerifier)
```
    The verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
    If unset, then a default hostname verifier is used.
  - hostnameVerifier
```
 final HiddenLayerOkHttpClient.Builder hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)
```
    Alias for calling Builder.hostnameVerifier with hostnameVerifier.orElse(null).
  - checkJacksonVersionCompatibility
```
 final HiddenLayerOkHttpClient.Builder checkJacksonVersionCompatibility(Boolean checkJacksonVersionCompatibility)
```
    Whether to throw an exception if any of the Jackson versions detected at runtime are incompatible with the SDK's minimum supported Jackson version (2.13.4).
    Defaults to true. Use extreme caution when disabling this option. There is no guarantee that the SDK will work correctly when using an incompatible Jackson version.
  - jsonMapper
```
 final HiddenLayerOkHttpClient.Builder jsonMapper(JsonMapper jsonMapper)
```
    The Jackson JSON mapper to use for serializing and deserializing JSON.
    Defaults to com.hiddenlayer.api.core.jsonMapper. The default is usually sufficient and rarely needs to be overridden.
  - streamHandlerExecutor
```
 final HiddenLayerOkHttpClient.Builder streamHandlerExecutor(Executor streamHandlerExecutor)
```
    The executor to use for running AsyncStreamResponse.Handler callbacks.
    Defaults to a dedicated cached thread pool.
    This class takes ownership of the executor and shuts it down, if possible, when closed.
  - sleeper
```
 final HiddenLayerOkHttpClient.Builder sleeper(Sleeper sleeper)
```
    The interface to use for delaying execution, like during retries.
    This is primarily useful for using fake delays in tests.
    Defaults to real execution delays.
    This class takes ownership of the sleeper and closes it when closed.
  - clock
```
 final HiddenLayerOkHttpClient.Builder clock(Clock clock)
```
    The clock to use for operations that require timing, like retries.
    This is primarily useful for using a fake clock in tests.
    Defaults to Clock.systemUTC.
  - baseUrl
```
 final HiddenLayerOkHttpClient.Builder baseUrl(String baseUrl)
```
    The base URL to use for every request.
    Defaults to the prod-us environment: https://api.hiddenlayer.ai.
    The following other environments, with dedicated builder methods, are available:
    prod-eu: https://api.eu.hiddenlayer.ai
  - baseUrl
```
 final HiddenLayerOkHttpClient.Builder baseUrl(Optional<String> baseUrl)
```
    Alias for calling Builder.baseUrl with baseUrl.orElse(null).
  - prodEu
```
 final HiddenLayerOkHttpClient.Builder prodEu()
```
    Sets baseUrl to https://api.eu.hiddenlayer.ai.
  - responseValidation
```
 final HiddenLayerOkHttpClient.Builder responseValidation(Boolean responseValidation)
```
    Whether to call validate on every response before returning it.
    Setting this to true is not forwards compatible with new types from the API for existing fields.
    Defaults to false, which means the shape of the response will not be validated upfront. Instead, validation will only occur for the parts of the response that are accessed.
  - timeout
```
 final HiddenLayerOkHttpClient.Builder timeout(Timeout timeout)
```
    Sets the maximum time allowed for various parts of an HTTP call's lifecycle, excluding retries.
    Defaults to Timeout.default.
  - timeout
```
 final HiddenLayerOkHttpClient.Builder timeout(Duration timeout)
```
    Sets the maximum time allowed for a complete HTTP call, not including retries.
    See Timeout.request for more details.
    For fine-grained control, pass a Timeout object.
  - maxRetries
```
 final HiddenLayerOkHttpClient.Builder maxRetries(Integer maxRetries)
```
    The maximum number of times to retry failed requests, with a short exponential backoff between requests.
    Only the following error types are retried:
    Connection errors (for example, due to a network connectivity problem)
    408 Request Timeout
    409 Conflict
    429 Rate Limit
    5xx Internal
    The API may also explicitly instruct the SDK to retry or not retry a request.
    Defaults to 2.
  - logLevel
```
 final HiddenLayerOkHttpClient.Builder logLevel(LogLevel logLevel)
```
    The level at which to log request and response information.
    fromEnv will set the level from environment variables. See LogLevel.fromEnv.
    Defaults to LogLevel.fromEnv.
  - bearerToken
```
 final HiddenLayerOkHttpClient.Builder bearerToken(String bearerToken)
```
  - bearerToken
```
 final HiddenLayerOkHttpClient.Builder bearerToken(Optional<String> bearerToken)
```
    Alias for calling Builder.bearerToken with bearerToken.orElse(null).
  - clientId
```
 final HiddenLayerOkHttpClient.Builder clientId(String clientId)
```
  - clientId
```
 final HiddenLayerOkHttpClient.Builder clientId(Optional<String> clientId)
```
    Alias for calling Builder.clientId with clientId.orElse(null).
  - clientSecret
```
 final HiddenLayerOkHttpClient.Builder clientSecret(String clientSecret)
```
  - clientSecret
```
 final HiddenLayerOkHttpClient.Builder clientSecret(Optional<String> clientSecret)
```
    Alias for calling Builder.clientSecret with clientSecret.orElse(null).
  - headers
```
 final HiddenLayerOkHttpClient.Builder headers(Headers headers)
```
  - headers
```
 final HiddenLayerOkHttpClient.Builder headers(Map<String, Iterable<String>> headers)
```
  - putHeader
```
 final HiddenLayerOkHttpClient.Builder putHeader(String name, String value)
```
  - putHeaders
```
 final HiddenLayerOkHttpClient.Builder putHeaders(String name, Iterable<String> values)
```
  - putAllHeaders
```
 final HiddenLayerOkHttpClient.Builder putAllHeaders(Headers headers)
```
  - putAllHeaders
```
 final HiddenLayerOkHttpClient.Builder putAllHeaders(Map<String, Iterable<String>> headers)
```
  - replaceHeaders
```
 final HiddenLayerOkHttpClient.Builder replaceHeaders(String name, String value)
```
  - replaceHeaders
```
 final HiddenLayerOkHttpClient.Builder replaceHeaders(String name, Iterable<String> values)
```
  - replaceAllHeaders
```
 final HiddenLayerOkHttpClient.Builder replaceAllHeaders(Headers headers)
```
  - replaceAllHeaders
```
 final HiddenLayerOkHttpClient.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)
```
  - removeHeaders
```
 final HiddenLayerOkHttpClient.Builder removeHeaders(String name)
```
  - removeAllHeaders
```
 final HiddenLayerOkHttpClient.Builder removeAllHeaders(Set<String> names)
```
  - queryParams
```
 final HiddenLayerOkHttpClient.Builder queryParams(QueryParams queryParams)
```
  - queryParams
```
 final HiddenLayerOkHttpClient.Builder queryParams(Map<String, Iterable<String>> queryParams)
```
  - putQueryParam
```
 final HiddenLayerOkHttpClient.Builder putQueryParam(String key, String value)
```
  - putQueryParams
```
 final HiddenLayerOkHttpClient.Builder putQueryParams(String key, Iterable<String> values)
```
  - putAllQueryParams
```
 final HiddenLayerOkHttpClient.Builder putAllQueryParams(QueryParams queryParams)
```
  - putAllQueryParams
```
 final HiddenLayerOkHttpClient.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - replaceQueryParams
```
 final HiddenLayerOkHttpClient.Builder replaceQueryParams(String key, String value)
```
  - replaceQueryParams
```
 final HiddenLayerOkHttpClient.Builder replaceQueryParams(String key, Iterable<String> values)
```
  - replaceAllQueryParams
```
 final HiddenLayerOkHttpClient.Builder replaceAllQueryParams(QueryParams queryParams)
```
  - replaceAllQueryParams
```
 final HiddenLayerOkHttpClient.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - removeQueryParams
```
 final HiddenLayerOkHttpClient.Builder removeQueryParams(String key)
```
  - removeAllQueryParams
```
 final HiddenLayerOkHttpClient.Builder removeAllQueryParams(Set<String> keys)
```
  - fromEnv
```
 final HiddenLayerOkHttpClient.Builder fromEnv()
```
    Updates configuration using system properties and environment variables.
  - build
```
 final HiddenLayerClient build()
```
    Returns an immutable instance of HiddenLayerClient.
    Further updates to this Builder will not mutate the returned instance.

Class HiddenLayerOkHttpClient.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

dispatcherExecutorService

dispatcherExecutorService

proxy

proxy

proxyAuthenticator

proxyAuthenticator

maxIdleConnections

maxIdleConnections

maxIdleConnections

keepAliveDuration

keepAliveDuration

sslSocketFactory

sslSocketFactory

trustManager

trustManager

hostnameVerifier

hostnameVerifier

checkJacksonVersionCompatibility

jsonMapper

streamHandlerExecutor

sleeper

clock

baseUrl

baseUrl

prodEu

responseValidation

timeout

timeout

maxRetries

logLevel

bearerToken

bearerToken

clientId

clientId

clientSecret

clientSecret

headers

headers

putHeader

putHeaders

putAllHeaders

putAllHeaders

replaceHeaders

replaceHeaders

replaceAllHeaders

replaceAllHeaders

removeHeaders

removeAllHeaders

queryParams

queryParams

putQueryParam

putQueryParams

putAllQueryParams

putAllQueryParams

replaceQueryParams

replaceQueryParams

replaceAllQueryParams

replaceAllQueryParams

removeQueryParams

removeAllQueryParams

fromEnv

build