All Implemented Interfaces:


public final class AnthropicOkHttpClient.Builder

A builder for AnthropicOkHttpClient.

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 AnthropicOkHttpClient.Builder`	`dispatcherExecutorService(ExecutorService dispatcherExecutorService)`	The executor service to use for running HTTP requests.
`final AnthropicOkHttpClient.Builder`	`dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)`	Alias for calling Builder.dispatcherExecutorService with `dispatcherExecutorService.orElse(null)`.
`final AnthropicOkHttpClient.Builder`	`proxy(Proxy proxy)`
`final AnthropicOkHttpClient.Builder`	`proxy(Optional<Proxy> proxy)`	Alias for calling Builder.proxy with `proxy.orElse(null)`.
`final AnthropicOkHttpClient.Builder`	`maxIdleConnections(Integer maxIdleConnections)`	The maximum number of idle connections kept by the underlying OkHttp connection pool.
`final AnthropicOkHttpClient.Builder`	`maxIdleConnections(Integer maxIdleConnections)`	Alias for Builder.maxIdleConnections.
`final AnthropicOkHttpClient.Builder`	`maxIdleConnections(Optional<Integer> maxIdleConnections)`	Alias for calling Builder.maxIdleConnections with `maxIdleConnections.orElse(null)`.
`final AnthropicOkHttpClient.Builder`	`keepAliveDuration(Duration keepAliveDuration)`	The keep-alive duration for idle connections in the underlying OkHttp connection pool.
`final AnthropicOkHttpClient.Builder`	`keepAliveDuration(Optional<Duration> keepAliveDuration)`	Alias for calling Builder.keepAliveDuration with `keepAliveDuration.orElse(null)`.
`final AnthropicOkHttpClient.Builder`	`sslSocketFactory(SSLSocketFactory sslSocketFactory)`	The socket factory used to secure HTTPS connections.
`final AnthropicOkHttpClient.Builder`	`sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)`	Alias for calling Builder.sslSocketFactory with `sslSocketFactory.orElse(null)`.
`final AnthropicOkHttpClient.Builder`	`trustManager(X509TrustManager trustManager)`	The trust manager used to secure HTTPS connections.
`final AnthropicOkHttpClient.Builder`	`trustManager(Optional<X509TrustManager> trustManager)`	Alias for calling Builder.trustManager with `trustManager.orElse(null)`.
`final AnthropicOkHttpClient.Builder`	`hostnameVerifier(HostnameVerifier hostnameVerifier)`	The verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
`final AnthropicOkHttpClient.Builder`	`hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)`	Alias for calling Builder.hostnameVerifier with `hostnameVerifier.orElse(null)`.
`final AnthropicOkHttpClient.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 AnthropicOkHttpClient.Builder`	`jsonMapper(JsonMapper jsonMapper)`	The Jackson JSON mapper to use for serializing and deserializing JSON.
`final AnthropicOkHttpClient.Builder`	`streamHandlerExecutor(Executor streamHandlerExecutor)`	The executor to use for running AsyncStreamResponse.Handler callbacks.
`final AnthropicOkHttpClient.Builder`	`sleeper(Sleeper sleeper)`	The interface to use for delaying execution, like during retries.
`final AnthropicOkHttpClient.Builder`	`clock(Clock clock)`	The clock to use for operations that require timing, like retries.
`final AnthropicOkHttpClient.Builder`	`baseUrl(String baseUrl)`	The base URL to use for every request.
`final AnthropicOkHttpClient.Builder`	`baseUrl(Optional<String> baseUrl)`	Alias for calling Builder.baseUrl with `baseUrl.orElse(null)`.
`final AnthropicOkHttpClient.Builder`	`responseValidation(Boolean responseValidation)`	Whether to call `validate` on every response before returning it.
`final AnthropicOkHttpClient.Builder`	`timeout(Timeout timeout)`	Sets the maximum time allowed for various parts of an HTTP call's lifecycle, excluding retries.
`final AnthropicOkHttpClient.Builder`	`timeout(Duration timeout)`	Sets the maximum time allowed for a complete HTTP call, not including retries.
`final AnthropicOkHttpClient.Builder`	`maxRetries(Integer maxRetries)`	The maximum number of times to retry failed requests, with a short exponential backoff between requests.
`final AnthropicOkHttpClient.Builder`	`apiKey(String apiKey)`
`final AnthropicOkHttpClient.Builder`	`apiKey(Optional<String> apiKey)`	Alias for calling Builder.apiKey with `apiKey.orElse(null)`.
`final AnthropicOkHttpClient.Builder`	`authToken(String authToken)`
`final AnthropicOkHttpClient.Builder`	`authToken(Optional<String> authToken)`	Alias for calling Builder.authToken with `authToken.orElse(null)`.
`final AnthropicOkHttpClient.Builder`	`headers(Headers headers)`
`final AnthropicOkHttpClient.Builder`	`headers(Map<String, Iterable<String>> headers)`
`final AnthropicOkHttpClient.Builder`	`putHeader(String name, String value)`
`final AnthropicOkHttpClient.Builder`	`putHeaders(String name, Iterable<String> values)`
`final AnthropicOkHttpClient.Builder`	`putAllHeaders(Headers headers)`
`final AnthropicOkHttpClient.Builder`	`putAllHeaders(Map<String, Iterable<String>> headers)`
`final AnthropicOkHttpClient.Builder`	`replaceHeaders(String name, String value)`
`final AnthropicOkHttpClient.Builder`	`replaceHeaders(String name, Iterable<String> values)`
`final AnthropicOkHttpClient.Builder`	`replaceAllHeaders(Headers headers)`
`final AnthropicOkHttpClient.Builder`	`replaceAllHeaders(Map<String, Iterable<String>> headers)`
`final AnthropicOkHttpClient.Builder`	`removeHeaders(String name)`
`final AnthropicOkHttpClient.Builder`	`removeAllHeaders(Set<String> names)`
`final AnthropicOkHttpClient.Builder`	`queryParams(QueryParams queryParams)`
`final AnthropicOkHttpClient.Builder`	`queryParams(Map<String, Iterable<String>> queryParams)`
`final AnthropicOkHttpClient.Builder`	`putQueryParam(String key, String value)`
`final AnthropicOkHttpClient.Builder`	`putQueryParams(String key, Iterable<String> values)`
`final AnthropicOkHttpClient.Builder`	`putAllQueryParams(QueryParams queryParams)`
`final AnthropicOkHttpClient.Builder`	`putAllQueryParams(Map<String, Iterable<String>> queryParams)`
`final AnthropicOkHttpClient.Builder`	`replaceQueryParams(String key, String value)`
`final AnthropicOkHttpClient.Builder`	`replaceQueryParams(String key, Iterable<String> values)`
`final AnthropicOkHttpClient.Builder`	`replaceAllQueryParams(QueryParams queryParams)`
`final AnthropicOkHttpClient.Builder`	`replaceAllQueryParams(Map<String, Iterable<String>> queryParams)`
`final AnthropicOkHttpClient.Builder`	`removeQueryParams(String key)`
`final AnthropicOkHttpClient.Builder`	`removeAllQueryParams(Set<String> keys)`
`final AnthropicOkHttpClient.Builder`	`fromEnv()`	Updates configuration using system properties and environment variables.
`final AnthropicOkHttpClient.Builder`	`backend(Backend backend)`
`final AnthropicClient`	`build()`	Returns an immutable instance of AnthropicClient.

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

- Constructor Detail
- Method Detail
  - dispatcherExecutorService
```
 final AnthropicOkHttpClient.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 AnthropicOkHttpClient.Builder dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)
```
    Alias for calling Builder.dispatcherExecutorService with dispatcherExecutorService.orElse(null).
  - proxy
```
 final AnthropicOkHttpClient.Builder proxy(Proxy proxy)
```
  - proxy
```
 final AnthropicOkHttpClient.Builder proxy(Optional<Proxy> proxy)
```
    Alias for calling Builder.proxy with proxy.orElse(null).
  - maxIdleConnections
```
 final AnthropicOkHttpClient.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 AnthropicOkHttpClient.Builder maxIdleConnections(Integer maxIdleConnections)
```
    Alias for Builder.maxIdleConnections.
    This unboxed primitive overload exists for backwards compatibility.
  - maxIdleConnections
```
 final AnthropicOkHttpClient.Builder maxIdleConnections(Optional<Integer> maxIdleConnections)
```
    Alias for calling Builder.maxIdleConnections with maxIdleConnections.orElse(null).
  - keepAliveDuration
```
 final AnthropicOkHttpClient.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 AnthropicOkHttpClient.Builder keepAliveDuration(Optional<Duration> keepAliveDuration)
```
    Alias for calling Builder.keepAliveDuration with keepAliveDuration.orElse(null).
  - sslSocketFactory
```
 final AnthropicOkHttpClient.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 AnthropicOkHttpClient.Builder sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)
```
    Alias for calling Builder.sslSocketFactory with sslSocketFactory.orElse(null).
  - trustManager
```
 final AnthropicOkHttpClient.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 AnthropicOkHttpClient.Builder trustManager(Optional<X509TrustManager> trustManager)
```
    Alias for calling Builder.trustManager with trustManager.orElse(null).
  - hostnameVerifier
```
 final AnthropicOkHttpClient.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 AnthropicOkHttpClient.Builder hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)
```
    Alias for calling Builder.hostnameVerifier with hostnameVerifier.orElse(null).
  - checkJacksonVersionCompatibility
```
 final AnthropicOkHttpClient.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 AnthropicOkHttpClient.Builder jsonMapper(JsonMapper jsonMapper)
```
    The Jackson JSON mapper to use for serializing and deserializing JSON.
    Defaults to com.anthropic.core.jsonMapper. The default is usually sufficient and rarely needs to be overridden.
  - streamHandlerExecutor
```
 final AnthropicOkHttpClient.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 AnthropicOkHttpClient.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 AnthropicOkHttpClient.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 AnthropicOkHttpClient.Builder baseUrl(String baseUrl)
```
    The base URL to use for every request.
    Defaults to the production environment: https://api.anthropic.com.
  - baseUrl
```
 final AnthropicOkHttpClient.Builder baseUrl(Optional<String> baseUrl)
```
    Alias for calling Builder.baseUrl with baseUrl.orElse(null).
  - responseValidation
```
 final AnthropicOkHttpClient.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 AnthropicOkHttpClient.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 AnthropicOkHttpClient.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 AnthropicOkHttpClient.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.
  - apiKey
```
 final AnthropicOkHttpClient.Builder apiKey(String apiKey)
```
  - apiKey
```
 final AnthropicOkHttpClient.Builder apiKey(Optional<String> apiKey)
```
    Alias for calling Builder.apiKey with apiKey.orElse(null).
  - authToken
```
 final AnthropicOkHttpClient.Builder authToken(String authToken)
```
  - authToken
```
 final AnthropicOkHttpClient.Builder authToken(Optional<String> authToken)
```
    Alias for calling Builder.authToken with authToken.orElse(null).
  - headers
```
 final AnthropicOkHttpClient.Builder headers(Headers headers)
```
  - headers
```
 final AnthropicOkHttpClient.Builder headers(Map<String, Iterable<String>> headers)
```
  - putHeader
```
 final AnthropicOkHttpClient.Builder putHeader(String name, String value)
```
  - putHeaders
```
 final AnthropicOkHttpClient.Builder putHeaders(String name, Iterable<String> values)
```
  - putAllHeaders
```
 final AnthropicOkHttpClient.Builder putAllHeaders(Headers headers)
```
  - putAllHeaders
```
 final AnthropicOkHttpClient.Builder putAllHeaders(Map<String, Iterable<String>> headers)
```
  - replaceHeaders
```
 final AnthropicOkHttpClient.Builder replaceHeaders(String name, String value)
```
  - replaceHeaders
```
 final AnthropicOkHttpClient.Builder replaceHeaders(String name, Iterable<String> values)
```
  - replaceAllHeaders
```
 final AnthropicOkHttpClient.Builder replaceAllHeaders(Headers headers)
```
  - replaceAllHeaders
```
 final AnthropicOkHttpClient.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)
```
  - removeHeaders
```
 final AnthropicOkHttpClient.Builder removeHeaders(String name)
```
  - removeAllHeaders
```
 final AnthropicOkHttpClient.Builder removeAllHeaders(Set<String> names)
```
  - queryParams
```
 final AnthropicOkHttpClient.Builder queryParams(QueryParams queryParams)
```
  - queryParams
```
 final AnthropicOkHttpClient.Builder queryParams(Map<String, Iterable<String>> queryParams)
```
  - putQueryParam
```
 final AnthropicOkHttpClient.Builder putQueryParam(String key, String value)
```
  - putQueryParams
```
 final AnthropicOkHttpClient.Builder putQueryParams(String key, Iterable<String> values)
```
  - putAllQueryParams
```
 final AnthropicOkHttpClient.Builder putAllQueryParams(QueryParams queryParams)
```
  - putAllQueryParams
```
 final AnthropicOkHttpClient.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - replaceQueryParams
```
 final AnthropicOkHttpClient.Builder replaceQueryParams(String key, String value)
```
  - replaceQueryParams
```
 final AnthropicOkHttpClient.Builder replaceQueryParams(String key, Iterable<String> values)
```
  - replaceAllQueryParams
```
 final AnthropicOkHttpClient.Builder replaceAllQueryParams(QueryParams queryParams)
```
  - replaceAllQueryParams
```
 final AnthropicOkHttpClient.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - removeQueryParams
```
 final AnthropicOkHttpClient.Builder removeQueryParams(String key)
```
  - removeAllQueryParams
```
 final AnthropicOkHttpClient.Builder removeAllQueryParams(Set<String> keys)
```
  - fromEnv
```
 final AnthropicOkHttpClient.Builder fromEnv()
```
    Updates configuration using system properties and environment variables.
    See this table for the available options:
    System properties take precedence over environment variables.
  - backend
```
 final AnthropicOkHttpClient.Builder backend(Backend backend)
```
  - build
```
 final AnthropicClient build()
```
    Returns an immutable instance of AnthropicClient.
    Further updates to this Builder will not mutate the returned instance.

Class AnthropicOkHttpClient.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

maxIdleConnections

maxIdleConnections

maxIdleConnections

keepAliveDuration

keepAliveDuration

sslSocketFactory

sslSocketFactory

trustManager

trustManager

hostnameVerifier

hostnameVerifier

checkJacksonVersionCompatibility

jsonMapper

streamHandlerExecutor

sleeper

clock

baseUrl

baseUrl

responseValidation

timeout

timeout

maxRetries

apiKey

apiKey

authToken

authToken

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

backend

build