Table of Contents

Class HealthCheckResult

Namespace
Excalibur.Dispatch.Transport
Assembly
Excalibur.Dispatch.Abstractions.dll

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

status HealthCheckStatus

The health status.

description string

Description 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

isHealthy bool

Whether the adapter is healthy.

description string

Optional description of the health status.

data IReadOnlyDictionary<string, object>

Optional additional health data.

Properties

Data

Gets additional health data.

public IReadOnlyDictionary<string, object> Data { get; }

Property Value

IReadOnlyDictionary<string, object>

Description

Gets the description of the health status.

public string Description { get; }

Property Value

string

IsHealthy

Gets a value indicating whether the adapter is healthy.

public bool IsHealthy { get; }

Property Value

bool

Status

Gets the health status.

public HealthCheckStatus Status { get; }

Property Value

HealthCheckStatus

Methods

Degraded(string)

Creates a degraded result.

public static HealthCheckResult Degraded(string description)

Parameters

description string

Description 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

description string

Optional description.

data IReadOnlyDictionary<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

description string

Description of the unhealthy status.

Returns

HealthCheckResult

An unhealthy health check result.