All Implemented Interfaces:


public final class DinariOkHttpClient.Builder

A builder for DinariOkHttpClient.

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

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

- Constructor Detail
- Method Detail
  - proxy
```
 final DinariOkHttpClient.Builder proxy(Proxy proxy)
```
  - proxy
```
 final DinariOkHttpClient.Builder proxy(Optional<Proxy> proxy)
```
    Alias for calling Builder.proxy with proxy.orElse(null).
  - sslSocketFactory
```
 final DinariOkHttpClient.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 DinariOkHttpClient.Builder sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)
```
    Alias for calling Builder.sslSocketFactory with sslSocketFactory.orElse(null).
  - trustManager
```
 final DinariOkHttpClient.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 DinariOkHttpClient.Builder trustManager(Optional<X509TrustManager> trustManager)
```
    Alias for calling Builder.trustManager with trustManager.orElse(null).
  - hostnameVerifier
```
 final DinariOkHttpClient.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 DinariOkHttpClient.Builder hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)
```
    Alias for calling Builder.hostnameVerifier with hostnameVerifier.orElse(null).
  - checkJacksonVersionCompatibility
```
 final DinariOkHttpClient.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 DinariOkHttpClient.Builder jsonMapper(JsonMapper jsonMapper)
```
    The Jackson JSON mapper to use for serializing and deserializing JSON.
    Defaults to com.dinari.api.core.jsonMapper. The default is usually sufficient and rarely needs to be overridden.
  - sleeper
```
 final DinariOkHttpClient.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 DinariOkHttpClient.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 DinariOkHttpClient.Builder baseUrl(String baseUrl)
```
    The base URL to use for every request.
    Defaults to the production environment: https://api-enterprise.sbt.dinari.com.
    The following other environments, with dedicated builder methods, are available:
    sandbox: https://api-enterprise.sandbox.dinari.com
  - baseUrl
```
 final DinariOkHttpClient.Builder baseUrl(Optional<String> baseUrl)
```
    Alias for calling Builder.baseUrl with baseUrl.orElse(null).
  - sandbox
```
 final DinariOkHttpClient.Builder sandbox()
```
    Sets baseUrl to https://api-enterprise.sandbox.dinari.com.
  - responseValidation
```
 final DinariOkHttpClient.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 DinariOkHttpClient.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 DinariOkHttpClient.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 DinariOkHttpClient.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.
  - apiKeyId
```
 final DinariOkHttpClient.Builder apiKeyId(String apiKeyId)
```
    The API key ID provided on the Partners Dashboard.
  - apiSecretKey
```
 final DinariOkHttpClient.Builder apiSecretKey(String apiSecretKey)
```
    API Secret Key that is only shown once at API Key creation.
  - headers
```
 final DinariOkHttpClient.Builder headers(Headers headers)
```
  - headers
```
 final DinariOkHttpClient.Builder headers(Map<String, Iterable<String>> headers)
```
  - putHeader
```
 final DinariOkHttpClient.Builder putHeader(String name, String value)
```
  - putHeaders
```
 final DinariOkHttpClient.Builder putHeaders(String name, Iterable<String> values)
```
  - putAllHeaders
```
 final DinariOkHttpClient.Builder putAllHeaders(Headers headers)
```
  - putAllHeaders
```
 final DinariOkHttpClient.Builder putAllHeaders(Map<String, Iterable<String>> headers)
```
  - replaceHeaders
```
 final DinariOkHttpClient.Builder replaceHeaders(String name, String value)
```
  - replaceHeaders
```
 final DinariOkHttpClient.Builder replaceHeaders(String name, Iterable<String> values)
```
  - replaceAllHeaders
```
 final DinariOkHttpClient.Builder replaceAllHeaders(Headers headers)
```
  - replaceAllHeaders
```
 final DinariOkHttpClient.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)
```
  - removeHeaders
```
 final DinariOkHttpClient.Builder removeHeaders(String name)
```
  - removeAllHeaders
```
 final DinariOkHttpClient.Builder removeAllHeaders(Set<String> names)
```
  - queryParams
```
 final DinariOkHttpClient.Builder queryParams(QueryParams queryParams)
```
  - queryParams
```
 final DinariOkHttpClient.Builder queryParams(Map<String, Iterable<String>> queryParams)
```
  - putQueryParam
```
 final DinariOkHttpClient.Builder putQueryParam(String key, String value)
```
  - putQueryParams
```
 final DinariOkHttpClient.Builder putQueryParams(String key, Iterable<String> values)
```
  - putAllQueryParams
```
 final DinariOkHttpClient.Builder putAllQueryParams(QueryParams queryParams)
```
  - putAllQueryParams
```
 final DinariOkHttpClient.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - replaceQueryParams
```
 final DinariOkHttpClient.Builder replaceQueryParams(String key, String value)
```
  - replaceQueryParams
```
 final DinariOkHttpClient.Builder replaceQueryParams(String key, Iterable<String> values)
```
  - replaceAllQueryParams
```
 final DinariOkHttpClient.Builder replaceAllQueryParams(QueryParams queryParams)
```
  - replaceAllQueryParams
```
 final DinariOkHttpClient.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - removeQueryParams
```
 final DinariOkHttpClient.Builder removeQueryParams(String key)
```
  - removeAllQueryParams
```
 final DinariOkHttpClient.Builder removeAllQueryParams(Set<String> keys)
```
  - fromEnv
```
 final DinariOkHttpClient.Builder fromEnv()
```
    Updates configuration using system properties and environment variables.
  - build
```
 final DinariClient build()
```
    Returns an immutable instance of DinariClient.
    Further updates to this Builder will not mutate the returned instance.

Class DinariOkHttpClient.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

proxy

proxy

sslSocketFactory

sslSocketFactory

trustManager

trustManager

hostnameVerifier

hostnameVerifier

checkJacksonVersionCompatibility

jsonMapper

sleeper

clock

baseUrl

baseUrl

sandbox

responseValidation

timeout

timeout

maxRetries

apiKeyId

apiSecretKey

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