lib/computer.iroh/ServicesOptions

ServicesOptions

data class ServicesOptions(var apiSecret: String? = null, var apiSecretFromEnv: Boolean? = null, var sshKeyPem: String? = null, var name: String? = null, var metricsIntervalMs: ULong? = null)

Build options for `ServicesClient`.

Supply exactly one of api_secret, api_secret_from_env, or ssh_key_pem for the credential. api_secret_from_env (when true) reads the IROH_SERVICES_API_SECRET environment variable. If a name is provided it is registered with the service; the name must be 2–128 UTF-8 bytes.

Constructors

Link copied to clipboard
constructor(apiSecret: String? = null, apiSecretFromEnv: Boolean? = null, sshKeyPem: String? = null, name: String? = null, metricsIntervalMs: ULong? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var apiSecret: String?

Encoded API secret string (services1...). Sets both the remote endpoint to dial and the per-client capability.

Link copied to clipboard
var apiSecretFromEnv: Boolean?

If true, read the API secret from IROH_SERVICES_API_SECRET.

Link copied to clipboard
var metricsIntervalMs: ULong?

How often (in milliseconds) to push metrics to the service. 0 disables automatic interval pushes; if omitted the upstream default applies.

Link copied to clipboard
var name: String?

Optional endpoint name to register cloud-side.

Link copied to clipboard
var sshKeyPem: String?

Unencrypted PEM-encoded OpenSSH ed25519 private key. Grants full capabilities; used by node operators / project owners.