Package io.grpc.health.v1

Class HealthGrpc.HealthBlockingStub

  • Enclosing class:
    HealthGrpc
    public static final class HealthGrpc.HealthBlockingStub
extends io.grpc.stub.AbstractBlockingStub<HealthGrpc.HealthBlockingStub>
    A stub to allow clients to do synchronous rpc calls to service Health.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

        io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected HealthGrpc.HealthBlockingStub build​(io.grpc.Channel channel, io.grpc.CallOptions callOptions)  
      HealthCheckResponse check​(HealthCheckRequest request)
      If the requested service is unknown, the call will fail with status NOT_FOUND.
      java.util.Iterator<HealthCheckResponse> watch​(HealthCheckRequest request)
      Performs a watch for the serving status of the requested service.

      • Methods inherited from class io.grpc.stub.AbstractBlockingStub

        newStub, newStub

      • Methods inherited from class io.grpc.stub.AbstractStub

        getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • watch

        public java.util.Iterator<HealthCheckResponse> watch​(HealthCheckRequest request)
         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.