Class HealthCheckResult

Namespace

Steeltoe.Common.HealthChecks

Assembly

Steeltoe.Common.dll

The result of a health check.

public sealed class HealthCheckResult

Inheritance

object

HealthCheckResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Description

Gets or sets a description of the health check result.

public string? Description { get; set; }

Property Value

string

Remarks

Currently only used on check failures.

Details

Gets details of the health check.

public IDictionary<string, object> Details { get; }

Property Value

IDictionary<string, object>

Status

Gets or sets the status of the health check.

[JsonConverter(typeof(SnakeCaseAllCapsEnumMemberJsonConverter))]
public HealthStatus Status { get; set; }

Property Value

HealthStatus

Remarks

Used by the health middleware to determine the HTTP Status code.