Package org.apache.pinot.server.api.resources

Class HealthCheckResource

java.lang.Object

org.apache.pinot.server.api.resources.HealthCheckResource

@Path("/")
public class HealthCheckResource
extends Object

REST API to do health check through ServiceStatus.

Constructor Summary

Constructors

Constructor	Description
HealthCheckResource()

Method Summary

Modifier and Type	Method	Description
String	checkHealth(String checkType)
String	checkLiveness()
String	checkReadiness()

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheckResource

public HealthCheckResource()

Method Detail

checkHealth

@GET
@Path("/health")
@Produces("text/plain")
public String checkHealth(@QueryParam("checkType")
                          String checkType)

checkLiveness

@GET
@Path("/health/liveness")
@Produces("text/plain")
public String checkLiveness()

checkReadiness

@GET
@Path("/health/readiness")
@Produces("text/plain")
public String checkReadiness()