Files
Umbraco-CMS/src/Umbraco.Core/HealthCheck/HealthCheckStatus.cs
2020-02-24 08:21:53 +01:00

55 lines
1.7 KiB
C#

using System.Collections.Generic;
using System.Linq;
using System.Runtime.Serialization;
namespace Umbraco.Web.HealthCheck
{
/// <summary>
/// The status returned for a health check when it performs it check
/// TODO: This model will be used in the WebApi result so needs attributes for JSON usage
/// </summary>
[DataContract(Name = "healtCheckStatus", Namespace = "")]
public class HealthCheckStatus
{
public HealthCheckStatus(string message)
{
Message = message;
Actions = Enumerable.Empty<HealthCheckAction>();
}
/// <summary>
/// The status message
/// </summary>
[DataMember(Name = "message")]
public string Message { get; private set; }
/// <summary>
/// The status description if one is necessary
/// </summary>
[DataMember(Name = "description")]
public string Description { get; set; }
/// <summary>
/// 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
/// </summary>
[DataMember(Name = "view")]
public string View { get; set; }
/// <summary>
/// The status type
/// </summary>
[DataMember(Name = "resultType")]
public StatusResultType ResultType { get; set; }
/// <summary>
/// The potential actions to take (in any)
/// </summary>
[DataMember(Name = "actions")]
public IEnumerable<HealthCheckAction> Actions { get; set; }
// TODO: What else?
}
}