health.proto 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. // Copyright 2015 The gRPC Authors
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. // The canonical version of this proto can be found at
  15. // https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto
  16. syntax = "proto3";
  17. package grpc.health.v1;
  18. option csharp_namespace = "Grpc.Health.V1";
  19. option go_package = "google.golang.org/grpc/health/grpc_health_v1";
  20. option java_multiple_files = true;
  21. option java_outer_classname = "HealthProto";
  22. option java_package = "io.grpc.health.v1";
  23. message HealthCheckRequest {
  24. string service = 1;
  25. }
  26. message HealthCheckResponse {
  27. enum ServingStatus {
  28. UNKNOWN = 0;
  29. SERVING = 1;
  30. NOT_SERVING = 2;
  31. SERVICE_UNKNOWN = 3; // Used only by the Watch method.
  32. }
  33. ServingStatus status = 1;
  34. }
  35. service Health {
  36. // If the requested service is unknown, the call will fail with status
  37. // NOT_FOUND.
  38. rpc Check(HealthCheckRequest) returns (HealthCheckResponse);
  39. // Performs a watch for the serving status of the requested service.
  40. // The server will immediately send back a message indicating the current
  41. // serving status. It will then subsequently send a new message whenever
  42. // the service's serving status changes.
  43. //
  44. // If the requested service is unknown when the call is received, the
  45. // server will send a message setting the serving status to
  46. // SERVICE_UNKNOWN but will *not* terminate the call. If at some
  47. // future point, the serving status of the service becomes known, the
  48. // server will send a new message with the service's serving status.
  49. //
  50. // If the call terminates with status UNIMPLEMENTED, then clients
  51. // should assume this method is not supported and should not retry the
  52. // call. If the call terminates with any other status (including OK),
  53. // clients should retry the call with appropriate exponential backoff.
  54. rpc Watch(HealthCheckRequest) returns (stream HealthCheckResponse);
  55. }