Class HealthEndpointResponse

Inheritance

System.Object

HealthEndpointResponse

Namespace: Steeltoe.Management.Endpoint.Actuators.Health

Assembly: Steeltoe.Management.Endpoint.dll

Syntax

public sealed class HealthEndpointResponse : object

Constructors

HealthEndpointResponse()

Declaration

public HealthEndpointResponse()

HealthEndpointResponse(HealthCheckResult)

Declaration

public HealthEndpointResponse(HealthCheckResult result)

Parameters

Type	Name	Description
HealthCheckResult	result

Properties

Components

Gets the individual health check components, including their details.

Declaration

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

Property Value

Type	Description
IDictionary<System.String, HealthCheckResult>

Description

Gets a description of the health check result.

Declaration

public string? Description { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Exists

Gets a value indicating whether a health response exists.

Declaration

public bool Exists { get; set; }

Property Value

Type	Description
System.Boolean

Groups

Gets the list of available health groups.

Declaration

public IList<string> Groups { get; }

Property Value

Type	Description
IList<System.String>

Status

Gets the status of the health check.

Declaration

public HealthStatus Status { get; set; }

Property Value

Type	Description
HealthStatus