TypeSafeClientOptions

@ApiStatus.Experimental
class TypeSafeClientOptions : Record

Where TypeSafe lives and how long to wait for it. None of these settings are secret.

The timeouts apply when the factory builds its own HTTP client. An application client keeps its own timeouts. The response limit applies either way.

Parameters

baseUri

the TypeSafe address, without user info, a query or a fragment

connectTimeout

how long to wait for a connection, from 1 ms to MAX_VALUE ms

readTimeout

how long to wait for data once connected, with the same limits

maxResponseBytes

the largest response body that will be read

Constructors

Link copied to clipboard
constructor(baseUri: URI, connectTimeout: Duration, readTimeout: Duration, maxResponseBytes: Int)
Checks the settings without resolving a key or opening a connection.

Functions

Link copied to clipboard
Returns the settings for https://api.typesafe.ai, with 10 second timeouts and a 1 MiB response limit.
Link copied to clipboard
abstract fun equals(p: Any): Boolean
Link copied to clipboard
abstract fun hashCode(): Int
Link copied to clipboard
open fun toString(): String
Leaves the address out, since a gateway path can be private.