All Implemented Interfaces:


public final class StagehandOkHttpClient.Builder

A builder for StagehandOkHttpClient.

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

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

- Constructor Detail
- Method Detail
  - dispatcherExecutorService
```
 final StagehandOkHttpClient.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 StagehandOkHttpClient.Builder dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)
```
    Alias for calling Builder.dispatcherExecutorService with dispatcherExecutorService.orElse(null).
  - proxy
```
 final StagehandOkHttpClient.Builder proxy(Proxy proxy)
```
  - proxy
```
 final StagehandOkHttpClient.Builder proxy(Optional<Proxy> proxy)
```
    Alias for calling Builder.proxy with proxy.orElse(null).
  - maxIdleConnections
```
 final StagehandOkHttpClient.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 StagehandOkHttpClient.Builder maxIdleConnections(Integer maxIdleConnections)
```
    Alias for Builder.maxIdleConnections.
    This unboxed primitive overload exists for backwards compatibility.
  - maxIdleConnections
```
 final StagehandOkHttpClient.Builder maxIdleConnections(Optional<Integer> maxIdleConnections)
```
    Alias for calling Builder.maxIdleConnections with maxIdleConnections.orElse(null).
  - keepAliveDuration
```
 final StagehandOkHttpClient.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 StagehandOkHttpClient.Builder keepAliveDuration(Optional<Duration> keepAliveDuration)
```
    Alias for calling Builder.keepAliveDuration with keepAliveDuration.orElse(null).
  - sslSocketFactory
```
 final StagehandOkHttpClient.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 StagehandOkHttpClient.Builder sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)
```
    Alias for calling Builder.sslSocketFactory with sslSocketFactory.orElse(null).
  - trustManager
```
 final StagehandOkHttpClient.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 StagehandOkHttpClient.Builder trustManager(Optional<X509TrustManager> trustManager)
```
    Alias for calling Builder.trustManager with trustManager.orElse(null).
  - hostnameVerifier
```
 final StagehandOkHttpClient.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 StagehandOkHttpClient.Builder hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)
```
    Alias for calling Builder.hostnameVerifier with hostnameVerifier.orElse(null).
  - checkJacksonVersionCompatibility
```
 final StagehandOkHttpClient.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 StagehandOkHttpClient.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 StagehandOkHttpClient.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 StagehandOkHttpClient.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 StagehandOkHttpClient.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 StagehandOkHttpClient.Builder baseUrl(String baseUrl)
```
    The base URL to use for every request.
    Defaults to the production environment: https://api.stagehand.browserbase.com.
  - baseUrl
```
 final StagehandOkHttpClient.Builder baseUrl(Optional<String> baseUrl)
```
    Alias for calling Builder.baseUrl with baseUrl.orElse(null).
  - responseValidation
```
 final StagehandOkHttpClient.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 StagehandOkHttpClient.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 StagehandOkHttpClient.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 StagehandOkHttpClient.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 StagehandOkHttpClient.Builder browserbaseApiKey(String browserbaseApiKey)
```
    Your Browserbase API Key
  - browserbaseProjectId
```
 final StagehandOkHttpClient.Builder browserbaseProjectId(String browserbaseProjectId)
```
    Your Browserbase Project ID
  - modelApiKey
```
 final StagehandOkHttpClient.Builder modelApiKey(String modelApiKey)
```
    Your LLM provider API key (e.g. OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.)
  - headers
```
 final StagehandOkHttpClient.Builder headers(Headers headers)
```
  - headers
```
 final StagehandOkHttpClient.Builder headers(Map<String, Iterable<String>> headers)
```
  - putHeader
```
 final StagehandOkHttpClient.Builder putHeader(String name, String value)
```
  - putHeaders
```
 final StagehandOkHttpClient.Builder putHeaders(String name, Iterable<String> values)
```
  - putAllHeaders
```
 final StagehandOkHttpClient.Builder putAllHeaders(Headers headers)
```
  - putAllHeaders
```
 final StagehandOkHttpClient.Builder putAllHeaders(Map<String, Iterable<String>> headers)
```
  - replaceHeaders
```
 final StagehandOkHttpClient.Builder replaceHeaders(String name, String value)
```
  - replaceHeaders
```
 final StagehandOkHttpClient.Builder replaceHeaders(String name, Iterable<String> values)
```
  - replaceAllHeaders
```
 final StagehandOkHttpClient.Builder replaceAllHeaders(Headers headers)
```
  - replaceAllHeaders
```
 final StagehandOkHttpClient.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)
```
  - removeHeaders
```
 final StagehandOkHttpClient.Builder removeHeaders(String name)
```
  - removeAllHeaders
```
 final StagehandOkHttpClient.Builder removeAllHeaders(Set<String> names)
```
  - queryParams
```
 final StagehandOkHttpClient.Builder queryParams(QueryParams queryParams)
```
  - queryParams
```
 final StagehandOkHttpClient.Builder queryParams(Map<String, Iterable<String>> queryParams)
```
  - putQueryParam
```
 final StagehandOkHttpClient.Builder putQueryParam(String key, String value)
```
  - putQueryParams
```
 final StagehandOkHttpClient.Builder putQueryParams(String key, Iterable<String> values)
```
  - putAllQueryParams
```
 final StagehandOkHttpClient.Builder putAllQueryParams(QueryParams queryParams)
```
  - putAllQueryParams
```
 final StagehandOkHttpClient.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - replaceQueryParams
```
 final StagehandOkHttpClient.Builder replaceQueryParams(String key, String value)
```
  - replaceQueryParams
```
 final StagehandOkHttpClient.Builder replaceQueryParams(String key, Iterable<String> values)
```
  - replaceAllQueryParams
```
 final StagehandOkHttpClient.Builder replaceAllQueryParams(QueryParams queryParams)
```
  - replaceAllQueryParams
```
 final StagehandOkHttpClient.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - removeQueryParams
```
 final StagehandOkHttpClient.Builder removeQueryParams(String key)
```
  - removeAllQueryParams
```
 final StagehandOkHttpClient.Builder removeAllQueryParams(Set<String> keys)
```
  - fromEnv
```
 final StagehandOkHttpClient.Builder fromEnv()
```
    Updates configuration using system properties and environment variables.
  - build
```
 final StagehandClient build()
```
    Returns an immutable instance of StagehandClient.
    Further updates to this Builder will not mutate the returned instance.

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

browserbaseApiKey

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