Package org.gcube.common.health.api.response

Class HealthCheckResponse

java.lang.Object

org.gcube.common.health.api.response.HealthCheckResponse

public class HealthCheckResponse
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	data	Structured data of the check (values are strings, numbers, booleans or lists of them), absent when there is none.
protected String	description	What the check verifies, from HealthCheck.getDescription().
protected String	errorMessage
protected String	info
protected String	name
protected Status	status

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HealthCheckResponse()

Method Summary

Modifier and Type	Method	Description
static HealthCheckResponseBuilder	builder(String checkName)
Map<String,Object>	getData()	Returns the structured data of the check, e.g. the Contexts a service runs in.
String	getDescription()	Returns what the check verifies.
String	getErrorMessage()
String	getInfo()
String	getName()
Status	getStatus()
void	setDescription(String description)	Sets what the check verifies: the runner of the checks copies it from the check.

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

description

protected String description

What the check verifies, from HealthCheck.getDescription().

status

protected Status status

errorMessage

protected String errorMessage

info

protected String info

data

protected Map<String,Object> data

Structured data of the check (values are strings, numbers, booleans or lists of them), absent when there is none.

Constructor Details

HealthCheckResponse

protected HealthCheckResponse()

Method Details

builder

public static HealthCheckResponseBuilder builder(String checkName)

getStatus

public Status getStatus()

getName

public String getName()

getDescription

public String getDescription()

Returns what the check verifies.

Returns:

the description, or null when the check gives none

setDescription

public void setDescription(String description)

Sets what the check verifies: the runner of the checks copies it from the check.

Parameters:

description - the description of the check

getErrorMessage

public String getErrorMessage()

getInfo

public String getInfo()

getData

public Map<String,Object> getData()

Returns the structured data of the check, e.g. the Contexts a service runs in.

Returns:

the data, or null when the check gives none