Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.model/HealthConfig

HealthConfig

@Serializable

data class HealthConfig(val test: List<String>? = null, val interval: Long? = null, val timeout: Long? = null, val retries: Int? = null, val startPeriod: Long? = null, val startInterval: Long? = null)

A test to perform to check that the container is healthy.

Parameters

test

The test to perform. Possible values are: - [] inherit healthcheck from image or parent image - [\"NONE\"] disable healthcheck - [\"CMD\", args...] exec arguments directly - [\"CMD-SHELL\", command] run command with system's default shell

interval

The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

timeout

The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

retries

The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.

startPeriod

Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

startInterval

The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

Constructors

HealthConfig

constructor(test: List<String>? = null, interval: Long? = null, timeout: Long? = null, retries: Int? = null, startPeriod: Long? = null, startInterval: Long? = null)