Table of Contents

Class HealthEndpointResponse

Namespace
Steeltoe.Management.Endpoint.Actuators.Health
Assembly
Steeltoe.Management.Endpoint.dll
public sealed class HealthEndpointResponse
Inheritance
HealthEndpointResponse
Inherited Members

Constructors

HealthEndpointResponse()

public HealthEndpointResponse()

HealthEndpointResponse(HealthCheckResult)

public HealthEndpointResponse(HealthCheckResult result)

Parameters

result HealthCheckResult

Properties

Components

Gets the individual health check components, including their details.

public IDictionary<string, HealthCheckResult> Components { get; }

Property Value

IDictionary<string, HealthCheckResult>

Description

Gets a description of the health check result.

public string? Description { get; init; }

Property Value

string

Exists

Gets a value indicating whether a health response exists.

[JsonIgnore]
public bool Exists { get; init; }

Property Value

bool

Groups

Gets the list of available health groups.

public IList<string> Groups { get; }

Property Value

IList<string>

Status

Gets the status of the health check.

[JsonConverter(typeof(SnakeCaseAllCapsEnumMemberJsonConverter))]
public HealthStatus Status { get; init; }

Property Value

HealthStatus