Package com.grpc.health.v1

Class HealthGrpc.HealthFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<HealthGrpc.HealthFutureStub>
com.grpc.health.v1.HealthGrpc.HealthFutureStub
Enclosing class:
HealthGrpc
public static final class HealthGrpc.HealthFutureStub extends io.grpc.stub.AbstractFutureStub<HealthGrpc.HealthFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service Health. 
 Health is gRPC's mechanism for checking whether a server is able to handle
 RPCs. Its semantics are documented in
 https://github.com/grpc/grpc/blob/master/doc/health-checking.md.

  • 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

    Modifier and Type
    Method
    Description
    protected HealthGrpc.HealthFutureStub
    build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
     
    com.google.common.util.concurrent.ListenableFuture<HealthCheckResponse>
    check(HealthCheckRequest request)
    Check gets the health of the specified service.

    Methods inherited from class io.grpc.stub.AbstractFutureStub

    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 Details

    • build

      protected HealthGrpc.HealthFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<HealthGrpc.HealthFutureStub>

    • check

      public com.google.common.util.concurrent.ListenableFuture<HealthCheckResponse> check(HealthCheckRequest request)
       Check gets the health of the specified service. If the requested service
 is unknown, the call will fail with status NOT_FOUND. If the caller does
 not specify a service name, the server should respond with its overall
 health status.
 Clients should set a deadline when calling Check, and can declare the
 server unhealthy if they do not receive a timely response.
 Check implementations should be idempotent and side effect free.