Runtime Models

Runtime metadata, resources, command results, and operation options.

RuntimeInfo

Describes a runtime’s identity, resources, lifecycle state, and ingress settings.

RuntimeInfo declaration

interface RuntimeInfo

RuntimeInfo properties

Name	Type	Description
agent?	RuntimeAgentInfo	Runtime-agent metadata, when an agent was requested.
displayName	string	Human-readable resource name.
egressPolicy	EgressPolicy	Runtime egress policy.
id	string	Unique resource UUID.
idleSuspendAfterSecs?	number	Idle duration before automatic suspension.
ingressSpecs	IngressSpec[]	Runtime ingress configuration.
resources	RuntimeResources	Runtime resource configuration.
status	RuntimeStatus	Current lifecycle or execution state.

RuntimeAgentInfo

Runtime-agent status metadata.

RuntimeAgentInfo declaration

interface RuntimeAgentInfo

RuntimeAgentInfo properties

Name	Type	Description
error	string | null	Runtime-agent failure message, when present.
key	string	Runtime-agent identifier.
logPath	string	Path to the runtime-agent log.
status	RuntimeAgentStatus	Current lifecycle or execution state.
updatedAt	string | null	Timestamp of the latest runtime-agent update.

CommandResult

Buffered command result returned by runtime execution methods.

CommandResult declaration

interface CommandResult

CommandResult properties

Name	Type	Description
durationMs	number	Command duration in milliseconds.
durationSeconds	number	Command duration in seconds.
exitCode	number	Process exit code.
stderr	string	Captured standard error bytes.
stderrText	string	Captured standard error decoded as text.
stderrTruncated	boolean	Whether standard error exceeded the configured limit.
stdout	string	Captured standard output bytes.
stdoutText	string	Captured standard output decoded as text.
stdoutTruncated	boolean	Whether standard output exceeded the configured limit.

CreateRuntimeOptions

Configures runtime creation, resources, readiness waiting, and initial egress.

CreateRuntimeOptions declaration

interface CreateRuntimeOptions

CreateRuntimeOptions properties

Name	Type	Description
checkpointId?	string | null	Checkpoint UUID used to restore the new runtime.
egressPolicy?	EgressPolicy	Initial runtime egress policy.
idleSuspendAfterSecs?	number | null	Idle duration before automatic suspension.
ingressSpecs?	IngressSpec[]	Initial runtime ingress configuration.
memoryMaxMib?	number	Maximum autoscaled memory in MiB. Defaults to the initial memory request.
memoryMib?	number	Initial runtime memory in MiB.
name?	string | null	Optional human-readable runtime name.
pollIntervalMs?	number	Polling interval in milliseconds.
resources?	CreateRuntimeResources	Runtime resource configuration.
runtimeAgent?	string | null	Runtime-agent key to start after creation.
timeoutMs?	number	Request timeout in milliseconds.
vcpus?	number	Virtual CPU count.
wait?	boolean	Whether to wait for the operation to become ready.

PatchRuntimeOptions

Options accepted when updating a runtime.

PatchRuntimeOptions declaration

interface PatchRuntimeOptions

PatchRuntimeOptions properties

Name	Type	Description
egressPolicy?	EgressPolicy	Replacement runtime egress policy.
idleSuspendAfterSecs?	number | null	Replacement idle-suspension delay in seconds.
resources?	PatchRuntimeResources	Updated runtime resource configuration.

ExecOptions

Configures environment, input, timeout, and output limits for a command.

ExecOptions declaration

interface ExecOptions

ExecOptions properties

Name	Type	Description
cwd?	string | null	Runtime working directory for the command.
env?	Record<string, string> | null	Environment variables passed to the command.
maxOutputBytes?	number | null	Maximum buffered bytes per output stream.
stdin?	string | Uint8Array<ArrayBufferLike> | null	Standard input passed to the command.
timeoutSecs?	number | null	Command timeout in seconds.

StartOptions

Runtime start behavior and wait settings.

StartOptions declaration

interface StartOptions

StartOptions properties

Name	Type	Description
pollIntervalMs?	number	Polling interval in milliseconds.
timeoutMs?	number	Request timeout in milliseconds.
wait?	boolean	Whether to wait for the operation to become ready.

WaitOptions

Polling and timeout settings for wait operations.

WaitOptions declaration

interface WaitOptions

WaitOptions properties

Name	Type	Description
pollIntervalMs?	number	Polling interval in milliseconds.
timeoutMs?	number	Request timeout in milliseconds.

IngressSpec

Ingress protocol and runtime port mapping.

IngressSpec declaration

interface IngressSpec

IngressSpec properties

Name	Type	Description
protocol	string	Ingress protocol, such as tcp or http.
runtimePort	number	Port exposed by the runtime.

CreateRuntimeResourceRequests

Resource requests accepted while creating a runtime.

CreateRuntimeResourceRequests declaration

interface CreateRuntimeResourceRequests

CreateRuntimeResourceRequests properties

Name	Type	Description
memoryMib?	number	Initial requested memory in MiB.
vcpus?	number	Virtual CPU count.

CreateRuntimeResources

Structured resource configuration accepted while creating a runtime.

CreateRuntimeResources declaration

interface CreateRuntimeResources

CreateRuntimeResources properties

Name	Type	Description
limits?	RuntimeResourceLimits	Maximum runtime resources.
requests?	CreateRuntimeResourceRequests	Requested runtime resources.

PatchRuntimeResourceRequests

Resource requests accepted while updating a runtime.

PatchRuntimeResourceRequests declaration

interface PatchRuntimeResourceRequests

PatchRuntimeResourceRequests properties

Name	Type	Description
memoryMib?	number	Replacement requested memory in MiB.

PatchRuntimeResources

Structured resource configuration accepted while updating a runtime.

PatchRuntimeResources declaration

interface PatchRuntimeResources

PatchRuntimeResources properties

Name	Type	Description
limits?	RuntimeResourceLimits	Maximum runtime resources.
requests?	PatchRuntimeResourceRequests	Requested runtime resources.

RuntimeResourceRequests

Requested runtime memory and CPU allocation.

RuntimeResourceRequests declaration

interface RuntimeResourceRequests

RuntimeResourceRequests properties

Name	Type	Description
memoryMib	number	Memory amount in MiB.
vcpus	number	Virtual CPU count.

RuntimeResourceLimits

Maximum runtime memory allocation.

RuntimeResourceLimits declaration

interface RuntimeResourceLimits

RuntimeResourceLimits properties

Name	Type	Description
memoryMib	number	Memory amount in MiB.

RuntimeResources

Effective runtime resource requests and limits.

RuntimeResources declaration

interface RuntimeResources

RuntimeResources properties

Name	Type	Description
limits	RuntimeResourceLimits	Maximum runtime resources.
requests	RuntimeResourceRequests	Requested runtime resources.