Package org.apache.gravitino.dto.responses

Class HealthResponse

java.lang.Object

org.apache.gravitino.dto.responses.BaseResponse

org.apache.gravitino.dto.responses.HealthResponse

All Implemented Interfaces:

RESTMessage, RESTResponse

public class HealthResponse
extends BaseResponse

Represents a response containing aggregate health status and per-check results.

Constructor Summary

Constructors

Constructor	Description
HealthResponse()	Default constructor for HealthResponse.
HealthResponse(HealthCheckDTO.Status status, List<HealthCheckDTO> checks)	Constructor for HealthResponse.

Method Summary

Modifier and Type	Method	Description
boolean	isUp()	Returns true if the aggregate status is UP.
void	validate()	Validates the response data.

Methods inherited from class java.lang.Object

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

Constructor Details

HealthResponse

public HealthResponse(HealthCheckDTO.Status status,
 List<HealthCheckDTO> checks)

Constructor for HealthResponse.

Parameters:

status - aggregate health status

checks - per-check results; null is coerced to empty list

HealthResponse

public HealthResponse()

Default constructor for HealthResponse. (Used for Jackson deserialization.)

Method Details

validate

public void validate()
              throws IllegalArgumentException

Validates the response data.

Specified by:

validate in interface RESTMessage

Overrides:

validate in class BaseResponse

Throws:

IllegalArgumentException - if status or checks are not set.

isUp

public boolean isUp()

Returns true if the aggregate status is UP.

Returns:

true if the aggregate status is UP, false otherwise