All Implemented Interfaces:


public final class OpenlayerOkHttpClient.Builder

A builder for OpenlayerOkHttpClient.

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

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

- Constructor Detail
- Method Detail
  - dispatcherExecutorService
```
 final OpenlayerOkHttpClient.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 OpenlayerOkHttpClient.Builder dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)
```
    Alias for calling Builder.dispatcherExecutorService with dispatcherExecutorService.orElse(null).
  - proxy
```
 final OpenlayerOkHttpClient.Builder proxy(Proxy proxy)
```
  - proxy
```
 final OpenlayerOkHttpClient.Builder proxy(Optional<Proxy> proxy)
```
    Alias for calling Builder.proxy with proxy.orElse(null).
  - sslSocketFactory
```
 final OpenlayerOkHttpClient.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 OpenlayerOkHttpClient.Builder sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)
```
    Alias for calling Builder.sslSocketFactory with sslSocketFactory.orElse(null).
  - trustManager
```
 final OpenlayerOkHttpClient.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 OpenlayerOkHttpClient.Builder trustManager(Optional<X509TrustManager> trustManager)
```
    Alias for calling Builder.trustManager with trustManager.orElse(null).
  - hostnameVerifier
```
 final OpenlayerOkHttpClient.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 OpenlayerOkHttpClient.Builder hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)
```
    Alias for calling Builder.hostnameVerifier with hostnameVerifier.orElse(null).
  - checkJacksonVersionCompatibility
```
 final OpenlayerOkHttpClient.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 OpenlayerOkHttpClient.Builder jsonMapper(JsonMapper jsonMapper)
```
    The Jackson JSON mapper to use for serializing and deserializing JSON.
    Defaults to com.openlayer.api.core.jsonMapper. The default is usually sufficient and rarely needs to be overridden.
  - sleeper
```
 final OpenlayerOkHttpClient.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 OpenlayerOkHttpClient.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 OpenlayerOkHttpClient.Builder baseUrl(String baseUrl)
```
    The base URL to use for every request.
    Defaults to the production environment: https://api.openlayer.com/v1.
  - baseUrl
```
 final OpenlayerOkHttpClient.Builder baseUrl(Optional<String> baseUrl)
```
    Alias for calling Builder.baseUrl with baseUrl.orElse(null).
  - responseValidation
```
 final OpenlayerOkHttpClient.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 OpenlayerOkHttpClient.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 OpenlayerOkHttpClient.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 OpenlayerOkHttpClient.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 OpenlayerOkHttpClient.Builder apiKey(String apiKey)
```
  - apiKey
```
 final OpenlayerOkHttpClient.Builder apiKey(Optional<String> apiKey)
```
    Alias for calling Builder.apiKey with apiKey.orElse(null).
  - headers
```
 final OpenlayerOkHttpClient.Builder headers(Headers headers)
```
  - headers
```
 final OpenlayerOkHttpClient.Builder headers(Map<String, Iterable<String>> headers)
```
  - putHeader
```
 final OpenlayerOkHttpClient.Builder putHeader(String name, String value)
```
  - putHeaders
```
 final OpenlayerOkHttpClient.Builder putHeaders(String name, Iterable<String> values)
```
  - putAllHeaders
```
 final OpenlayerOkHttpClient.Builder putAllHeaders(Headers headers)
```
  - putAllHeaders
```
 final OpenlayerOkHttpClient.Builder putAllHeaders(Map<String, Iterable<String>> headers)
```
  - replaceHeaders
```
 final OpenlayerOkHttpClient.Builder replaceHeaders(String name, String value)
```
  - replaceHeaders
```
 final OpenlayerOkHttpClient.Builder replaceHeaders(String name, Iterable<String> values)
```
  - replaceAllHeaders
```
 final OpenlayerOkHttpClient.Builder replaceAllHeaders(Headers headers)
```
  - replaceAllHeaders
```
 final OpenlayerOkHttpClient.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)
```
  - removeHeaders
```
 final OpenlayerOkHttpClient.Builder removeHeaders(String name)
```
  - removeAllHeaders
```
 final OpenlayerOkHttpClient.Builder removeAllHeaders(Set<String> names)
```
  - queryParams
```
 final OpenlayerOkHttpClient.Builder queryParams(QueryParams queryParams)
```
  - queryParams
```
 final OpenlayerOkHttpClient.Builder queryParams(Map<String, Iterable<String>> queryParams)
```
  - putQueryParam
```
 final OpenlayerOkHttpClient.Builder putQueryParam(String key, String value)
```
  - putQueryParams
```
 final OpenlayerOkHttpClient.Builder putQueryParams(String key, Iterable<String> values)
```
  - putAllQueryParams
```
 final OpenlayerOkHttpClient.Builder putAllQueryParams(QueryParams queryParams)
```
  - putAllQueryParams
```
 final OpenlayerOkHttpClient.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - replaceQueryParams
```
 final OpenlayerOkHttpClient.Builder replaceQueryParams(String key, String value)
```
  - replaceQueryParams
```
 final OpenlayerOkHttpClient.Builder replaceQueryParams(String key, Iterable<String> values)
```
  - replaceAllQueryParams
```
 final OpenlayerOkHttpClient.Builder replaceAllQueryParams(QueryParams queryParams)
```
  - replaceAllQueryParams
```
 final OpenlayerOkHttpClient.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - removeQueryParams
```
 final OpenlayerOkHttpClient.Builder removeQueryParams(String key)
```
  - removeAllQueryParams
```
 final OpenlayerOkHttpClient.Builder removeAllQueryParams(Set<String> keys)
```
  - fromEnv
```
 final OpenlayerOkHttpClient.Builder fromEnv()
```
    Updates configuration using system properties and environment variables.
  - build
```
 final OpenlayerClient build()
```
    Returns an immutable instance of OpenlayerClient.
    Further updates to this Builder will not mutate the returned instance.

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

sslSocketFactory

sslSocketFactory

trustManager

trustManager

hostnameVerifier

hostnameVerifier

checkJacksonVersionCompatibility

jsonMapper

sleeper

clock

baseUrl

baseUrl

responseValidation

timeout

timeout

maxRetries

apiKey

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