Karbone/com.ekino.oss.karbone/KarboneConfig

KarboneConfig

data class KarboneConfig(val baseUrl: String, val token: String? = null, val apiVersion: Int? = null, val connectTimeout: Duration = 10.seconds, val requestTimeout: Duration = 60.seconds, val retry: RetryPolicy = RetryPolicy.None, val json: Json = DefaultJson, val userAgent: String = "karbone/")

Immutable per-client configuration.

Constructors

constructor(baseUrl: String, token: String? = null, apiVersion: Int? = null, connectTimeout: Duration = 10.seconds, requestTimeout: Duration = 60.seconds, retry: RetryPolicy = RetryPolicy.None, json: Json = DefaultJson, userAgent: String = "karbone/")

Types

Mutable builder backing Karbone.cloud and Karbone.onPremise; not constructed directly.

object Companion

Properties

val apiVersion: Int?

carbone-version header. null omits it, which is what on-premise expects. Cloud should use LATEST_API_VERSION.

val baseUrl: String

https://api.carbone.io or an on-premise URL such as http://localhost:4000. Trailing slash optional.

val connectTimeout: Duration

Time allowed to establish the TCP/TLS connection. Defaults to 10 seconds.

val json: Json

Used for request bodies and response parsing.

normalizedBaseUrl

val normalizedBaseUrl: String

baseUrl with any trailing slash removed.

val requestTimeout: Duration

Per-request timeout. Carbone's synchronous render timeout is 60 s.

val retry: RetryPolicy

Retry behaviour on transport failures. Defaults to no retry.

val token: String?

Bearer token. null sends no Authorization header (on-premise with authentication disabled).

val userAgent: String

Sent as the User-Agent header. Defaults to karbone/<version>.