Share via


HealthInformation Class

Definition

Represents common health report information. It is included in all health reports sent to the health store and in all health events returned by health queries.

public sealed class HealthInformation
type HealthInformation = class
Public NotInheritable Class HealthInformation
Inheritance
HealthInformation

Constructors

HealthInformation(String, String, HealthState)

Initializes a new instance of the HealthInformation class.

Fields

AutoSequenceNumber

Auto sequence number, replaced with a valid sequence number by the health client.

UnknownSequenceNumber

Unknown sequence number, which is an invalid sequence number that is not accepted by the health store.

Properties

Description

Gets or sets the description of the health information. It represents free text used to add human readable information about the monitored condition.

HealthReportId

The health report ID which uniquely identifies each type of health report.

HealthState

Gets the health state that describes the severity of the monitored condition used for reporting.

Property

Gets the property of the health report.

RemoveWhenExpired

Gets or sets a value that indicates whether the report is removed from health store when it expires. If set to false, the report is treated as an error when expired. false by default.

SequenceNumber

Gets or sets the sequence number associated with the health information, used by the health store for staleness detection. Must be greater than UnknownSequenceNumber.

SourceId

Gets the source name which identifies the watchdog/system component which generated the health information.

TimeToLive

Gets or sets how long the health report is valid. Must be larger than TimeSpan.Zero.

Methods

ToString()

Creates a string description of the health information.

Applies to