Class SessionAffinityCookieConfig

Namespace

Yarp.ReverseProxy.Configuration

Assembly

Yarp.ReverseProxy.dll

Config for session affinity cookies.

public sealed record SessionAffinityCookieConfig : IEquatable<SessionAffinityCookieConfig>

Inheritance

object

SessionAffinityCookieConfig

Implements

IEquatable<SessionAffinityCookieConfig>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

SessionAffinityCookieConfig()

public SessionAffinityCookieConfig()

Properties

Domain

The domain to associate the cookie with.

public string? Domain { get; init; }

Property Value

string

Expiration

Gets or sets the lifespan of a cookie.

public TimeSpan? Expiration { get; init; }

Property Value

TimeSpan?

HttpOnly

Indicates whether a cookie is accessible by client-side script.

public bool? HttpOnly { get; init; }

Property Value

bool?

Remarks

Defaults to "true".

IsEssential

Indicates if this cookie is essential for the application to function correctly. If true then consent policy checks may be bypassed.

public bool? IsEssential { get; init; }

Property Value

bool?

Remarks

Defaults to "false".

MaxAge

Gets or sets the max-age for the cookie.

public TimeSpan? MaxAge { get; init; }

Property Value

TimeSpan?

Path

The cookie path.

public string? Path { get; init; }

Property Value

string

SameSite

The SameSite attribute of the cookie.

public SameSiteMode? SameSite { get; init; }

Property Value

SameSiteMode?

Remarks

Defaults to Unspecified.

SecurePolicy

The policy that will be used to determine Secure.

public CookieSecurePolicy? SecurePolicy { get; init; }

Property Value

CookieSecurePolicy?

Remarks

Defaults to None.

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(SessionAffinityCookieConfig?)

public bool Equals(SessionAffinityCookieConfig? other)

Parameters

other SessionAffinityCookieConfig

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

<Clone>$()

public SessionAffinityCookieConfig <Clone>$()

Returns

SessionAffinityCookieConfig

Operators

operator ==(SessionAffinityCookieConfig?, SessionAffinityCookieConfig?)

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

Parameters

left SessionAffinityCookieConfig

right SessionAffinityCookieConfig

Returns

bool

operator !=(SessionAffinityCookieConfig?, SessionAffinityCookieConfig?)

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

Parameters

left SessionAffinityCookieConfig

right SessionAffinityCookieConfig

Returns

bool