X

Class HealthCheckResult

The result of a health check.

Inheritance
System.Object
HealthCheckResult
Namespace: Steeltoe.Common.HealthChecks
Assembly: Steeltoe.Common.dll
Syntax
public sealed 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.Nullable<System.String>
Remarks

Currently only used on check failures.

| Edit this page View Source

Details

Gets details of the health check.

Declaration
public IDictionary<string, object> Details { get; }
Property Value
Type Description
IDictionary<System.String, System.Object>
| Edit this page View Source

Status

Gets or sets the status of the health check.

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

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