Class HealthCheckRegistration

Namespace

Acuit.Pinpoint.HealthChecks

Assembly

Acuit.Pinpoint.HealthChecks.dll

Registration information associated with an IHealthCheck implementation.

public sealed class HealthCheckRegistration

Inheritance

object

HealthCheckRegistration

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Remarks

The health check registration is provided as a separate object so that application developers can customize how health check implementations are configured.

The registration is provided to an IHealthCheck implementation during execution. This allows a health check implementation to access named options or perform other operations based on the registered name.

Constructors

HealthCheckRegistration(string, IHealthCheck)

Creates a new HealthCheckRegistration for an existing IHealthCheck instance.

public HealthCheckRegistration(string name, IHealthCheck instance)

Parameters

name string

The health check name.

instance IHealthCheck

The IHealthCheck instance.

HealthCheckRegistration(string, Func<IHealthCheck>)

Creates a new HealthCheckRegistration for an existing IHealthCheck instance.

public HealthCheckRegistration(string name, Func<IHealthCheck> factory)

Parameters

name string

The health check name.

factory Func<IHealthCheck>

A delegate used to create the IHealthCheck instance.

Properties

Factory

Gets a delegate used to create the IHealthCheck instance.

public Func<IHealthCheck> Factory { get; }

Property Value

Func<IHealthCheck>

Name

Gets the health check name.

public string Name { get; }

Property Value

string