Runtime
Datalayer Core / Runtime
Class: Runtime
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:57
Runtime domain model that wraps API responses with convenient methods. Provides state management and lifecycle operations for computational runtimes.
Example
const runtime = await sdk.createRuntime({ environment_name: 'python-cpu' });
await runtime.waitUntilReady();
Constructors
Constructor
new Runtime(
data,sdk):Runtime
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:69
Create a Runtime instance.
Parameters
data
Runtime
Runtime data from API
sdk
SDK instance
Returns
Runtime
Properties
_data
_data:
Runtime
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:59
Internal
Accessors
burningRate
Get Signature
get burningRate():
number
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:125
Credits consumed per second.
Returns
number
environmentName
Get Signature
get environmentName():
string
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:107
Name of the environment this runtime is based on.
Returns
string
environmentTitle
Get Signature
get environmentTitle():
string
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:155
Environment title for display.
Returns
string
expiredAt
Get Signature
get expiredAt():
Date
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:149
When the runtime will expire.
Returns
Date
givenName
Get Signature
get givenName():
string
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:131
User-friendly name for the runtime.
Returns
string
ingress
Get Signature
get ingress():
string
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:113
Ingress URL for accessing the runtime.
Returns
string
podName
Get Signature
get podName():
string
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:95
Kubernetes pod name for the runtime instance.
Returns
string
startedAt
Get Signature
get startedAt():
Date
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:143
When the runtime started.
Returns
Date
token
Get Signature
get token():
string
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:119
Authentication token for accessing the runtime.
Returns
string
type
Get Signature
get type():
string
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:137
Type of runtime (notebook, terminal, or job).
Returns
string
uid
Get Signature
get uid():
string
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:101
Unique identifier for the runtime.
Returns
string
Methods
createSnapshot()
createSnapshot(
name,description?,stop?):Promise<Snapshot>
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:198
Create a snapshot of this runtime.
Parameters
name
string
Name for the snapshot
description?
string
Optional description
stop?
boolean
Whether to stop runtime after snapshotting
Returns
Promise<Snapshot>
Created Snapshot instance
delete()
delete():
Promise<void>
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:168
Delete this runtime permanently. After deletion, subsequent calls to dynamic methods will throw errors.
Returns
Promise<void>
rawData()
rawData():
Runtime
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:260
Get the raw runtime data exactly as received from the API. This preserves the original snake_case naming from the API response. Returns the current cached state - call getState() first if you need fresh data.
Returns
Runtime
Raw runtime data from API
toJSON()
toJSON():
RuntimeJSON
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:224
Get runtime data in camelCase format. Returns only the core fields that consumers need. This provides a stable interface regardless of API changes. Returns the current cached state - call getState() first if you need fresh data.
Returns
Core runtime data with camelCase properties
toString()
toString():
string
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:266
String representation of the runtime.
Returns
string
update()
update(
from):Promise<Runtime>
Defined in: tech/datalayer/core/src/client/models/Runtime.ts:179
Update runtime from a snapshot.
Parameters
from
string
Snapshot identifier to restore from
Returns
Promise<Runtime>
Updated Runtime instance