All Implemented Interfaces:


public final class GrowsurfOkHttpClient.Builder

A builder for GrowsurfOkHttpClient.

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

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

- Constructor Detail
- Method Detail
  - dispatcherExecutorService
```
 final GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.Builder dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)
```
    Alias for calling Builder.dispatcherExecutorService with dispatcherExecutorService.orElse(null).
  - proxy
```
 final GrowsurfOkHttpClient.Builder proxy(Proxy proxy)
```
  - proxy
```
 final GrowsurfOkHttpClient.Builder proxy(Optional<Proxy> proxy)
```
    Alias for calling Builder.proxy with proxy.orElse(null).
  - proxyAuthenticator
```
 final GrowsurfOkHttpClient.Builder proxyAuthenticator(ProxyAuthenticator proxyAuthenticator)
```
    Provides credentials when an HTTP proxy responds with 407 Proxy Authentication Required.
  - proxyAuthenticator
```
 final GrowsurfOkHttpClient.Builder proxyAuthenticator(Optional<ProxyAuthenticator> proxyAuthenticator)
```
    Alias for calling Builder.proxyAuthenticator with proxyAuthenticator.orElse(null).
  - maxIdleConnections
```
 final GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.Builder maxIdleConnections(Integer maxIdleConnections)
```
    Alias for Builder.maxIdleConnections.
    This unboxed primitive overload exists for backwards compatibility.
  - maxIdleConnections
```
 final GrowsurfOkHttpClient.Builder maxIdleConnections(Optional<Integer> maxIdleConnections)
```
    Alias for calling Builder.maxIdleConnections with maxIdleConnections.orElse(null).
  - keepAliveDuration
```
 final GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.Builder keepAliveDuration(Optional<Duration> keepAliveDuration)
```
    Alias for calling Builder.keepAliveDuration with keepAliveDuration.orElse(null).
  - sslSocketFactory
```
 final GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.Builder sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)
```
    Alias for calling Builder.sslSocketFactory with sslSocketFactory.orElse(null).
  - trustManager
```
 final GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.Builder trustManager(Optional<X509TrustManager> trustManager)
```
    Alias for calling Builder.trustManager with trustManager.orElse(null).
  - hostnameVerifier
```
 final GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.Builder hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)
```
    Alias for calling Builder.hostnameVerifier with hostnameVerifier.orElse(null).
  - checkJacksonVersionCompatibility
```
 final GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.Builder jsonMapper(JsonMapper jsonMapper)
```
    The Jackson JSON mapper to use for serializing and deserializing JSON.
    Defaults to com.growsurf.api.core.jsonMapper. The default is usually sufficient and rarely needs to be overridden.
  - sleeper
```
 final GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.Builder baseUrl(String baseUrl)
```
    The base URL to use for every request.
    Defaults to the production environment: https://api.growsurf.com/v2.
  - baseUrl
```
 final GrowsurfOkHttpClient.Builder baseUrl(Optional<String> baseUrl)
```
    Alias for calling Builder.baseUrl with baseUrl.orElse(null).
  - responseValidation
```
 final GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.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 GrowsurfOkHttpClient.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.
  - apiKey
```
 final GrowsurfOkHttpClient.Builder apiKey(String apiKey)
```
    GrowSurf REST API key supplied as Authorization: Bearer <api_key>.
  - headers
```
 final GrowsurfOkHttpClient.Builder headers(Headers headers)
```
  - headers
```
 final GrowsurfOkHttpClient.Builder headers(Map<String, Iterable<String>> headers)
```
  - putHeader
```
 final GrowsurfOkHttpClient.Builder putHeader(String name, String value)
```
  - putHeaders
```
 final GrowsurfOkHttpClient.Builder putHeaders(String name, Iterable<String> values)
```
  - putAllHeaders
```
 final GrowsurfOkHttpClient.Builder putAllHeaders(Headers headers)
```
  - putAllHeaders
```
 final GrowsurfOkHttpClient.Builder putAllHeaders(Map<String, Iterable<String>> headers)
```
  - replaceHeaders
```
 final GrowsurfOkHttpClient.Builder replaceHeaders(String name, String value)
```
  - replaceHeaders
```
 final GrowsurfOkHttpClient.Builder replaceHeaders(String name, Iterable<String> values)
```
  - replaceAllHeaders
```
 final GrowsurfOkHttpClient.Builder replaceAllHeaders(Headers headers)
```
  - replaceAllHeaders
```
 final GrowsurfOkHttpClient.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)
```
  - removeHeaders
```
 final GrowsurfOkHttpClient.Builder removeHeaders(String name)
```
  - removeAllHeaders
```
 final GrowsurfOkHttpClient.Builder removeAllHeaders(Set<String> names)
```
  - queryParams
```
 final GrowsurfOkHttpClient.Builder queryParams(QueryParams queryParams)
```
  - queryParams
```
 final GrowsurfOkHttpClient.Builder queryParams(Map<String, Iterable<String>> queryParams)
```
  - putQueryParam
```
 final GrowsurfOkHttpClient.Builder putQueryParam(String key, String value)
```
  - putQueryParams
```
 final GrowsurfOkHttpClient.Builder putQueryParams(String key, Iterable<String> values)
```
  - putAllQueryParams
```
 final GrowsurfOkHttpClient.Builder putAllQueryParams(QueryParams queryParams)
```
  - putAllQueryParams
```
 final GrowsurfOkHttpClient.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - replaceQueryParams
```
 final GrowsurfOkHttpClient.Builder replaceQueryParams(String key, String value)
```
  - replaceQueryParams
```
 final GrowsurfOkHttpClient.Builder replaceQueryParams(String key, Iterable<String> values)
```
  - replaceAllQueryParams
```
 final GrowsurfOkHttpClient.Builder replaceAllQueryParams(QueryParams queryParams)
```
  - replaceAllQueryParams
```
 final GrowsurfOkHttpClient.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - removeQueryParams
```
 final GrowsurfOkHttpClient.Builder removeQueryParams(String key)
```
  - removeAllQueryParams
```
 final GrowsurfOkHttpClient.Builder removeAllQueryParams(Set<String> keys)
```
  - fromEnv
```
 final GrowsurfOkHttpClient.Builder fromEnv()
```
    Updates configuration using system properties and environment variables.
  - build
```
 final GrowsurfClient build()
```
    Returns an immutable instance of GrowsurfClient.
    Further updates to this Builder will not mutate the returned instance.

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

sleeper

clock

baseUrl

baseUrl

responseValidation

timeout

timeout

maxRetries

logLevel

apiKey

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