Constructor Detail

Method Detail

• proxy

   final HiddenLayerOkHttpClientAsync.Builder proxy(Proxy proxy)

• proxy

   final HiddenLayerOkHttpClientAsync.Builder proxy(Optional<Proxy> proxy)

  Alias for calling Builder.proxy with proxy.orElse(null).

• sslSocketFactory

   final HiddenLayerOkHttpClientAsync.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 HiddenLayerOkHttpClientAsync.Builder sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)

  Alias for calling Builder.sslSocketFactory with sslSocketFactory.orElse(null).

• trustManager

   final HiddenLayerOkHttpClientAsync.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 HiddenLayerOkHttpClientAsync.Builder trustManager(Optional<X509TrustManager> trustManager)

  Alias for calling Builder.trustManager with trustManager.orElse(null).

• hostnameVerifier

   final HiddenLayerOkHttpClientAsync.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 HiddenLayerOkHttpClientAsync.Builder hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)

  Alias for calling Builder.hostnameVerifier with hostnameVerifier.orElse(null).

• checkJacksonVersionCompatibility

   final HiddenLayerOkHttpClientAsync.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 HiddenLayerOkHttpClientAsync.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 HiddenLayerOkHttpClientAsync.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 HiddenLayerOkHttpClientAsync.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 HiddenLayerOkHttpClientAsync.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 HiddenLayerOkHttpClientAsync.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 HiddenLayerOkHttpClientAsync.Builder baseUrl(Optional<String> baseUrl)

  Alias for calling Builder.baseUrl with baseUrl.orElse(null).

• prodEu

   final HiddenLayerOkHttpClientAsync.Builder prodEu()

  Sets baseUrl to https://api.eu.hiddenlayer.ai.

• responseValidation

   final HiddenLayerOkHttpClientAsync.Builder responseValidation(Boolean responseValidation)

  Whether to call validate on every response before returning it.

  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 HiddenLayerOkHttpClientAsync.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 HiddenLayerOkHttpClientAsync.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 HiddenLayerOkHttpClientAsync.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.

• bearerToken

   final HiddenLayerOkHttpClientAsync.Builder bearerToken(String bearerToken)

• bearerToken

   final HiddenLayerOkHttpClientAsync.Builder bearerToken(Optional<String> bearerToken)

  Alias for calling Builder.bearerToken with bearerToken.orElse(null).

• clientId

   final HiddenLayerOkHttpClientAsync.Builder clientId(String clientId)

• clientId

   final HiddenLayerOkHttpClientAsync.Builder clientId(Optional<String> clientId)

  Alias for calling Builder.clientId with clientId.orElse(null).

• clientSecret

   final HiddenLayerOkHttpClientAsync.Builder clientSecret(String clientSecret)

• clientSecret

   final HiddenLayerOkHttpClientAsync.Builder clientSecret(Optional<String> clientSecret)

  Alias for calling Builder.clientSecret with clientSecret.orElse(null).

• headers

   final HiddenLayerOkHttpClientAsync.Builder headers(Headers headers)

• headers

   final HiddenLayerOkHttpClientAsync.Builder headers(Map<String, Iterable<String>> headers)

• putHeader

   final HiddenLayerOkHttpClientAsync.Builder putHeader(String name, String value)

• putHeaders

   final HiddenLayerOkHttpClientAsync.Builder putHeaders(String name, Iterable<String> values)

• putAllHeaders

   final HiddenLayerOkHttpClientAsync.Builder putAllHeaders(Headers headers)

• putAllHeaders

   final HiddenLayerOkHttpClientAsync.Builder putAllHeaders(Map<String, Iterable<String>> headers)

• replaceHeaders

   final HiddenLayerOkHttpClientAsync.Builder replaceHeaders(String name, String value)

• replaceHeaders

   final HiddenLayerOkHttpClientAsync.Builder replaceHeaders(String name, Iterable<String> values)

• replaceAllHeaders

   final HiddenLayerOkHttpClientAsync.Builder replaceAllHeaders(Headers headers)

• replaceAllHeaders

   final HiddenLayerOkHttpClientAsync.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)

• removeHeaders

   final HiddenLayerOkHttpClientAsync.Builder removeHeaders(String name)

• removeAllHeaders

   final HiddenLayerOkHttpClientAsync.Builder removeAllHeaders(Set<String> names)

• queryParams

   final HiddenLayerOkHttpClientAsync.Builder queryParams(QueryParams queryParams)

• queryParams

   final HiddenLayerOkHttpClientAsync.Builder queryParams(Map<String, Iterable<String>> queryParams)

• putQueryParam

   final HiddenLayerOkHttpClientAsync.Builder putQueryParam(String key, String value)

• putQueryParams

   final HiddenLayerOkHttpClientAsync.Builder putQueryParams(String key, Iterable<String> values)

• putAllQueryParams

   final HiddenLayerOkHttpClientAsync.Builder putAllQueryParams(QueryParams queryParams)

• putAllQueryParams

   final HiddenLayerOkHttpClientAsync.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)

• replaceQueryParams

   final HiddenLayerOkHttpClientAsync.Builder replaceQueryParams(String key, String value)

• replaceQueryParams

   final HiddenLayerOkHttpClientAsync.Builder replaceQueryParams(String key, Iterable<String> values)

• replaceAllQueryParams

   final HiddenLayerOkHttpClientAsync.Builder replaceAllQueryParams(QueryParams queryParams)

• replaceAllQueryParams

   final HiddenLayerOkHttpClientAsync.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)

• removeQueryParams

   final HiddenLayerOkHttpClientAsync.Builder removeQueryParams(String key)

• removeAllQueryParams

   final HiddenLayerOkHttpClientAsync.Builder removeAllQueryParams(Set<String> keys)

• fromEnv

   final HiddenLayerOkHttpClientAsync.Builder fromEnv()

  Updates configuration using system properties and environment variables.

• build

   final HiddenLayerClientAsync build()

  Returns an immutable instance of HiddenLayerClientAsync.

  Further updates to this Builder will not mutate the returned instance.