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 15// The canonical version of this proto can be found at 16// https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto 17 18syntax = "proto3"; 19 20package grpc.health.v1; 21 22option csharp_namespace = "Grpc.Health.V1"; 23option go_package = "google.golang.org/grpc/health/grpc_health_v1"; 24option java_multiple_files = true; 25option java_outer_classname = "HealthProto"; 26option java_package = "io.grpc.health.v1"; 27 28message HealthCheckRequest { 29 string service = 1; 30} 31 32message HealthCheckResponse { 33 enum ServingStatus { 34 UNKNOWN = 0; 35 SERVING = 1; 36 NOT_SERVING = 2; 37 SERVICE_UNKNOWN = 3; // Used only by the Watch method. 38 } 39 ServingStatus status = 1; 40} 41 42service Health { 43 // If the requested service is unknown, the call will fail with status 44 // NOT_FOUND. 45 rpc Check(HealthCheckRequest) returns (HealthCheckResponse); 46 47 // Performs a watch for the serving status of the requested service. 48 // The server will immediately send back a message indicating the current 49 // serving status. It will then subsequently send a new message whenever 50 // the service's serving status changes. 51 // 52 // If the requested service is unknown when the call is received, the 53 // server will send a message setting the serving status to 54 // SERVICE_UNKNOWN but will *not* terminate the call. If at some 55 // future point, the serving status of the service becomes known, the 56 // server will send a new message with the service's serving status. 57 // 58 // If the call terminates with status UNIMPLEMENTED, then clients 59 // should assume this method is not supported and should not retry the 60 // call. If the call terminates with any other status (including OK), 61 // clients should retry the call with appropriate exponential backoff. 62 rpc Watch(HealthCheckRequest) returns (stream HealthCheckResponse); 63} 64