Class GatewayConnectOptions

Namespace

OpenShell.Gateway

Assembly

OpenShell.Sdk.dll

Settings for GatewayClient.

public sealed record GatewayConnectOptions : IEquatable<GatewayConnectOptions>

Inheritance

object

GatewayConnectOptions

Implements

IEquatable<GatewayConnectOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Auth

Replaces the authentication derived from the gateway's auth_mode.

public IAuthProvider? Auth { get; init; }

Property Value

IAuthProvider

AutoRefresh

Renew an expired OIDC access token through the stored refresh token. Default true.

public bool AutoRefresh { get; init; }

Property Value

bool

DefaultTimeout

Per-call deadline for unary calls.

public TimeSpan? DefaultTimeout { get; init; }

Property Value

TimeSpan?

DefaultWorkspace

Workspace used when none is given; defaults to default.

public string? DefaultWorkspace { get; init; }

Property Value

string

EdgeTunnel

How to reach a Cloudflare Access gateway. Auto (the default) routes gRPC through a local WebSocket tunnel, because the edge authenticates only GET requests.

public EdgeTunnelMode EdgeTunnel { get; init; }

Property Value

EdgeTunnelMode

EdgeTunnelOptions

Settings for the edge tunnel when one is started.

public EdgeTunnelOptions? EdgeTunnelOptions { get; init; }

Property Value

EdgeTunnelOptions

HttpHandler

Replaces the HTTP handler (tests, custom proxies).

public HttpMessageHandler? HttpHandler { get; init; }

Property Value

HttpMessageHandler

Locator

Locates registrations; defaults to the OS layout.

public GatewayLocator? Locator { get; init; }

Property Value

GatewayLocator

LoggerFactory

Optional logger factory.

public ILoggerFactory? LoggerFactory { get; init; }

Property Value

ILoggerFactory

OidcHttpClient

HTTP client for OIDC discovery and refresh (must not follow redirects).

public HttpClient? OidcHttpClient { get; init; }

Property Value

HttpClient

TimeProvider

Clock for token expiry.

public TimeProvider? TimeProvider { get; init; }

Property Value

TimeProvider

Tls

Replaces the TLS settings derived from the gateway's mtls directory.

public TlsOptions? Tls { get; init; }

Property Value

TlsOptions

WriteBack

Persist renewed tokens back to oidc_token.json so the CLI sees rotation. Default true.

public bool WriteBack { get; init; }

Property Value

bool