Interface HealthCheckedGrpcComponents

public interface HealthCheckedGrpcComponents
A collection of components used to check the health of a gRPC server.
Since:
4.1.0
Author:
Phillip Webb
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable HealthCheckedGrpcComponent
    getServer()
    Return the component that represents the overall server health or null if no overall health should be reported.
    @Nullable HealthCheckedGrpcComponent
    getService(String serviceName)
    Return the component for the service with the specified name or null if the name is not known.
    Set<String>
    getServiceNames()
    Return the names of the services that contribute health checks.

  • Method Details

    • getServer

      @Nullable HealthCheckedGrpcComponent getServer()
      Return the component that represents the overall server health or null if no overall health should be reported.
      Returns:
      the server component or null

    • getServiceNames

      Set<String> getServiceNames()
      Return the names of the services that contribute health checks.
      Returns:
      the service names

    • getService

      @Nullable HealthCheckedGrpcComponent getService(String serviceName)
      Return the component for the service with the specified name or null if the name is not known.
      Parameters:
      serviceName - the name of the service
      Returns:
      the service component or null