Package com.linecorp.armeria.server.grpc

Class GrpcHealthCheckServiceBuilder

java.lang.Object

com.linecorp.armeria.server.grpc.GrpcHealthCheckServiceBuilder

@UnstableApi
public final class GrpcHealthCheckServiceBuilder
extends Object

Builds a GrpcHealthCheckService.

Method Summary

Modifier and Type	Method	Description
GrpcHealthCheckService	build()	Returns a newly created GrpcHealthCheckService built from the properties specified so far.
GrpcHealthCheckServiceBuilder	checkers(ListenableHealthChecker... serverHealthCheckers)	Adds the specified ListenableHealthCheckers that determine the healthiness of the Server.
GrpcHealthCheckServiceBuilder	checkers(Iterable<? extends ListenableHealthChecker> serverHealthCheckers)	Adds the specified ListenableHealthCheckers that determine the healthiness of the Server.
GrpcHealthCheckServiceBuilder	serviceCheckers(String serviceName, ListenableHealthChecker healthChecker)	Adds the pair of the service name and the ListenableHealthChecker that determine the healthiness of the specified gRPC service.
GrpcHealthCheckServiceBuilder	updateListener(HealthCheckUpdateListener updateListener)	Adds a HealthCheckUpdateListener which is invoked when the healthiness of the Server is updated.

Methods inherited from class java.lang.Object

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

Method Details

checkers

public GrpcHealthCheckServiceBuilder checkers(ListenableHealthChecker... serverHealthCheckers)

Adds the specified ListenableHealthCheckers that determine the healthiness of the Server.

checkers

public GrpcHealthCheckServiceBuilder checkers(Iterable<? extends ListenableHealthChecker> serverHealthCheckers)

Adds the specified ListenableHealthCheckers that determine the healthiness of the Server.

serviceCheckers

public GrpcHealthCheckServiceBuilder serviceCheckers(String serviceName,
 ListenableHealthChecker healthChecker)

Adds the pair of the service name and the ListenableHealthChecker that determine the healthiness of the specified gRPC service. The specified health checker is not used for determining the healthiness of the Server.

Note: The suggested format of service name is `package_names.ServiceName`. For example, If the proto package that defines `HelloService` belongs to `com.example`, the service name is `com.example.HelloService`

updateListener

public GrpcHealthCheckServiceBuilder updateListener(HealthCheckUpdateListener updateListener)

Adds a HealthCheckUpdateListener which is invoked when the healthiness of the Server is updated.

build

public GrpcHealthCheckService build()

Returns a newly created GrpcHealthCheckService built from the properties specified so far.