.experiment-jvm-server.1.4.1.source-code.RemoteEvaluationConfig.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of experiment-jvm-server Show documentation
Amplitude Experiment server-side SDK for JVM (Java, Kotlin)
There is a newer version: 1.6.1
Show newest version
package com.amplitude.experiment

import java.net.Proxy

/**
 * Configuration options. This is an immutable object that can be created using
 * a [RemoteEvaluationConfig.Builder]. Example usage:
 *
 *`ExperimentConfig.builder().setServerUrl("https://api.lab.amplitude.com/").build()`
 */
class RemoteEvaluationConfig internal constructor(
    @JvmField
    val debug: Boolean = Defaults.DEBUG,
    @JvmField
    val serverUrl: String = Defaults.SERVER_URL,
    @JvmField
    val serverZone: ServerZone = Defaults.SERVER_ZONE,
    @JvmField
    val fetchTimeoutMillis: Long = Defaults.FETCH_TIMEOUT_MILLIS,
    @JvmField
    val fetchRetries: Int = Defaults.FETCH_RETRIES,
    @JvmField
    val fetchRetryBackoffMinMillis: Long = Defaults.FETCH_RETRY_BACKOFF_MIN_MILLIS,
    @JvmField
    val fetchRetryBackoffMaxMillis: Long = Defaults.FETCH_RETRY_BACKOFF_MAX_MILLIS,
    @JvmField
    val fetchRetryBackoffScalar: Double = Defaults.FETCH_RETRY_BACKOFF_SCALAR,
    @JvmField
    val httpProxy: Proxy? = Defaults.HTTP_PROXY,
) {

    /**
     * Construct the default [RemoteEvaluationConfig].
     */
    constructor() : this(debug = Defaults.DEBUG)

    /**
     * Defaults for [RemoteEvaluationConfig]
     */
    object Defaults {

        /**
         * false
         */
        const val DEBUG = false

        /**
         * "https://api.lab.amplitude.com/"
         */
        const val SERVER_URL = US_SERVER_URL

        /**
         * ServerZone.US
         */
        val SERVER_ZONE = ServerZone.US

        /**
         * 500
         */
        const val FETCH_TIMEOUT_MILLIS = 500L

        /**
         * 1
         */
        const val FETCH_RETRIES = 1

        /**
         * 0
         */
        const val FETCH_RETRY_BACKOFF_MIN_MILLIS = 0L

        /**
         * 10000
         */
        const val FETCH_RETRY_BACKOFF_MAX_MILLIS = 10000L

        /**
         * 1
         */
        const val FETCH_RETRY_BACKOFF_SCALAR = 1.0

        /**
         * null
         */
        val HTTP_PROXY: Proxy? = null
    }

    companion object {
        @JvmStatic
        fun builder(): Builder {
            return Builder()
        }
    }

    class Builder {

        private var debug = Defaults.DEBUG
        private var serverUrl = Defaults.SERVER_URL
        private var serverZone = Defaults.SERVER_ZONE
        private var fetchTimeoutMillis = Defaults.FETCH_TIMEOUT_MILLIS
        private var fetchRetries = Defaults.FETCH_RETRIES
        private var fetchRetryBackoffMinMillis = Defaults.FETCH_RETRY_BACKOFF_MIN_MILLIS
        private var fetchRetryBackoffMaxMillis = Defaults.FETCH_RETRY_BACKOFF_MAX_MILLIS
        private var fetchRetryBackoffScalar = Defaults.FETCH_RETRY_BACKOFF_SCALAR
        private var httpProxy = Defaults.HTTP_PROXY

        fun debug(debug: Boolean) = apply {
            this.debug = debug
        }

        fun serverUrl(serverUrl: String) = apply {
            this.serverUrl = serverUrl
        }

        fun serverZone(serverZone: ServerZone) = apply {
            this.serverZone = serverZone
        }

        fun fetchTimeoutMillis(fetchTimeoutMillis: Long) = apply {
            this.fetchTimeoutMillis = fetchTimeoutMillis
        }

        fun fetchRetries(fetchRetries: Int) = apply {
            this.fetchRetries = fetchRetries
        }

        fun fetchRetryBackoffMinMillis(fetchRetryBackoffMinMillis: Long) = apply {
            this.fetchRetryBackoffMinMillis = fetchRetryBackoffMinMillis
        }

        fun fetchRetryBackoffMaxMillis(fetchRetryBackoffMaxMillis: Long) = apply {
            this.fetchRetryBackoffMaxMillis = fetchRetryBackoffMaxMillis
        }

        fun fetchRetryBackoffScalar(fetchRetryBackoffScalar: Double) = apply {
            this.fetchRetryBackoffScalar = fetchRetryBackoffScalar
        }

        fun httpProxy(httpProxy: Proxy) = apply {
            this.httpProxy = httpProxy
        }

        fun build(): RemoteEvaluationConfig {
            return RemoteEvaluationConfig(
                debug = debug,
                serverUrl = serverUrl,
                serverZone = serverZone,
                fetchTimeoutMillis = fetchTimeoutMillis,
                fetchRetries = fetchRetries,
                fetchRetryBackoffMinMillis = fetchRetryBackoffMinMillis,
                fetchRetryBackoffMaxMillis = fetchRetryBackoffMaxMillis,
                fetchRetryBackoffScalar = fetchRetryBackoffScalar,
                httpProxy = httpProxy
            )
        }
    }

    override fun toString(): String {
        return "RemoteEvaluationConfig(debug=$debug, serverUrl='$serverUrl', serverZone=$serverZone, " +
            "fetchTimeoutMillis=$fetchTimeoutMillis, fetchRetries=$fetchRetries, " +
            "fetchRetryBackoffMinMillis=$fetchRetryBackoffMinMillis, " +
            "fetchRetryBackoffMaxMillis=$fetchRetryBackoffMaxMillis, " +
            "fetchRetryBackoffScalar=$fetchRetryBackoffScalar, httpProxy=$httpProxy)"
    }
}