Class OpenShellClient

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

A connected client for one OpenShell gateway. Thread safe; create one and reuse it.

public sealed class OpenShellClient : IOpenShellClient, IDisposable

Inheritance

object

OpenShellClient

Implements

IOpenShellClient

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OpenShellClient(OpenShellClientOptions)

Connects lazily; no network I/O happens until the first call.

public OpenShellClient(OpenShellClientOptions options)

Parameters

options OpenShellClientOptions

Properties

Config

Sandbox and gateway configuration.

public IConfigClient Config { get; }

Property Value

IConfigClient

Exec

Command execution.

public IExecClient Exec { get; }

Property Value

IExecClient

Files

File transfer.

public IFileClient Files { get; }

Property Value

IFileClient

Health

Health and identity.

public IHealthClient Health { get; }

Property Value

IHealthClient

Policy

Draft policy review and policy revisions.

public IPolicyClient Policy { get; }

Property Value

IPolicyClient

Providers

Providers, profiles and credential refresh.

public IProviderClient Providers { get; }

Property Value

IProviderClient

Raw

The generated gRPC client, for RPCs the curated surface does not cover yet.

public OpenShell.OpenShellClient Raw { get; }

Property Value

OpenShell.OpenShellClient

RawSandboxUpdates

The generated gRPC client for the separate openshell.v1.SandboxUpdates service, on the same connection, authentication, retry, and telemetry pipeline as Raw. The gateway serves it only when sandbox updates are enabled ([openshell.gateway] enable_sandbox_updates = true).

public SandboxUpdates.SandboxUpdatesClient RawSandboxUpdates { get; }

Property Value

SandboxUpdates.SandboxUpdatesClient

Rootfs

Local rootfs tar staging for drivers that boot from an archive.

public IRootfsClient Rootfs { get; }

Property Value

IRootfsClient

SandboxProviders

Provider attachment and readiness for sandboxes.

public ISandboxProviderClient SandboxProviders { get; }

Property Value

ISandboxProviderClient

Sandboxes

Sandbox lifecycle.

public ISandboxClient Sandboxes { get; }

Property Value

ISandboxClient

Services

Service exposure.

public IServiceClient Services { get; }

Property Value

IServiceClient

Ssh

SSH relay sessions and tunnels.

public ISshClient Ssh { get; }

Property Value

ISshClient

Tcp

TCP forwarding to sandbox ports.

public ITcpClient Tcp { get; }

Property Value

ITcpClient

Templates

Reusable sandbox workload templates.

public ISandboxTemplateClient Templates { get; }

Property Value

ISandboxTemplateClient

Watch

Watch streams and logs.

public ISandboxWatchClient Watch { get; }

Property Value

ISandboxWatchClient

Workspace

The workspace this view operates in.

public string Workspace { get; }

Property Value

string

Workspaces

Workspace and membership management.

public IWorkspaceClient Workspaces { get; }

Property Value

IWorkspaceClient

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

InWorkspace(string)

Returns a view of this client bound to another workspace; the connection is shared.

public IOpenShellClient InWorkspace(string workspace)

Parameters

workspace string

Returns

IOpenShellClient