Class DestinationConfig

Namespace

Yarp.ReverseProxy.Configuration

Assembly

Yarp.ReverseProxy.dll

Describes a destination of a cluster.

public sealed record DestinationConfig : IEquatable<DestinationConfig>

Inheritance

object

DestinationConfig

Implements

IEquatable<DestinationConfig>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

DestinationConfig()

public DestinationConfig()

Properties

Address

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

public string Address { get; init; }

Property Value

string

Health

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

public string? Health { get; init; }

Property Value

string

Host

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

public string? Host { get; init; }

Property Value

string

Metadata

Arbitrary key-value pairs that further describe this destination.

public IReadOnlyDictionary<string, string>? Metadata { get; init; }

Property Value

IReadOnlyDictionary<string, string>

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(DestinationConfig?)

public bool Equals(DestinationConfig? other)

Parameters

other DestinationConfig

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

<Clone>$()

public DestinationConfig <Clone>$()

Returns

DestinationConfig

Operators

operator ==(DestinationConfig?, DestinationConfig?)

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

Parameters

left DestinationConfig

right DestinationConfig

Returns

bool

operator !=(DestinationConfig?, DestinationConfig?)

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

Parameters

left DestinationConfig

right DestinationConfig

Returns

bool