lithic-kotlin-root/com.lithic.api.core/ClientOptions

ClientOptions

class ClientOptions

A class representing the SDK client configuration.

Types

Builder

class Builder

A builder for ClientOptions.

Companion

object Companion

Properties

apiKey

val apiKey: String

checkJacksonVersionCompatibility

val checkJacksonVersionCompatibility: Boolean

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).

clock

val clock: Clock

The clock to use for operations that require timing, like retries.

headers

val headers: Headers

Headers to send with the request.

httpClient

val httpClient: HttpClient

The HTTP client to use in the SDK.

jsonMapper

val jsonMapper: JsonMapper

The Jackson JSON mapper to use for serializing and deserializing JSON.

maxRetries

val maxRetries: Int

The maximum number of times to retry failed requests, with a short exponential backoff between requests.

queryParams

val queryParams: QueryParams

Query params to send with the request.

responseValidation

val responseValidation: Boolean

Whether to call validate on every response before returning it.

timeout

val timeout: Timeout

Sets the maximum time allowed for various parts of an HTTP call's lifecycle, excluding retries.

webhookSecret

val webhookSecret: String?

Functions

baseUrl

fun baseUrl(): String

The base URL to use for every request.

fun close()

Closes these client options, relinquishing any underlying resources.

toBuilder

fun toBuilder(): ClientOptions.Builder