io.servicetalk.health.v1

Interface Health.BlockingHealthClient

All Superinterfaces:

AutoCloseable, BlockingGrpcClient<Health.HealthClient>, GracefulAutoCloseable

Enclosing class:

Health

public static interface Health.BlockingHealthClient
extends BlockingGrpcClient<Health.HealthClient>

Method Summary

Modifier and Type	Method and Description
default HealthCheckResponse	check(GrpcClientMetadata metadata, HealthCheckRequest request) If the requested service is unknown, the call will fail with status NOT_FOUND.
default HealthCheckResponse	check(Health.CheckMetadata metadata, HealthCheckRequest request) Deprecated. Use check(GrpcClientMetadata,HealthCheckRequest).
HealthCheckResponse	check(HealthCheckRequest request) If the requested service is unknown, the call will fail with status NOT_FOUND.
default BlockingIterable<HealthCheckResponse>	watch(GrpcClientMetadata metadata, HealthCheckRequest request) Performs a watch for the serving status of the requested service.
default BlockingIterable<HealthCheckResponse>	watch(Health.WatchMetadata metadata, HealthCheckRequest request) Deprecated. Use watch(GrpcClientMetadata,HealthCheckRequest).
BlockingIterable<HealthCheckResponse>	watch(HealthCheckRequest request) Performs a watch for the serving status of the requested service.

Methods inherited from interface BlockingGrpcClient

asClient, executionContext

Methods inherited from interface GracefulAutoCloseable

closeGracefully

Methods inherited from interface AutoCloseable

close

Method Detail

check

HealthCheckResponse check(HealthCheckRequest request)
                   throws Exception

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

Parameters:

request - the request from the client.

Returns:

the response from the server.

Throws:

Exception - if an unexpected application error occurs.

GrpcStatusException - if an expected application exception occurs. Its contents will be serialized and propagated to the peer.

check

@Deprecated
default HealthCheckResponse check(Health.CheckMetadata metadata,
                                              HealthCheckRequest request)
                                       throws Exception

Deprecated. Use check(GrpcClientMetadata,HealthCheckRequest).

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

Parameters:

metadata - the metadata associated with this client call.

request - the request from the client.

Returns:

the response from the server.

Throws:

Exception - if an unexpected application error occurs.

GrpcStatusException - if an expected application exception occurs. Its contents will be serialized and propagated to the peer.

check

default HealthCheckResponse check(GrpcClientMetadata metadata,
                                  HealthCheckRequest request)
                           throws Exception

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

Parameters:

metadata - the metadata associated with this client call.

request - the request from the client.

Returns:

the response from the server.

Throws:

Exception - if an unexpected application error occurs.

GrpcStatusException - if an expected application exception occurs. Its contents will be serialized and propagated to the peer.

watch

BlockingIterable<HealthCheckResponse> watch(HealthCheckRequest request)
                                     throws Exception

  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.
 

Parameters:

request - the request from the client.

Returns:

used to read the response stream of type HealthCheckResponse from the server.

Throws:

Exception - if an unexpected application error occurs.

GrpcStatusException - if an expected application exception occurs. Its contents will be serialized and propagated to the peer.

watch

@Deprecated
default BlockingIterable<HealthCheckResponse> watch(Health.WatchMetadata metadata,
                                                                HealthCheckRequest request)
                                                         throws Exception

Deprecated. Use watch(GrpcClientMetadata,HealthCheckRequest).

  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.
 

Parameters:

metadata - the metadata associated with this client call.

request - the request from the client.

Returns:

used to read the response stream of type HealthCheckResponse from the server.

Throws:

Exception - if an unexpected application error occurs.

GrpcStatusException - if an expected application exception occurs. Its contents will be serialized and propagated to the peer.

watch

default BlockingIterable<HealthCheckResponse> watch(GrpcClientMetadata metadata,
                                                    HealthCheckRequest request)
                                             throws Exception

  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.
 

Parameters:

metadata - the metadata associated with this client call.

request - the request from the client.

Returns:

used to read the response stream of type HealthCheckResponse from the server.

Throws:

Exception - if an unexpected application error occurs.

GrpcStatusException - if an expected application exception occurs. Its contents will be serialized and propagated to the peer.