X

Class HealthCheckResult

The result of a health check

Inheritance
System.Object
HealthCheckResult
Namespace: Steeltoe.Common.HealthChecks
Assembly: Steeltoe.Common.Abstractions.dll
Syntax
public class HealthCheckResult : object

Properties

| Edit this page View Source

Description

Gets or sets a description of the health check result

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String
Remarks

Currently only used on check failures

| Edit this page View Source

Details

Gets or sets details of the checked item

Declaration
public Dictionary<string, object> Details { get; set; }
Property Value
Type Description
Dictionary<System.String, System.Object>
Remarks

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

| Edit this page View Source

Status

Gets or sets the status of the check

Declaration
public HealthStatus Status { get; set; }
Property Value
Type Description
HealthStatus
Remarks

Used by HealthMiddleware to determine HTTP Status code