View Source

Class HealthCheckStatus

The status returned for a health check when it performs its check. TODO: This model will be used in the WebApi result so needs attributes for JSON usage.

Inheritance
object
Namespace: Umbraco.Cms.Core.HealthChecks
Assembly: Umbraco.Core.dll
Syntax
[DataContract(Name = "healthCheckStatus", Namespace = "")]
public class HealthCheckStatus

Constructors

View Source

HealthCheckStatus(string)

Initializes a new instance of the HealthCheckStatus class.

Declaration
public HealthCheckStatus(string message)
Parameters
Type Name Description
string message

The status message.

Properties

View Source

Actions

The potential actions to take (in any)

Declaration
[DataMember(Name = "actions")]
public IEnumerable<HealthCheckAction> Actions { get; set; }
Property Value
Type Description
IEnumerable<HealthCheckAction>
View Source

Description

The status description if one is necessary

Declaration
[DataMember(Name = "description")]
public string? Description { get; set; }
Property Value
Type Description
string
View Source

Message

The status message

Declaration
[DataMember(Name = "message")]
public string Message { get; }
Property Value
Type Description
string
View Source

This is optional but would allow a developer to specify a link that is shown as a "read more" button.

Declaration
[DataMember(Name = "readMoreLink")]
public string? ReadMoreLink { get; set; }
Property Value
Type Description
string
View Source

ResultType

The status type

Declaration
[DataMember(Name = "resultType")]
public StatusResultType ResultType { get; set; }
Property Value
Type Description
StatusResultType
View Source

View

This is optional but would allow a developer to specify a path to an angular HTML view in order to either show more advanced information and/or to provide input for the admin to configure how an action is executed

Declaration
[DataMember(Name = "view")]
public string? View { get; set; }
Property Value
Type Description
string