Health

@Serializable
data class Health(val status: Health.Status? = null, val failingStreak: Int? = null, val log: List<HealthcheckResult>? = null)

Health stores information about the container's healthcheck results.

Parameters

status

Status is one of none, starting, healthy or unhealthy - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem

failingStreak

FailingStreak is the number of consecutive failures

log

Log contains the last few results (oldest first)

Constructors

Link copied to clipboard
constructor(status: Health.Status? = null, failingStreak: Int? = null, log: List<HealthcheckResult>? = null)

Types

Link copied to clipboard
@Serializable
enum Status : Enum<Health.Status>

Status is one of none, starting, healthy or unhealthy - \"none\" Indicates there is no healthcheck - \"starting\" Starting indicates that the container is not yet ready - \"healthy\" Healthy indicates that the container is running correctly - \"unhealthy\" Unhealthy indicates that the container has a problem

Properties

Link copied to clipboard
@SerialName(value = "FailingStreak")
val failingStreak: Int?
Link copied to clipboard
@SerialName(value = "Log")
val log: List<HealthcheckResult>?
Link copied to clipboard
@SerialName(value = "Status")
val status: Health.Status?