Class ActiveHealthCheckConfig

Active health check config.

Inheritance
System.Object
ActiveHealthCheckConfig
Implements
System.IEquatable<ActiveHealthCheckConfig>
Namespace: Yarp.ReverseProxy.Configuration
Assembly: Yarp.ReverseProxy.dll
Syntax
public sealed class ActiveHealthCheckConfig : object

Properties

| Improve this Doc View Source

Enabled

Whether active health checks are enabled.

Declaration
public bool? Enabled { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

Interval

Health probe interval.

Declaration
public TimeSpan? Interval { get; set; }
Property Value
Type Description
System.Nullable<TimeSpan>
| Improve this Doc View Source

Path

HTTP health check endpoint path.

Declaration
public string? Path { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Policy

Active health check policy.

Declaration
public string? Policy { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Query

Query string to append to the probe, including the leading '?'.

Declaration
public string? Query { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Timeout

Health probe timeout, after which a destination is considered unhealthy.

Declaration
public TimeSpan? Timeout { get; set; }
Property Value
Type Description
System.Nullable<TimeSpan>

Methods

| Improve this Doc View Source

Equals(ActiveHealthCheckConfig)

Declaration
public bool Equals(ActiveHealthCheckConfig other)
Parameters
Type Name Description
ActiveHealthCheckConfig other
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Implements

System.IEquatable<>