Package app.knock.api.client.okhttp
Class KnockOkHttpClient.Builder
-
- All Implemented Interfaces:
public final class KnockOkHttpClient.BuilderA builder for KnockOkHttpClient.
-
-
Method Summary
-
-
Method Detail
-
baseUrl
final KnockOkHttpClient.Builder baseUrl(String baseUrl)
-
checkJacksonVersionCompatibility
final KnockOkHttpClient.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 KnockOkHttpClient.Builder jsonMapper(JsonMapper jsonMapper)
-
clock
final KnockOkHttpClient.Builder clock(Clock clock)
-
headers
final KnockOkHttpClient.Builder headers(Headers headers)
-
putHeader
final KnockOkHttpClient.Builder putHeader(String name, String value)
-
putHeaders
final KnockOkHttpClient.Builder putHeaders(String name, Iterable<String> values)
-
putAllHeaders
final KnockOkHttpClient.Builder putAllHeaders(Headers headers)
-
putAllHeaders
final KnockOkHttpClient.Builder putAllHeaders(Map<String, Iterable<String>> headers)
-
replaceHeaders
final KnockOkHttpClient.Builder replaceHeaders(String name, String value)
-
replaceHeaders
final KnockOkHttpClient.Builder replaceHeaders(String name, Iterable<String> values)
-
replaceAllHeaders
final KnockOkHttpClient.Builder replaceAllHeaders(Headers headers)
-
replaceAllHeaders
final KnockOkHttpClient.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)
-
removeHeaders
final KnockOkHttpClient.Builder removeHeaders(String name)
-
removeAllHeaders
final KnockOkHttpClient.Builder removeAllHeaders(Set<String> names)
-
queryParams
final KnockOkHttpClient.Builder queryParams(QueryParams queryParams)
-
queryParams
final KnockOkHttpClient.Builder queryParams(Map<String, Iterable<String>> queryParams)
-
putQueryParam
final KnockOkHttpClient.Builder putQueryParam(String key, String value)
-
putQueryParams
final KnockOkHttpClient.Builder putQueryParams(String key, Iterable<String> values)
-
putAllQueryParams
final KnockOkHttpClient.Builder putAllQueryParams(QueryParams queryParams)
-
putAllQueryParams
final KnockOkHttpClient.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)
-
replaceQueryParams
final KnockOkHttpClient.Builder replaceQueryParams(String key, String value)
-
replaceQueryParams
final KnockOkHttpClient.Builder replaceQueryParams(String key, Iterable<String> values)
-
replaceAllQueryParams
final KnockOkHttpClient.Builder replaceAllQueryParams(QueryParams queryParams)
-
replaceAllQueryParams
final KnockOkHttpClient.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)
-
removeQueryParams
final KnockOkHttpClient.Builder removeQueryParams(String key)
-
removeAllQueryParams
final KnockOkHttpClient.Builder removeAllQueryParams(Set<String> keys)
-
timeout
final KnockOkHttpClient.Builder timeout(Timeout timeout)
-
timeout
final KnockOkHttpClient.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 KnockOkHttpClient.Builder maxRetries(Integer maxRetries)
-
proxy
final KnockOkHttpClient.Builder proxy(Proxy proxy)
-
responseValidation
final KnockOkHttpClient.Builder responseValidation(Boolean responseValidation)
-
apiKey
final KnockOkHttpClient.Builder apiKey(String apiKey)
-
fromEnv
final KnockOkHttpClient.Builder fromEnv()
-
build
final KnockClient build()
Returns an immutable instance of KnockClient.
Further updates to this Builder will not mutate the returned instance.
-
-
-
-