Karbone/com.ekino.oss.karbone/KarboneConfig/Companion

Companion

object Companion

Properties

CLOUD_BASE_URL

const val CLOUD_BASE_URL: String

Default baseUrl for cloud.

DefaultJson

@JvmField

val DefaultJson: Json

Json instance used by default: unknown keys ignored, nulls and defaults omitted on encode.

LATEST_API_VERSION

const val LATEST_API_VERSION: Int = 5

carbone-version header value used by cloud.

VERSION

@JvmField

val VERSION: String

SDK version as recorded in the jar manifest (Implementation-Version), used in the default User-Agent. dev when Karbone is not loaded from its jar (tests, IDE).

Functions

cloud

fun cloud(apiKey: String, configure: KarboneConfig.Builder.() -> Unit = {}): KarboneConfig

Config for Carbone Cloud, authenticated with apiKey and sending LATEST_API_VERSION.

onPremise

fun onPremise(baseUrl: String, token: String? = null, configure: KarboneConfig.Builder.() -> Unit = {}): KarboneConfig

Config for a self-hosted Carbone instance at baseUrl. token is optional since authentication is disabled by default on-premise; no carbone-version header is sent.