Package io.servicetalk.health.v1

Interface Health.HealthClient

All Superinterfaces:
AsyncCloseable, AutoCloseable, GracefulAutoCloseable, GrpcClient<Health.BlockingHealthClient>, ListenableAsyncCloseable
Enclosing class:
Health
public static interface Health.HealthClient extends GrpcClient<Health.BlockingHealthClient>

  • Method Details

    • check

      Single<HealthCheckResponse> check(HealthCheckRequest request)
        If the requested service is unknown, the call will fail with status
  NOT_FOUND.
      Parameters:
      request - the request to send to the server.
      Returns:
      a Single which completes when the response is received from the server.

    • check

      default Single<HealthCheckResponse> check(GrpcClientMetadata metadata, HealthCheckRequest request)
        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 to send to the server.
      Returns:
      a Single which completes when the response is received from the server.

    • check

      @Deprecated default Single<HealthCheckResponse> check(Health.CheckMetadata metadata, HealthCheckRequest request)
      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 to send to the server.
      Returns:
      a Single which completes when the response is received from the server.

    • watch

      Publisher<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.
      Parameters:
      request - the request to send to the server.
      Returns:
      used to read a stream of type HealthCheckResponse from the server.

    • watch

      default Publisher<HealthCheckResponse> watch(GrpcClientMetadata metadata, 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.
      Parameters:
      metadata - the metadata associated with this client call.
      request - the request to send to the server.
      Returns:
      used to read a stream of type HealthCheckResponse from the server.

    • watch

      @Deprecated default Publisher<HealthCheckResponse> watch(Health.WatchMetadata metadata, HealthCheckRequest request)
      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 to send to the server.
      Returns:
      used to read a stream of type HealthCheckResponse from the server.

    • asBlockingClient

      default Health.BlockingHealthClient asBlockingClient()
      Description copied from interface: GrpcClient
      Converts this GrpcClient to a blocking client.
      Specified by:
      asBlockingClient in interface GrpcClient<Health.BlockingHealthClient>
      Returns:
      This GrpcClient as a GrpcClient.