Class HealthCheckResult

Namespace

Steeltoe.Common.HealthChecks

Assembly

Steeltoe.Common.Abstractions.dll

The result of a health check

public class HealthCheckResult

Inheritance

object

HealthCheckResult

Derived

HealthEndpointResponse

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

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 or sets details of the checked item

public Dictionary<string, object> Details { get; set; }

Property Value

Dictionary<string, object>

Remarks

For parity with Spring Boot, repeat status [with a call to .ToString()] here

Status

Gets or sets the status of the check

public HealthStatus Status { get; set; }

Property Value

HealthStatus

Remarks

Used by HealthMiddleware to determine HTTP Status code