Class AvailabilityHealthContributor

Namespace

Steeltoe.Common.Availability

Assembly

Steeltoe.Common.dll

public abstract class AvailabilityHealthContributor : IHealthContributor

Inheritance

object

AvailabilityHealthContributor

Implements

IHealthContributor

Derived

LivenessHealthContributor

ReadinessHealthContributor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AvailabilityHealthContributor(Dictionary<IAvailabilityState, HealthStatus>, ILogger)

protected AvailabilityHealthContributor(Dictionary<IAvailabilityState, HealthStatus> stateMappings, ILogger logger = null)

Parameters

stateMappings Dictionary<IAvailabilityState, HealthStatus>

logger ILogger

Properties

Id

Gets an identifier for the type of check being performed

public virtual string Id { get; }

Property Value

string

Methods

GetState()

protected virtual IAvailabilityState GetState()

Returns

IAvailabilityState

Health()

Check the health of a resource

public HealthCheckResult Health()

Returns

HealthCheckResult

The result of checking the health of a resource