Class PushHealthCheckExtensions

Namespace

Acuit.Pinpoint.HealthChecks

Assembly

Acuit.Pinpoint.HealthChecks.Abstractions.dll

Extension members for IPushHealthCheck.

public static class PushHealthCheckExtensions

Inheritance

object

PushHealthCheckExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

SetDegraded(IPushHealthCheck, string?, Exception?, IReadOnlyDictionary<string, object>?)

Sets the current health status, which will be reported by the health check, to represent a degraded status.

public static void SetDegraded(this IPushHealthCheck pushHealthCheck, string? description = null, Exception? exception = null, IReadOnlyDictionary<string, object>? data = null)

Parameters

pushHealthCheck IPushHealthCheck

description string

An optional human-readable description of the status.

exception Exception

An optional Exception representing the exception that was thrown yielding the status.

data IReadOnlyDictionary<string, object>

Optional additional key-value pairs describing the health.

SetHealthy(IPushHealthCheck, string?, IReadOnlyDictionary<string, object>?)

Sets the current health status, which will be reported by the health check, to represent a healthy status.

public static void SetHealthy(this IPushHealthCheck pushHealthCheck, string? description = null, IReadOnlyDictionary<string, object>? data = null)

Parameters

pushHealthCheck IPushHealthCheck

description string

An optional human-readable description of the status.

data IReadOnlyDictionary<string, object>

Optional additional key-value pairs describing the health.

SetUnhealthy(IPushHealthCheck, string?, Exception?, IReadOnlyDictionary<string, object>?)

Sets the current health status, which will be reported by the health check, to represent an unhealthy status.

public static void SetUnhealthy(this IPushHealthCheck pushHealthCheck, string? description = null, Exception? exception = null, IReadOnlyDictionary<string, object>? data = null)

Parameters

pushHealthCheck IPushHealthCheck

description string

An optional human-readable description of the status.

exception Exception

An optional Exception representing the exception that was thrown yielding the status.

data IReadOnlyDictionary<string, object>

Optional additional key-value pairs describing the health.