All Implemented Interfaces:


public final class ImageKitOkHttpClient.Builder

A builder for ImageKitOkHttpClient.

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 ImageKitOkHttpClient.Builder`	`dispatcherExecutorService(ExecutorService dispatcherExecutorService)`	The executor service to use for running HTTP requests.
`final ImageKitOkHttpClient.Builder`	`dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)`	Alias for calling Builder.dispatcherExecutorService with `dispatcherExecutorService.orElse(null)`.
`final ImageKitOkHttpClient.Builder`	`proxy(Proxy proxy)`
`final ImageKitOkHttpClient.Builder`	`proxy(Optional<Proxy> proxy)`	Alias for calling Builder.proxy with `proxy.orElse(null)`.
`final ImageKitOkHttpClient.Builder`	`proxyAuthenticator(ProxyAuthenticator proxyAuthenticator)`	Provides credentials when an HTTP proxy responds with `407 Proxy Authentication Required`.
`final ImageKitOkHttpClient.Builder`	`proxyAuthenticator(Optional<ProxyAuthenticator> proxyAuthenticator)`	Alias for calling Builder.proxyAuthenticator with `proxyAuthenticator.orElse(null)`.
`final ImageKitOkHttpClient.Builder`	`maxIdleConnections(Integer maxIdleConnections)`	The maximum number of idle connections kept by the underlying OkHttp connection pool.
`final ImageKitOkHttpClient.Builder`	`maxIdleConnections(Integer maxIdleConnections)`	Alias for Builder.maxIdleConnections.
`final ImageKitOkHttpClient.Builder`	`maxIdleConnections(Optional<Integer> maxIdleConnections)`	Alias for calling Builder.maxIdleConnections with `maxIdleConnections.orElse(null)`.
`final ImageKitOkHttpClient.Builder`	`keepAliveDuration(Duration keepAliveDuration)`	The keep-alive duration for idle connections in the underlying OkHttp connection pool.
`final ImageKitOkHttpClient.Builder`	`keepAliveDuration(Optional<Duration> keepAliveDuration)`	Alias for calling Builder.keepAliveDuration with `keepAliveDuration.orElse(null)`.
`final ImageKitOkHttpClient.Builder`	`sslSocketFactory(SSLSocketFactory sslSocketFactory)`	The socket factory used to secure HTTPS connections.
`final ImageKitOkHttpClient.Builder`	`sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)`	Alias for calling Builder.sslSocketFactory with `sslSocketFactory.orElse(null)`.
`final ImageKitOkHttpClient.Builder`	`trustManager(X509TrustManager trustManager)`	The trust manager used to secure HTTPS connections.
`final ImageKitOkHttpClient.Builder`	`trustManager(Optional<X509TrustManager> trustManager)`	Alias for calling Builder.trustManager with `trustManager.orElse(null)`.
`final ImageKitOkHttpClient.Builder`	`hostnameVerifier(HostnameVerifier hostnameVerifier)`	The verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
`final ImageKitOkHttpClient.Builder`	`hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)`	Alias for calling Builder.hostnameVerifier with `hostnameVerifier.orElse(null)`.
`final ImageKitOkHttpClient.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 ImageKitOkHttpClient.Builder`	`jsonMapper(JsonMapper jsonMapper)`	The Jackson JSON mapper to use for serializing and deserializing JSON.
`final ImageKitOkHttpClient.Builder`	`sleeper(Sleeper sleeper)`	The interface to use for delaying execution, like during retries.
`final ImageKitOkHttpClient.Builder`	`clock(Clock clock)`	The clock to use for operations that require timing, like retries.
`final ImageKitOkHttpClient.Builder`	`baseUrl(String baseUrl)`	The base URL to use for every request.
`final ImageKitOkHttpClient.Builder`	`baseUrl(Optional<String> baseUrl)`	Alias for calling Builder.baseUrl with `baseUrl.orElse(null)`.
`final ImageKitOkHttpClient.Builder`	`responseValidation(Boolean responseValidation)`	Whether to call `validate` on every response before returning it.
`final ImageKitOkHttpClient.Builder`	`timeout(Timeout timeout)`	Sets the maximum time allowed for various parts of an HTTP call's lifecycle, excluding retries.
`final ImageKitOkHttpClient.Builder`	`timeout(Duration timeout)`	Sets the maximum time allowed for a complete HTTP call, not including retries.
`final ImageKitOkHttpClient.Builder`	`maxRetries(Integer maxRetries)`	The maximum number of times to retry failed requests, with a short exponential backoff between requests.
`final ImageKitOkHttpClient.Builder`	`logLevel(LogLevel logLevel)`	The level at which to log request and response information.
`final ImageKitOkHttpClient.Builder`	`privateKey(String privateKey)`	Your ImageKit private API key (starts with `private_`).
`final ImageKitOkHttpClient.Builder`	`password(String password)`	ImageKit uses your API key as username and ignores the password.
`final ImageKitOkHttpClient.Builder`	`password(Optional<String> password)`	Alias for calling Builder.password with `password.orElse(null)`.
`final ImageKitOkHttpClient.Builder`	`webhookSecret(String webhookSecret)`	Your ImageKit webhook secret for verifying webhook signatures (starts with `whsec_`).
`final ImageKitOkHttpClient.Builder`	`webhookSecret(Optional<String> webhookSecret)`	Alias for calling Builder.webhookSecret with `webhookSecret.orElse(null)`.
`final ImageKitOkHttpClient.Builder`	`headers(Headers headers)`
`final ImageKitOkHttpClient.Builder`	`headers(Map<String, Iterable<String>> headers)`
`final ImageKitOkHttpClient.Builder`	`putHeader(String name, String value)`
`final ImageKitOkHttpClient.Builder`	`putHeaders(String name, Iterable<String> values)`
`final ImageKitOkHttpClient.Builder`	`putAllHeaders(Headers headers)`
`final ImageKitOkHttpClient.Builder`	`putAllHeaders(Map<String, Iterable<String>> headers)`
`final ImageKitOkHttpClient.Builder`	`replaceHeaders(String name, String value)`
`final ImageKitOkHttpClient.Builder`	`replaceHeaders(String name, Iterable<String> values)`
`final ImageKitOkHttpClient.Builder`	`replaceAllHeaders(Headers headers)`
`final ImageKitOkHttpClient.Builder`	`replaceAllHeaders(Map<String, Iterable<String>> headers)`
`final ImageKitOkHttpClient.Builder`	`removeHeaders(String name)`
`final ImageKitOkHttpClient.Builder`	`removeAllHeaders(Set<String> names)`
`final ImageKitOkHttpClient.Builder`	`queryParams(QueryParams queryParams)`
`final ImageKitOkHttpClient.Builder`	`queryParams(Map<String, Iterable<String>> queryParams)`
`final ImageKitOkHttpClient.Builder`	`putQueryParam(String key, String value)`
`final ImageKitOkHttpClient.Builder`	`putQueryParams(String key, Iterable<String> values)`
`final ImageKitOkHttpClient.Builder`	`putAllQueryParams(QueryParams queryParams)`
`final ImageKitOkHttpClient.Builder`	`putAllQueryParams(Map<String, Iterable<String>> queryParams)`
`final ImageKitOkHttpClient.Builder`	`replaceQueryParams(String key, String value)`
`final ImageKitOkHttpClient.Builder`	`replaceQueryParams(String key, Iterable<String> values)`
`final ImageKitOkHttpClient.Builder`	`replaceAllQueryParams(QueryParams queryParams)`
`final ImageKitOkHttpClient.Builder`	`replaceAllQueryParams(Map<String, Iterable<String>> queryParams)`
`final ImageKitOkHttpClient.Builder`	`removeQueryParams(String key)`
`final ImageKitOkHttpClient.Builder`	`removeAllQueryParams(Set<String> keys)`
`final ImageKitOkHttpClient.Builder`	`fromEnv()`	Updates configuration using system properties and environment variables.
`final ImageKitClient`	`build()`	Returns an immutable instance of ImageKitClient.

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

- Constructor Detail
- Method Detail
  - dispatcherExecutorService
```
 final ImageKitOkHttpClient.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 ImageKitOkHttpClient.Builder dispatcherExecutorService(Optional<ExecutorService> dispatcherExecutorService)
```
    Alias for calling Builder.dispatcherExecutorService with dispatcherExecutorService.orElse(null).
  - proxy
```
 final ImageKitOkHttpClient.Builder proxy(Proxy proxy)
```
  - proxy
```
 final ImageKitOkHttpClient.Builder proxy(Optional<Proxy> proxy)
```
    Alias for calling Builder.proxy with proxy.orElse(null).
  - proxyAuthenticator
```
 final ImageKitOkHttpClient.Builder proxyAuthenticator(ProxyAuthenticator proxyAuthenticator)
```
    Provides credentials when an HTTP proxy responds with 407 Proxy Authentication Required.
  - proxyAuthenticator
```
 final ImageKitOkHttpClient.Builder proxyAuthenticator(Optional<ProxyAuthenticator> proxyAuthenticator)
```
    Alias for calling Builder.proxyAuthenticator with proxyAuthenticator.orElse(null).
  - maxIdleConnections
```
 final ImageKitOkHttpClient.Builder maxIdleConnections(Integer maxIdleConnections)
```
    The maximum number of idle connections kept by the underlying OkHttp connection pool.
    If this is set, then keepAliveDuration must also be set.
    If unset, then OkHttp's default is used.
  - maxIdleConnections
```
 final ImageKitOkHttpClient.Builder maxIdleConnections(Integer maxIdleConnections)
```
    Alias for Builder.maxIdleConnections.
    This unboxed primitive overload exists for backwards compatibility.
  - maxIdleConnections
```
 final ImageKitOkHttpClient.Builder maxIdleConnections(Optional<Integer> maxIdleConnections)
```
    Alias for calling Builder.maxIdleConnections with maxIdleConnections.orElse(null).
  - keepAliveDuration
```
 final ImageKitOkHttpClient.Builder keepAliveDuration(Duration keepAliveDuration)
```
    The keep-alive duration for idle connections in the underlying OkHttp connection pool.
    If this is set, then maxIdleConnections must also be set.
    If unset, then OkHttp's default is used.
  - keepAliveDuration
```
 final ImageKitOkHttpClient.Builder keepAliveDuration(Optional<Duration> keepAliveDuration)
```
    Alias for calling Builder.keepAliveDuration with keepAliveDuration.orElse(null).
  - sslSocketFactory
```
 final ImageKitOkHttpClient.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 ImageKitOkHttpClient.Builder sslSocketFactory(Optional<SSLSocketFactory> sslSocketFactory)
```
    Alias for calling Builder.sslSocketFactory with sslSocketFactory.orElse(null).
  - trustManager
```
 final ImageKitOkHttpClient.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 ImageKitOkHttpClient.Builder trustManager(Optional<X509TrustManager> trustManager)
```
    Alias for calling Builder.trustManager with trustManager.orElse(null).
  - hostnameVerifier
```
 final ImageKitOkHttpClient.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 ImageKitOkHttpClient.Builder hostnameVerifier(Optional<HostnameVerifier> hostnameVerifier)
```
    Alias for calling Builder.hostnameVerifier with hostnameVerifier.orElse(null).
  - checkJacksonVersionCompatibility
```
 final ImageKitOkHttpClient.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 ImageKitOkHttpClient.Builder jsonMapper(JsonMapper jsonMapper)
```
    The Jackson JSON mapper to use for serializing and deserializing JSON.
    Defaults to io.imagekit.core.jsonMapper. The default is usually sufficient and rarely needs to be overridden.
  - sleeper
```
 final ImageKitOkHttpClient.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 ImageKitOkHttpClient.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 ImageKitOkHttpClient.Builder baseUrl(String baseUrl)
```
    The base URL to use for every request.
    Defaults to the production environment: https://api.imagekit.io.
  - baseUrl
```
 final ImageKitOkHttpClient.Builder baseUrl(Optional<String> baseUrl)
```
    Alias for calling Builder.baseUrl with baseUrl.orElse(null).
  - responseValidation
```
 final ImageKitOkHttpClient.Builder responseValidation(Boolean responseValidation)
```
    Whether to call validate on every response before returning it.
    Setting this to true is not forwards compatible with new types from the API for existing fields.
    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 ImageKitOkHttpClient.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 ImageKitOkHttpClient.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 ImageKitOkHttpClient.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.
  - logLevel
```
 final ImageKitOkHttpClient.Builder logLevel(LogLevel logLevel)
```
    The level at which to log request and response information.
    fromEnv will set the level from environment variables. See LogLevel.fromEnv.
    Defaults to LogLevel.fromEnv.
  - privateKey
```
 final ImageKitOkHttpClient.Builder privateKey(String privateKey)
```
    Your ImageKit private API key (starts with private_). You can find this in the ImageKit dashboard.
  - password
```
 final ImageKitOkHttpClient.Builder password(String password)
```
    ImageKit uses your API key as username and ignores the password. The SDK sets a dummy value. You can ignore this field.
    Defaults to "do_not_set".
  - password
```
 final ImageKitOkHttpClient.Builder password(Optional<String> password)
```
    Alias for calling Builder.password with password.orElse(null).
  - webhookSecret
```
 final ImageKitOkHttpClient.Builder webhookSecret(String webhookSecret)
```
    Your ImageKit webhook secret for verifying webhook signatures (starts with whsec_). You can find this in the ImageKit dashboard. Only required if you are using webhooks.
  - webhookSecret
```
 final ImageKitOkHttpClient.Builder webhookSecret(Optional<String> webhookSecret)
```
    Alias for calling Builder.webhookSecret with webhookSecret.orElse(null).
  - headers
```
 final ImageKitOkHttpClient.Builder headers(Headers headers)
```
  - headers
```
 final ImageKitOkHttpClient.Builder headers(Map<String, Iterable<String>> headers)
```
  - putHeader
```
 final ImageKitOkHttpClient.Builder putHeader(String name, String value)
```
  - putHeaders
```
 final ImageKitOkHttpClient.Builder putHeaders(String name, Iterable<String> values)
```
  - putAllHeaders
```
 final ImageKitOkHttpClient.Builder putAllHeaders(Headers headers)
```
  - putAllHeaders
```
 final ImageKitOkHttpClient.Builder putAllHeaders(Map<String, Iterable<String>> headers)
```
  - replaceHeaders
```
 final ImageKitOkHttpClient.Builder replaceHeaders(String name, String value)
```
  - replaceHeaders
```
 final ImageKitOkHttpClient.Builder replaceHeaders(String name, Iterable<String> values)
```
  - replaceAllHeaders
```
 final ImageKitOkHttpClient.Builder replaceAllHeaders(Headers headers)
```
  - replaceAllHeaders
```
 final ImageKitOkHttpClient.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)
```
  - removeHeaders
```
 final ImageKitOkHttpClient.Builder removeHeaders(String name)
```
  - removeAllHeaders
```
 final ImageKitOkHttpClient.Builder removeAllHeaders(Set<String> names)
```
  - queryParams
```
 final ImageKitOkHttpClient.Builder queryParams(QueryParams queryParams)
```
  - queryParams
```
 final ImageKitOkHttpClient.Builder queryParams(Map<String, Iterable<String>> queryParams)
```
  - putQueryParam
```
 final ImageKitOkHttpClient.Builder putQueryParam(String key, String value)
```
  - putQueryParams
```
 final ImageKitOkHttpClient.Builder putQueryParams(String key, Iterable<String> values)
```
  - putAllQueryParams
```
 final ImageKitOkHttpClient.Builder putAllQueryParams(QueryParams queryParams)
```
  - putAllQueryParams
```
 final ImageKitOkHttpClient.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - replaceQueryParams
```
 final ImageKitOkHttpClient.Builder replaceQueryParams(String key, String value)
```
  - replaceQueryParams
```
 final ImageKitOkHttpClient.Builder replaceQueryParams(String key, Iterable<String> values)
```
  - replaceAllQueryParams
```
 final ImageKitOkHttpClient.Builder replaceAllQueryParams(QueryParams queryParams)
```
  - replaceAllQueryParams
```
 final ImageKitOkHttpClient.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)
```
  - removeQueryParams
```
 final ImageKitOkHttpClient.Builder removeQueryParams(String key)
```
  - removeAllQueryParams
```
 final ImageKitOkHttpClient.Builder removeAllQueryParams(Set<String> keys)
```
  - fromEnv
```
 final ImageKitOkHttpClient.Builder fromEnv()
```
    Updates configuration using system properties and environment variables.
  - build
```
 final ImageKitClient build()
```
    Returns an immutable instance of ImageKitClient.
    Further updates to this Builder will not mutate the returned instance.

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

proxyAuthenticator

proxyAuthenticator

maxIdleConnections

maxIdleConnections

maxIdleConnections

keepAliveDuration

keepAliveDuration

sslSocketFactory

sslSocketFactory

trustManager

trustManager

hostnameVerifier

hostnameVerifier

checkJacksonVersionCompatibility

jsonMapper

sleeper

clock

baseUrl

baseUrl

responseValidation

timeout

timeout

maxRetries

logLevel

privateKey

password

password

webhookSecret

webhookSecret

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