All Implemented Interfaces:


public final class GrowsurfOkHttpClientAsync.Builder

A builder for GrowsurfOkHttpClientAsync.

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

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

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

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