Class OpenShellOptions

Namespace

OpenShell.DependencyInjection

Assembly

OpenShell.Sdk.DependencyInjection.dll

Mutable, configuration-bindable settings for one gateway. OpenShellClientOptions is immutable, so the options pattern binds to this class and the factory converts it.

public sealed class OpenShellOptions

Inheritance

object

OpenShellOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Address

Gateway address, for example https://gateway.example.com. Required.

public Uri? Address { get; set; }

Property Value

Uri

AllowInsecureAuth

Permits credentials over plaintext http:// to a non-loopback host.

public bool AllowInsecureAuth { get; set; }

Property Value

bool

Auth

An authentication provider built in code. Takes precedence over Token; not bindable from configuration.

public IAuthProvider? Auth { get; set; }

Property Value

IAuthProvider

CaCertificatePath

Path to a PEM file with the CA certificate(s) to trust instead of the system roots.

public string? CaCertificatePath { get; set; }

Property Value

string

ClientCertificatePath

Path to a PEM client certificate for mTLS.

public string? ClientCertificatePath { get; set; }

Property Value

string

ClientKeyPath

Path to the PEM private key for ClientCertificatePath; omit when the key is in the certificate file.

public string? ClientKeyPath { get; set; }

Property Value

string

DefaultTimeout

Deadline applied to unary calls that do not set their own.

public TimeSpan? DefaultTimeout { get; set; }

Property Value

TimeSpan?

InsecureSkipVerify

Disables server certificate validation. Development only.

public bool InsecureSkipVerify { get; set; }

Property Value

bool

Retry

Retry settings. Null keeps Default.

public RetryOptions? Retry { get; set; }

Property Value

RetryOptions

RouteToOwnerReplica

Routes long-lived streams to the sandbox's owner replica; see RouteToOwnerReplica.

public bool RouteToOwnerReplica { get; set; }

Property Value

bool

Tls

TLS settings built in code. Takes precedence over the certificate path settings; not bindable from configuration.

public TlsOptions? Tls { get; set; }

Property Value

TlsOptions

Token

Static bearer token. Prefer a token provider set through Auth for anything that expires.

public string? Token { get; set; }

Property Value

string

Workspace

Workspace used when none is given. Defaults to default.

public string Workspace { get; set; }

Property Value

string