Class DestinationConfig

Describes a destination of a cluster.

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

Properties

| Improve this Doc View Source

Address

Address of this destination. E.g. https://127.0.0.1:123/abcd1234/. This field is required.

Declaration
public string Address { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Health

Endpoint accepting active health check probes. E.g. http://127.0.0.1:1234/.

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

Host

Host header value to pass to this destination. Used as a fallback if a host is not already specified by request transforms.

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

Metadata

Arbitrary key-value pairs that further describe this destination.

Declaration
public IReadOnlyDictionary<string, string>? Metadata { get; set; }
Property Value
Type Description
System.Nullable<IReadOnlyDictionary<System.String, System.String>>

Methods

| Improve this Doc View Source

Equals(DestinationConfig)

Declaration
public bool Equals(DestinationConfig other)
Parameters
Type Name Description
DestinationConfig 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<>