23.284. Class GrpcHealthChecksService
Namespace: ArmoniK.Core.Common.gRPC.Services
Assembly: ArmoniK.Core.Common.dll
The HealthChecksService provides methods to verify the health of the cluster.
[Authorize(AuthenticationSchemes = "ArmoniKAuthenticationScheme")]
public class GrpcHealthChecksService : HealthChecksService.HealthChecksServiceBase
23.284.1. Inheritance
object ← HealthChecksService.HealthChecksServiceBase ← GrpcHealthChecksService
23.284.2. Inherited Members
HealthChecksService.HealthChecksServiceBase.CheckHealth(CheckHealthRequest, ServerCallContext), object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
23.284.3. Constructors
23.284.3.1. GrpcHealthChecksService(ITaskTable, IObjectStorage, IPushQueueStorage, FunctionExecutionMetrics<GrpcHealthChecksService>)
Initializes a new instance of the
public GrpcHealthChecksService(ITaskTable taskTable, IObjectStorage objectStorage, IPushQueueStorage queueStorage, FunctionExecutionMetrics<GrpcHealthChecksService> meter)
23.284.3.1.1. Parameters
taskTable ITaskTable
The task table for checking database health.
objectStorage IObjectStorage
The object storage for checking storage health.
queueStorage IPushQueueStorage
The queue storage for checking queue health.
meter FunctionExecutionMetrics<GrpcHealthChecksService>
The metrics for function execution.
23.284.4. Methods
23.284.4.1. CheckHealth(CheckHealthRequest, ServerCallContext)
Checks the health of various services.
[RequiresPermission(typeof(GrpcHealthChecksService), "CheckHealth")]
public override Task<CheckHealthResponse> CheckHealth(CheckHealthRequest request, ServerCallContext context)
23.284.4.1.1. Parameters
request CheckHealthRequest
The health check request.
context ServerCallContext
The server call context.
23.284.4.1.2. Returns
Task<CheckHealthResponse>
A task representing the asynchronous operation, with a