Namespace OpenShell
Classes
- AccessToken
A token with an optional absolute expiry.
- ApproveAllResult
The effect of approving every pending chunk.
- AttachProviderResult
The result of attaching a provider to a sandbox.
- Auth
Factory methods for the built-in IAuthProvider implementations.
- BoolSetting
A boolean setting.
- BytesSetting
A byte-array setting, compared by content.
- ChunkApproval
One reviewed chunk and its token, for Approvals.
- ComputeDriverInfo
A compute backend available on the gateway.
- ConfigUpdate
A configuration mutation. Prefer the typed helpers on IConfigClient.
- ConfigUpdateResult
The result of a configuration update.
- CreateSandboxOptions
Options for CreateAsync(string?, SandboxSpec, CreateSandboxOptions?, CancellationToken).
- CredentialHandle
An opaque handle for a credential stored by gateway credential storage. Never authored by callers.
- CredentialTokenGrant
Dynamic credential acquisition through an OAuth2 grant.
- CurrentUser
The authenticated caller.
- DeleteOptions
Options for deleting a resource.
- DeletionResult
Typed result of a delete. A boolean would hide the pending-cleanup case.
- DetachProviderResult
The result of detaching a provider from a sandbox.
- DraftChunk
A proposed network policy rule awaiting review.
- DraftHistoryEntry
One entry of the draft decision history.
- DraftPolicy
The draft policy of a sandbox.
- DraftPolicyUpdate
Notification that a sandbox draft policy changed.
- DraftPolicyUpdated
The draft policy changed.
- EffectiveSetting
A setting value paired with the scope it resolved from.
- EndpointFailure
A classified cause of an endpoint failure, such as a token grant that could not be completed.
- EndpointStatus
What the sandbox supervisor last observed for one declared endpoint.
- ErrorInfo
A stable error reason scoped to the service that produced it.
- ExecEvent
An event from a streaming exec.
- ExecExit
The terminal event carrying the command exit code.
- ExecInteractiveSession
A running interactive command. Read ReadEventsAsync(CancellationToken) (once) for output, write stdin and resize the terminal concurrently, and await WaitForExitAsync(CancellationToken) for the exit code.
- ExecOptions
Options for running a command in a sandbox.
- ExecOutput
A chunk of standard output or error.
- ExecPythonExtensions
Python convenience helpers over IExecClient.
- ExecResult
The buffered result of a command.
- ExposeServiceOptions
Options for ExposeAsync(string, string, uint, ExposeServiceOptions?, CancellationToken).
- ExtensionInfo
One successful gateway/extension negotiation.
- FieldViolation
A request field the gateway rejected.
- ForwardStream
A bidirectional byte stream over the gateway's TCP forward relay. Reads and writes are asynchronous only; one reader and one writer may be active at the same time.
- GatewayConfig
Gateway-global settings.
- GatewayInfo
Operational metadata about the gateway.
- GpuRequirements
GPU request for a workload. Presence of the record means a GPU is requested.
- HealthResult
Result of a health check.
- ImportProfilesResult
Result of importing profiles.
- IntSetting
A 64-bit integer setting.
- LintProfilesResult
Result of linting profiles.
- ListOptions
Paging and filtering options shared by list operations.
- LogLine
A log line from the gateway or the sandbox supervisor.
- LogReceived
A log line arrived.
- LogResult
A one-shot log fetch.
- OpenShellClient
A connected client for one OpenShell gateway. Thread safe; create one and reuse it.
- OpenShellClientOptions
Configures an OpenShellClient.
- OpenShellException
The error type thrown by every SDK operation.
- OpenShellTelemetry
Names of the SDK's diagnostics sources. Nothing is recorded until a listener subscribes, so the instrumentation costs nothing by default. With OpenTelemetry, call
AddSource(OpenShellTelemetry.ActivitySourceName)on the tracer provider andAddMeter(OpenShellTelemetry.MeterName)on the meter provider.
- Page<T>
One page of results.
- Pager<T>
A lazily evaluated listing. Enumerate it for items, or call PagesAsync(CancellationToken) for pages.
- PlatformEvent
A platform event such as a Kubernetes or container runtime event.
- PlatformEventReceived
A platform event arrived.
- PolicyChangeResult
The effect of approving or undoing a chunk.
- PolicyRevision
A versioned policy revision.
- PolicyStatusResult
A policy revision plus the sandbox's active version.
- ProfileCredential
One credential a provider profile declares.
- ProfileCredentialRefresh
How a profile credential is refreshed.
- ProfileCredentialRefreshMaterial
One input a refresh strategy needs.
- ProfileCredentialRefreshOutput
Maps a minted output to a sibling credential.
- ProfileDiagnostic
A validation finding from import, update or lint.
- ProfileFile
EXPERIMENTAL: non-secret content served at a virtual sandbox path. May change or be removed.
- ProfileImportItem
A profile submitted for import, update or lint, with optional source metadata for diagnostics.
- ProfileMutationOptions
Options for profile mutations.
- Provider
A provider: a named set of credentials and configuration for one provider type.
- ProviderCredentialValue
An exported runtime secret. Its ToString() never reveals the value.
- ProviderCredentialsOptions
Options for GetCredentialsAsync(string, IReadOnlyCollection<string>, ProviderCredentialsOptions, CancellationToken).
- ProviderDesiredIdentity
Exact desired authority. Revisions are opaque identities, never ordered.
- ProviderMutationReceipt
Immutable, secret-free record of one sandbox's intended provider mutation.
- ProviderOperation
Durable progress of the operation behind a receipt.
- ProviderProfile
A provider type profile.
- ProviderReadinessObservation
Installed state reported by the current supervisor.
- ProviderReadinessStatus
Operator view of desired and observed state; contains no credential material.
- ProviderUpdateResult
The result of a provider update.
- ProviderWaitResult
Last safe status and the reason a provider wait returned.
- PythonExecOptions
Options for the Python exec helpers.
- RefreshConfig
Configures gateway-owned refresh for a credential.
- RefreshStatus
Gateway-owned refresh state of one provider credential.
- RefreshableToken
Caches an access token and renews it single-flight, proactively before expiry and reactively after the gateway rejects it.
- RetryPolicy
Retries transient gateway failures with exponential backoff and jitter. Only unary calls are retried here; streaming operations such as watches reconnect on their own.
- RootfsDriverConfig
Builds the
template.driver_configJSON that references a staged rootfs archive.
- RootfsStagingSlot
A gateway-owned slot for a local rootfs tar archive.
- Sandbox
A sandbox as reported by the gateway.
- SandboxCondition
One status condition of a sandbox.
- SandboxConfig
The effective configuration of a sandbox.
- SandboxProviderMutationOptions
Options for attach and detach.
- SandboxSpec
Desired state of a sandbox.
- SandboxTemplateSpec
Per-sandbox workload template fields.
- SandboxUpdate
A change to a stopped sandbox's configuration, for UpdateAsync(string, ulong, SandboxUpdate, UpdateSandboxOptions?, CancellationToken). A null property is left unchanged; a non-null one replaces the current value, and an empty collection is meaningful.
- SandboxUpdated
The sandbox changed.
- SandboxWorkloadTemplate
A reusable, named workload shape that sandboxes can be created from.
- ServiceEndpoint
A loopback HTTP service exposed from a sandbox through the gateway.
- ServiceExposure
Registers a loopback HTTP service during sandbox creation.
- SetPolicyOptions
Options for sandbox-scoped policy updates.
- SettingValue
A typed setting value: string, bool, int64 or bytes.
- SshSession
A short-lived SSH relay session. The token is a credential and is redacted from ToString().
- StartupServiceLevel
Desired startup behaviour for sandboxes created from a template.
- StringSetting
A string setting.
- TlsOptions
TLS settings for an
https://gateway.
- TokenGrantAudienceOverride
Endpoint-specific audience override for a token grant.
- TokenGrantFailureObservation
The latest token-grant failure observed in a sandbox, with the destination it was for.
- TokenGrantSubjectToken
Subject token for a token-exchange grant.
- UpdateProfileResult
Result of updating a profile.
- UpdateSandboxOptions
Options for UpdateAsync(string, ulong, SandboxUpdate, UpdateSandboxOptions?, CancellationToken) and ResumePendingUpdateAsync(string, ulong, UpdateSandboxOptions?, CancellationToken).
- WaitOptions
Options for the polling waits.
- WatchEvent
An event on a sandbox watch stream.
- WatchOptions
Options for WatchAsync(string, WatchOptions?, CancellationToken) and WatchLogsAsync(string, WatchOptions?, CancellationToken).
- WatchWarning
A recoverable loss on the stream, such as dropped lines. The stream continues.
- WorkloadResources
Portable resource requirements for sandboxes created from a template.
- Workspace
A workspace: the isolation boundary for sandboxes, providers and other resources.
- WorkspaceMember
A principal's membership in a workspace.
Structs
- ExactTimestamp
A timestamp that keeps nanosecond precision, which DateTimeOffset cannot.
Interfaces
- IAuthProvider
Supplies per-request authentication headers.
- IConfigClient
Reads and updates sandbox and gateway configuration.
- IExecClient
Command execution inside sandboxes.
- IFileClient
File transfer between the local machine and a sandbox. Files travel as a tar stream over exec, so the sandbox image needs
tarandsh.
- IForwardListener
A local listener that bridges every accepted connection to a sandbox port.
- IHealthClient
Health and identity operations.
- IOpenShellClient
The entry point to the OpenShell gateway API, for mocking and dependency injection.
- IPolicyClient
Draft policy review and policy revision history for sandboxes.
- IProviderClient
Provider operations, scoped to one workspace.
- IProviderProfileClient
Provider type profile operations.
- IProviderRefreshClient
Gateway-owned credential refresh operations.
- IRootfsClient
Stages a local rootfs tar archive for compute drivers that boot from one (for example the VM driver). Only a client that shares the gateway's filesystem can complete the upload, so this is a local-gateway workflow.
- ISandboxClient
Sandbox lifecycle operations, scoped to one workspace.
- ISandboxProviderClient
Provider attachment and readiness for sandboxes, scoped to one workspace.
- ISandboxTemplateClient
Reusable sandbox workload templates, scoped to one workspace.
- ISandboxWatchClient
Sandbox watch streams and log retrieval.
- IServiceClient
Service exposure operations, scoped to one workspace.
- ISshClient
SSH relay sessions and tunnels.
- ITcpClient
TCP forwarding to sandbox ports.
- IWorkspaceClient
Workspace and membership management.
Enums
- ConfigApplyOutcome
Result of applying a configuration revision at its owning runtime boundary.
- ConfigUpdateOperationState
Lifecycle of one desired-state update operation.
- CredentialTokenGrantType
The OAuth2 grant used for a dynamically acquired credential.
- DeletionOutcome
Result of a delete request.
- EndpointFailureDomain
Which subsystem classified an EndpointFailure. Values match the wire enum.
- EndpointResult
Outcome of the latest observed exchange with a sandbox endpoint. Values match the wire enum.
- OpenShellErrorKind
Classifies an OpenShellException.
- PolicyLoadStatus
Load state of a policy revision.
- PolicySource
Where a sandbox policy payload came from.
- ProviderMutationKind
Operation whose installed authority a receipt tracks.
- ProviderProfileCategory
Stable provider profile categories used for grouping and filtering.
- ProviderReadinessReason
Closed reason categories, safe to display.
- ProviderReadinessState
Persisted intent is tracked separately from installed state.
- ProviderWaitOutcome
Why a bounded provider wait returned.
- RefreshRecoveryAction
What an operator should do after a refresh failure.
- RefreshStrategy
How a credential is refreshed.
- SandboxPhase
Lifecycle phase of a sandbox. Values match the wire enum.
- SandboxRestartPolicy
Restart behaviour for the sandbox main process.
- ServiceAuthorizationMode
How the gateway treats the Authorization header toward an exposed service.
- ServiceStatus
Gateway health.
- SettingScope
The scope that controls a setting.
- WorkspacePhase
Lifecycle phase of a workspace. Values match the wire enum.
- WorkspaceRole
Role of a principal within a workspace. Values match the wire enum.
Delegates
- TokenRefresher
Obtains a fresh AccessToken, for example through an OIDC refresh grant.