Package io.grpc.health.v1

Class HealthGrpc.HealthBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<HealthGrpc.HealthBlockingStub>

io.grpc.health.v1.HealthGrpc.HealthBlockingStub

Enclosing class:

HealthGrpc

public static final class HealthGrpc.HealthBlockingStub
extends 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

AbstractStub.StubFactory<T extends AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
protected HealthGrpc.HealthBlockingStub	build(Channel channel, CallOptions callOptions)	Returns a new stub with the given channel for the provided method configurations.
HealthCheckResponse	check(HealthCheckRequest request)	If the requested service is unknown, the call will fail with status NOT_FOUND.
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, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected HealthGrpc.HealthBlockingStub build(Channel channel,
                                              CallOptions callOptions)

Description copied from class: AbstractStub

Returns a new stub with the given channel for the provided method configurations.

Specified by:

build in class AbstractStub<HealthGrpc.HealthBlockingStub>

Parameters:

channel - the channel that this stub will use to do communications

callOptions - the runtime call options to be applied to every call on this stub

check

public HealthCheckResponse check(HealthCheckRequest request)

 If the requested service is unknown, the call will fail with status
 NOT_FOUND.
 

watch

public 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.