Class HealthResponse

java.lang.Object

com.kingsrook.qqq.middleware.health.model.metadata.HealthResponse

public class HealthResponse
extends Object

Overall health check response containing the aggregate status and results from all individual health indicators. This is the JSON response sent to clients hitting the /health endpoint.

Constructor Summary

Constructors

Constructor	Description
HealthResponse()	Constructor

Method Summary

Modifier and Type	Method	Description
Map<String,HealthCheckResult>	getChecks()	Getter for checks
HealthStatus	getStatus()	Getter for status
Instant	getTimestamp()	Getter for timestamp
void	setChecks(Map<String,HealthCheckResult> checks)	Setter for checks
void	setStatus(HealthStatus status)	Setter for status
void	setTimestamp(Instant timestamp)	Setter for timestamp
HealthResponse	withCheck(String name, HealthCheckResult result)	Add a single check result
HealthResponse	withChecks(Map<String,HealthCheckResult> checks)	Fluent setter for checks
HealthResponse	withStatus(HealthStatus status)	Fluent setter for status
HealthResponse	withTimestamp(Instant timestamp)	Fluent setter for timestamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HealthResponse

public HealthResponse()

Constructor

Method Details

withStatus

public HealthResponse withStatus(HealthStatus status)

Fluent setter for status

withTimestamp

public HealthResponse withTimestamp(Instant timestamp)

Fluent setter for timestamp

withChecks

public HealthResponse withChecks(Map<String,HealthCheckResult> checks)

Fluent setter for checks

withCheck

public HealthResponse withCheck(String name,
 HealthCheckResult result)

Add a single check result

getStatus

public HealthStatus getStatus()

Getter for status

setStatus

public void setStatus(HealthStatus status)

Setter for status

getTimestamp

public Instant getTimestamp()

Getter for timestamp

setTimestamp

public void setTimestamp(Instant timestamp)

Setter for timestamp

getChecks

public Map<String,HealthCheckResult> getChecks()

Getter for checks

setChecks

public void setChecks(Map<String,HealthCheckResult> checks)

Setter for checks