health_check.proto
path phonexia/grpc/common/health_check.proto
package grpc.health.v1
Health check definitions for gRPC API.
Messages
HealthCheckRequest
Request message for checking the health of a service.
| Name | Type | Description |
|---|---|---|
service | string | The name of the service to check. |
HealthCheckResponse
Response message for checking the health of a service.
| Name | Type | Description |
|---|---|---|
status | HealthCheckResponse.ServingStatus | The serving status of the checked service. |
Enums
HealthCheckResponse.ServingStatus
The serving status of the checked service.
| Name | Number | Description |
|---|---|---|
UNKNOWN | 0 | The serving status is unknown. |
SERVING | 1 | The service is serving requests. |
NOT_SERVING | 2 | The service is not serving requests. |
Services
Health
Service for checking the health of a service.
Check
| Method | Check |
|---|---|
| Request | HealthCheckRequest |
| Response | HealthCheckResponse |
| Description | Check the health of a service. |
Watch
| Method | Watch |
|---|---|
| Request | HealthCheckRequest |
| Response | HealthCheckResponse stream |
| Description | Watch the health of a service. Messages about service availability will be periodically sent on the stream. |