All Implemented Interfaces:


public final class StagehandOkHttpClientAsync.Builder

A builder for StagehandOkHttpClientAsync.

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

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

- Constructor Detail
- Method Detail
  - dispatcherExecutorService
```
 final StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.Builder dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)
```
    Alias for calling Builder.dispatcherExecutorService with dispatcherExecutorService.orElse(null).
  - proxy
```
 final StagehandOkHttpClientAsync.Builder proxy(Proxy proxy)
```
  - proxy
```
 final StagehandOkHttpClientAsync.Builder proxy(Optional<Proxy> proxy)
```
    Alias for calling Builder.proxy with proxy.orElse(null).
  - proxyAuthenticator
```
 final StagehandOkHttpClientAsync.Builder proxyAuthenticator(ProxyAuthenticator proxyAuthenticator)
```
    Provides credentials when an HTTP proxy responds with 407 Proxy Authentication Required.
  - proxyAuthenticator
```
 final StagehandOkHttpClientAsync.Builder proxyAuthenticator(Optional<ProxyAuthenticator> proxyAuthenticator)
```
    Alias for calling Builder.proxyAuthenticator with proxyAuthenticator.orElse(null).
  - maxIdleConnections
```
 final StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.Builder maxIdleConnections(Integer maxIdleConnections)
```
    Alias for Builder.maxIdleConnections.
    This unboxed primitive overload exists for backwards compatibility.
  - maxIdleConnections
```
 final StagehandOkHttpClientAsync.Builder maxIdleConnections(Optional<Integer> maxIdleConnections)
```
    Alias for calling Builder.maxIdleConnections with maxIdleConnections.orElse(null).
  - keepAliveDuration
```
 final StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.Builder keepAliveDuration(Optional<Duration> keepAliveDuration)
```
    Alias for calling Builder.keepAliveDuration with keepAliveDuration.orElse(null).
  - sslSocketFactory
```
 final StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.Builder sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)
```
    Alias for calling Builder.sslSocketFactory with sslSocketFactory.orElse(null).
  - trustManager
```
 final StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.Builder trustManager(Optional<X509TrustManager> trustManager)
```
    Alias for calling Builder.trustManager with trustManager.orElse(null).
  - hostnameVerifier
```
 final StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.Builder hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)
```
    Alias for calling Builder.hostnameVerifier with hostnameVerifier.orElse(null).
  - checkJacksonVersionCompatibility
```
 final StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.Builder jsonMapper(JsonMapper jsonMapper)
```
    The Jackson JSON mapper to use for serializing and deserializing JSON.
    Defaults to com.browserbase.api.core.jsonMapper. The default is usually sufficient and rarely needs to be overridden.
  - streamHandlerExecutor
```
 final StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.Builder baseUrl(String baseUrl)
```
    The base URL to use for every request.
    Defaults to the production environment: https://api.stagehand.browserbase.com.
  - baseUrl
```
 final StagehandOkHttpClientAsync.Builder baseUrl(Optional<String> baseUrl)
```
    Alias for calling Builder.baseUrl with baseUrl.orElse(null).
  - responseValidation
```
 final StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.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 StagehandOkHttpClientAsync.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.
  - browserbaseApiKey
```
 final StagehandOkHttpClientAsync.Builder browserbaseApiKey(String browserbaseApiKey)
```
    Your Browserbase API Key
  - browserbaseProjectId
```
 final StagehandOkHttpClientAsync.Builder browserbaseProjectId(String browserbaseProjectId)
```
    Deprecated. Browserbase API keys are now project-scoped, so this value is no longer required.
  - browserbaseProjectId
```
 final StagehandOkHttpClientAsync.Builder browserbaseProjectId(Optional<String> browserbaseProjectId)
```
    Alias for calling Builder.browserbaseProjectId with browserbaseProjectId.orElse(null).
  - modelApiKey
```
 final StagehandOkHttpClientAsync.Builder modelApiKey(String modelApiKey)
```
    Your LLM provider API key (e.g. OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.)
  - headers
```
 final StagehandOkHttpClientAsync.Builder headers(Headers headers)
```
  - headers
```
 final StagehandOkHttpClientAsync.Builder headers(Map<String, Iterable<String>> headers)
```
  - putHeader
```
 final StagehandOkHttpClientAsync.Builder putHeader(String name, String value)
```
  - putHeaders
```
 final StagehandOkHttpClientAsync.Builder putHeaders(String name, Iterable<String> values)
```
  - putAllHeaders
```
 final StagehandOkHttpClientAsync.Builder putAllHeaders(Headers headers)
```
  - putAllHeaders
```
 final StagehandOkHttpClientAsync.Builder putAllHeaders(Map<String, Iterable<String>> headers)
```
  - replaceHeaders
```
 final StagehandOkHttpClientAsync.Builder replaceHeaders(String name, String value)
```
  - replaceHeaders
```
 final StagehandOkHttpClientAsync.Builder replaceHeaders(String name, Iterable<String> values)
```
  - replaceAllHeaders
```
 final StagehandOkHttpClientAsync.Builder replaceAllHeaders(Headers headers)
```
  - replaceAllHeaders
```
 final StagehandOkHttpClientAsync.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)
```
  - removeHeaders
```
 final StagehandOkHttpClientAsync.Builder removeHeaders(String name)
```
  - removeAllHeaders
```
 final StagehandOkHttpClientAsync.Builder removeAllHeaders(Set<String> names)
```
  - queryParams
```
 final StagehandOkHttpClientAsync.Builder queryParams(QueryParams queryParams)
```
  - queryParams
```
 final StagehandOkHttpClientAsync.Builder queryParams(Map<String, Iterable<String>> queryParams)
```
  - putQueryParam
```
 final StagehandOkHttpClientAsync.Builder putQueryParam(String key, String value)
```
  - putQueryParams
```
 final StagehandOkHttpClientAsync.Builder putQueryParams(String key, Iterable<String> values)
```
  - putAllQueryParams
```
 final StagehandOkHttpClientAsync.Builder putAllQueryParams(QueryParams queryParams)
```
  - putAllQueryParams
```
 final StagehandOkHttpClientAsync.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - replaceQueryParams
```
 final StagehandOkHttpClientAsync.Builder replaceQueryParams(String key, String value)
```
  - replaceQueryParams
```
 final StagehandOkHttpClientAsync.Builder replaceQueryParams(String key, Iterable<String> values)
```
  - replaceAllQueryParams
```
 final StagehandOkHttpClientAsync.Builder replaceAllQueryParams(QueryParams queryParams)
```
  - replaceAllQueryParams
```
 final StagehandOkHttpClientAsync.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - removeQueryParams
```
 final StagehandOkHttpClientAsync.Builder removeQueryParams(String key)
```
  - removeAllQueryParams
```
 final StagehandOkHttpClientAsync.Builder removeAllQueryParams(Set<String> keys)
```
  - fromEnv
```
 final StagehandOkHttpClientAsync.Builder fromEnv()
```
    Updates configuration using system properties and environment variables.
  - build
```
 final StagehandClientAsync build()
```
    Returns an immutable instance of StagehandClientAsync.
    Further updates to this Builder will not mutate the returned instance.

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

responseValidation

timeout

timeout

maxRetries

browserbaseApiKey

browserbaseProjectId

browserbaseProjectId

modelApiKey

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