All Implemented Interfaces:


public final class PreludeOkHttpClient.Builder

A builder for PreludeOkHttpClient.

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

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

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

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

responseValidation

timeout

timeout

maxRetries

apiToken

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