Class HealthCheckResult
Result of a message bus adapter health check operation.
public sealed class HealthCheckResult
- Inheritance
-
HealthCheckResult
- Inherited Members
- Extension Methods
Constructors
HealthCheckResult(HealthCheckStatus, string)
Initializes a new instance of the HealthCheckResult class with a status.
public HealthCheckResult(HealthCheckStatus status, string description)
Parameters
statusHealthCheckStatusThe health status.
descriptionstringDescription of the health status.
HealthCheckResult(bool, string?, IReadOnlyDictionary<string, object>?)
Initializes a new instance of the HealthCheckResult class.
public HealthCheckResult(bool isHealthy, string? description = null, IReadOnlyDictionary<string, object>? data = null)
Parameters
isHealthyboolWhether the adapter is healthy.
descriptionstringOptional description of the health status.
dataIReadOnlyDictionary<string, object>Optional additional health data.
Properties
Data
Gets additional health data.
public IReadOnlyDictionary<string, object> Data { get; }
Property Value
Description
Gets the description of the health status.
public string Description { get; }
Property Value
IsHealthy
Gets a value indicating whether the adapter is healthy.
public bool IsHealthy { get; }
Property Value
Status
Gets the health status.
public HealthCheckStatus Status { get; }
Property Value
Methods
Degraded(string)
Creates a degraded result.
public static HealthCheckResult Degraded(string description)
Parameters
descriptionstringDescription of the degraded status.
Returns
- HealthCheckResult
A degraded health check result.
Healthy(string?, IReadOnlyDictionary<string, object>?)
Creates a healthy result.
public static HealthCheckResult Healthy(string? description = null, IReadOnlyDictionary<string, object>? data = null)
Parameters
descriptionstringOptional description.
dataIReadOnlyDictionary<string, object>Optional additional data.
Returns
- HealthCheckResult
A healthy health check result.
Unhealthy(string)
Creates an unhealthy result.
public static HealthCheckResult Unhealthy(string description)
Parameters
descriptionstringDescription of the unhealthy status.
Returns
- HealthCheckResult
An unhealthy health check result.