View Source

Class HealthCheckAction

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.HealthChecks

Assembly: Umbraco.Core.dll

Syntax

[DataContract(Name = "healthCheckAction", Namespace = "")]
public class HealthCheckAction

Constructors

HealthCheckAction()

Empty ctor used for serialization

Declaration

public HealthCheckAction()

HealthCheckAction(String, Guid)

Default ctor

Declaration

public HealthCheckAction(string alias, Guid healthCheckId)

Parameters

Type	Name	Description
System.String	alias
Guid	healthCheckId

Properties

ActionParameters

This could be used if the status has a custom view that specifies some parameters to be sent to the server when an action needs to be executed

Declaration

[DataMember(Name = "actionParameters")]
public Dictionary<string, object>? ActionParameters { get; set; }

Property Value

Type	Description
System.Nullable<Umbraco.Cms.Core.Dictionary<System.String, System.Object>>

Alias

The alias of the action - this is used by the Health Check instance to execute the action

Declaration

[DataMember(Name = "alias")]
public string Alias { get; set; }

Property Value

Type	Description
System.String

Description

The description of the action - this is used to give a description before executing the action

Declaration

[DataMember(Name = "description")]
public string Description { get; set; }

Property Value

Type	Description
System.String

HealthCheckId

The Id of the Health Check instance

Declaration

[DataMember(Name = "healthCheckId")]
public Guid? HealthCheckId { get; set; }

Property Value

Type	Description
System.Nullable<Guid>

Remarks

This is used to find the Health Check instance to execute this action

Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

ProvidedValue

Provides a value to rectify the issue

Declaration

[DataMember(Name = "providedValue")]
public string ProvidedValue { get; set; }

Property Value

Type	Description
System.String

ProvidedValueValidation

Indicates if a value required, how it is validated

Declaration

[DataMember(Name = "providedValueValidation")]
public string ProvidedValueValidation { get; set; }

Property Value

Type	Description
System.String

ProvidedValueValidationRegex

Indicates if a value required, and is validated by a regex, what the regex to use is

Declaration

[DataMember(Name = "providedValueValidationRegex")]
public string ProvidedValueValidationRegex { get; set; }

Property Value

Type	Description
System.String

ValueRequired

Indicates if a value is required to rectify the issue

Declaration

[DataMember(Name = "valueRequired")]
public bool ValueRequired { get; set; }

Property Value

Type	Description
System.Boolean