bloombox / bloombox.client / Bloombox / Settings

Settings

data class Settings (source)

Specifies client settings that can be passed in to modify RPC behavior.

Constructors

<init>

Settings(apiKey: String, partner: String? = null, location: String? = null, device: String? = null, region: APIRegion = APIRegion.USW1, enableLogging: Boolean = false, environment: APIEnvironment = APIEnvironment.PRODUCTION, executor: Executor = Executors.newSingleThreadExecutor(), requestTimeout: Duration = Duration.ofSeconds(defaultRequestTimeoutDuration), closeTimeout: Duration = Duration.ofSeconds(defaultCloseTimeoutDuration), clientCredentials: ClientCredentials? = null)

Specifies client settings that can be passed in to modify RPC behavior.

Companion Object Functions

defaults

fun defaults(apiKey: String, partner: String, location: String): Settings

Generate default settings for a given partner, location, and API key, which is the minimum amount of configuration for a given API settings instance.

withLogging

fun withLogging(apiKey: String, partner: String, location: String): Settings

Generate default settings for a given partner, location, and API key, which is the minimum amount of configuration for a given API settings instance.