HealthReportEntry Constructors

Definition

Namespace:

Microsoft.Extensions.Diagnostics.HealthChecks

Assembly:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions.dll

Package:

Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions v9.0.0

Overloads

HealthReportEntry(HealthStatus, String, TimeSpan, Exception, IReadOnlyDictionary<String,Object>)	Creates a new HealthReportEntry with the specified values for status, exception, description, and data.
HealthReportEntry(HealthStatus, String, TimeSpan, Exception, IReadOnlyDictionary<String,Object>, IEnumerable<String>)	Creates a new HealthReportEntry with the specified values for status, exception, description, and data.

HealthReportEntry(HealthStatus, String, TimeSpan, Exception, IReadOnlyDictionary<String,Object>)

Source:

HealthReportEntry.cs

Creates a new HealthReportEntry with the specified values for status, exception, description, and data.

public:
 HealthReportEntry(Microsoft::Extensions::Diagnostics::HealthChecks::HealthStatus status, System::String ^ description, TimeSpan duration, Exception ^ exception, System::Collections::Generic::IReadOnlyDictionary<System::String ^, System::Object ^> ^ data);

public HealthReportEntry (Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus status, string? description, TimeSpan duration, Exception? exception, System.Collections.Generic.IReadOnlyDictionary<string,object>? data);

new Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry : Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus * string * TimeSpan * Exception * System.Collections.Generic.IReadOnlyDictionary<string, obj> -> Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry

Public Sub New (status As HealthStatus, description As String, duration As TimeSpan, exception As Exception, data As IReadOnlyDictionary(Of String, Object))

Parameters

status

HealthStatus

A value indicating the health status of the component that was checked.

description

String

A human-readable description of the status of the component that was checked.

duration

TimeSpan

A value indicating the health execution duration.

exception

Exception

An Exception representing the exception that was thrown when checking for status (if any).

data

IReadOnlyDictionary<String,Object>

Additional key-value pairs describing the health of the component.

HealthReportEntry(HealthStatus, String, TimeSpan, Exception, IReadOnlyDictionary<String,Object>, IEnumerable<String>)

Source:

HealthReportEntry.cs

Creates a new HealthReportEntry with the specified values for status, exception, description, and data.

public HealthReportEntry (Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus status, string? description, TimeSpan duration, Exception? exception, System.Collections.Generic.IReadOnlyDictionary<string,object>? data, System.Collections.Generic.IEnumerable<string>? tags = default);

new Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry : Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus * string * TimeSpan * Exception * System.Collections.Generic.IReadOnlyDictionary<string, obj> * seq<string> -> Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry

Public Sub New (status As HealthStatus, description As String, duration As TimeSpan, exception As Exception, data As IReadOnlyDictionary(Of String, Object), Optional tags As IEnumerable(Of String) = Nothing)

Parameters

status

HealthStatus

A value indicating the health status of the component that was checked.

description

String

A human-readable description of the status of the component that was checked.

duration

TimeSpan

A value indicating the health execution duration.

exception

Exception

An Exception representing the exception that was thrown when checking for status (if any).

data

IReadOnlyDictionary<String,Object>

Additional key-value pairs describing the health of the component.

tags

IEnumerable<String>

Tags associated with the health check that generated the report entry.