17.282. Class GrpcHealthChecksService

Namespace: ArmoniK.Core.Common.gRPC.Services
Assembly: ArmoniK.Core.Common.dll

[Authorize(AuthenticationSchemes = "ArmoniKAuthenticationScheme")]
public class GrpcHealthChecksService : HealthChecksService.HealthChecksServiceBase

17.282.1. Inheritance

object ← HealthChecksService.HealthChecksServiceBase ← GrpcHealthChecksService

17.282.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()

17.282.3. Constructors

17.282.3.1. GrpcHealthChecksService(ITaskTable, IObjectStorage, IPushQueueStorage, FunctionExecutionMetrics<GrpcHealthChecksService>)

public GrpcHealthChecksService(ITaskTable taskTable, IObjectStorage objectStorage, IPushQueueStorage queueStorage, FunctionExecutionMetrics<GrpcHealthChecksService> meter)

17.282.3.1.1. Parameters

taskTable ITaskTable

objectStorage IObjectStorage

queueStorage IPushQueueStorage

meter FunctionExecutionMetrics<GrpcHealthChecksService>

17.282.4. Methods

17.282.4.1. CheckHealth(CheckHealthRequest, ServerCallContext)

Checks the health of the cluster. This can be used to verify that the cluster is up and running.

[RequiresPermission(typeof(GrpcHealthChecksService), "CheckHealth")]
public override Task<CheckHealthResponse> CheckHealth(CheckHealthRequest request, ServerCallContext context)

17.282.4.1.1. Parameters

request CheckHealthRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

17.282.4.1.2. Returns

Task<CheckHealthResponse>

The response to send back to the client (wrapped by a task).