io.servicetalk.health.v1

Interface Health.CheckRpc

All Superinterfaces:

AsyncCloseable, GrpcService

All Known Subinterfaces:

Health.HealthService

All Known Implementing Classes:

DefaultHealthService

Enclosing class:

Health

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface Health.CheckRpc
extends GrpcService

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH Deprecated. Use methodDescriptor().

Method Summary

Modifier and Type	Method and Description
Single<HealthCheckResponse>	check(GrpcServiceContext ctx, HealthCheckRequest request) If the requested service is unknown, the call will fail with status NOT_FOUND.
static MethodDescriptor<HealthCheckRequest,HealthCheckResponse>	methodDescriptor()

Methods inherited from interface GrpcService

closeAsync

Methods inherited from interface AsyncCloseable

closeAsyncGracefully

Field Detail

PATH

@Deprecated
static final String PATH

Deprecated. Use methodDescriptor().

See Also:

Constant Field Values

Method Detail

methodDescriptor

static MethodDescriptor<HealthCheckRequest,HealthCheckResponse> methodDescriptor()

check

Single<HealthCheckResponse> check(GrpcServiceContext ctx,
                                  HealthCheckRequest request)

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

Parameters:

ctx - context associated with this service and request.

request - the request from the client.

Returns:

a Single which sends the response to the client when it terminates.