Class ClusterConfig

A cluster is a group of equivalent endpoints and associated policies.

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

Properties

| Improve this Doc View Source

ClusterId

The Id for this cluster. This needs to be globally unique. This field is required.

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

Destinations

The set of destinations associated with this cluster.

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

HealthCheck

Health checking config.

Declaration
public HealthCheckConfig HealthCheck { get; set; }
Property Value
Type Description
HealthCheckConfig
| Improve this Doc View Source

HttpClient

Config for the HTTP client that is used to call destinations in this cluster.

Declaration
public HttpClientConfig HttpClient { get; set; }
Property Value
Type Description
HttpClientConfig
| Improve this Doc View Source

HttpRequest

Config for outgoing HTTP requests.

Declaration
public ForwarderRequestConfig HttpRequest { get; set; }
Property Value
Type Description
ForwarderRequestConfig
| Improve this Doc View Source

LoadBalancingPolicy

Load balancing policy.

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

Metadata

Arbitrary key-value pairs that further describe this cluster.

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

SessionAffinity

Session affinity config.

Declaration
public SessionAffinityConfig SessionAffinity { get; set; }
Property Value
Type Description
SessionAffinityConfig

Methods

| Improve this Doc View Source

Equals(ClusterConfig)

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