Class ActiveHealthCheckConfig

Namespace

Yarp.ReverseProxy.Configuration

Assembly

Yarp.ReverseProxy.dll

Active health check config.

public sealed record ActiveHealthCheckConfig : IEquatable<ActiveHealthCheckConfig>

Inheritance

object

ActiveHealthCheckConfig

Implements

IEquatable<ActiveHealthCheckConfig>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ActiveHealthCheckConfig()

public ActiveHealthCheckConfig()

Properties

Enabled

Whether active health checks are enabled.

public bool? Enabled { get; init; }

Property Value

bool?

Interval

Health probe interval.

public TimeSpan? Interval { get; init; }

Property Value

TimeSpan?

Path

HTTP health check endpoint path.

public string? Path { get; init; }

Property Value

string

Policy

Active health check policy.

public string? Policy { get; init; }

Property Value

string

Timeout

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

public TimeSpan? Timeout { get; init; }

Property Value

TimeSpan?

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(ActiveHealthCheckConfig?)

public bool Equals(ActiveHealthCheckConfig? other)

Parameters

other ActiveHealthCheckConfig

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

<Clone>$()

public ActiveHealthCheckConfig <Clone>$()

Returns

ActiveHealthCheckConfig

Operators

operator ==(ActiveHealthCheckConfig?, ActiveHealthCheckConfig?)

public static bool operator ==(ActiveHealthCheckConfig? left, ActiveHealthCheckConfig? right)

Parameters

left ActiveHealthCheckConfig

right ActiveHealthCheckConfig

Returns

bool

operator !=(ActiveHealthCheckConfig?, ActiveHealthCheckConfig?)

public static bool operator !=(ActiveHealthCheckConfig? left, ActiveHealthCheckConfig? right)

Parameters

left ActiveHealthCheckConfig

right ActiveHealthCheckConfig

Returns

bool