Package so.prelude.sdk.client.okhttp
Class PreludeOkHttpClient.Builder
-
- All Implemented Interfaces:
public final class PreludeOkHttpClient.Builder
A builder for PreludeOkHttpClient.
-
-
Method Summary
-
-
Method Detail
-
baseUrl
final PreludeOkHttpClient.Builder baseUrl(String baseUrl)
-
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)
-
clock
final PreludeOkHttpClient.Builder clock(Clock clock)
-
headers
final PreludeOkHttpClient.Builder headers(Headers 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)
-
timeout
final PreludeOkHttpClient.Builder timeout(Timeout timeout)
-
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)
-
proxy
final PreludeOkHttpClient.Builder proxy(Proxy proxy)
-
responseValidation
final PreludeOkHttpClient.Builder responseValidation(Boolean responseValidation)
-
apiToken
final PreludeOkHttpClient.Builder apiToken(String apiToken)
-
fromEnv
final PreludeOkHttpClient.Builder fromEnv()
-
build
final PreludeClient build()
Returns an immutable instance of PreludeClient.
Further updates to this Builder will not mutate the returned instance.
-
-
-
-