Health#

Generated reference

Source file:: ansys/api/fluent/v1/health.proto
Proto package:: ansys.api.fluent.v1.health
Contains:: 1 service, 2 messages

Services

Service: Health

Health service provides methods to query and watch service health.

Check

Request:: HealthCheckRequest
Response:: HealthCheckResponse

Returns the current serving status of the specified service. If the requested service is unknown, the call will fail with status NOT_FOUND.

Watch

Request:: HealthCheckRequest
Response:: stream of HealthCheckResponse

Performs a watch for the serving status of the requested service. The server will immediately send back a message indicating the current serving status. It will then subsequently send a new message whenever the service’s serving status changes.

If the requested service is unknown when the call is received, the server will send a message setting the serving status to SERVICE_UNKNOWN but will not terminate the call. If at some future point, the serving status of the service becomes known, the server will send a new message with the service’s serving status.

If the call terminates with status UNIMPLEMENTED, then clients should assume this method is not supported and should not retry the call. If the call terminates with any other status (including OK), clients should retry the call with appropriate exponential backoff.

Messages

HealthCheckRequest

HealthCheckRequest specifies the target service to check.

service (1)string: Service name to check. If empty, the server may return the overall process status depending on implementation.

HealthCheckResponse

HealthCheckResponse returns the serving status for the requested service.

status (1)ServingStatus: The serving status of the requested service.

HealthCheckResponse.ServingStatus (enum)

ServingStatus indicates whether a service is able to serve requests.

SERVING_STATUS_UNSPECIFIED (0): Default value. Serving status is unspecified.
SERVING_STATUS_SERVING (1): The service is currently serving requests.
SERVING_STATUS_NOT_SERVING (2): The service is not currently serving requests.
SERVING_STATUS_SERVICE_UNKNOWN (3): Used only by the Watch method when the requested service is unknown. Used only by the Watch method.