Skip to main content

IRemoteRuntimesManager

Datalayer Core

Datalayer Core / IRemoteRuntimesManager

Interface: IRemoteRuntimesManager

Defined in: src/stateful/runtimes/apis.ts:107

Interface for the Remote Runtimes Manager

Extends​

  • IDisposable

Properties​

changed​

readonly changed: ISignal<IRemoteRuntimesManager, readonly IRuntimeModel[]>

Defined in: src/stateful/runtimes/apis.ts:126

Remote kernels changed

connectionFailure​

readonly connectionFailure: ISignal<IRemoteRuntimesManager, Error>

Defined in: src/stateful/runtimes/apis.ts:111

A signal emitted when there is a connection failure.

isDisposed​

readonly isDisposed: boolean

Defined in: node_modules/@lumino/disposable/types/index.d.ts:16

Test whether the object has been disposed.

Notes​

This property is always safe to access.

Inherited from​

IDisposable.isDisposed

isReady​

readonly isReady: boolean

Defined in: src/stateful/runtimes/apis.ts:116

Test whether the manager is ready.

ready​

readonly ready: Promise<void>

Defined in: src/stateful/runtimes/apis.ts:121

A promise that fulfills when the manager is ready.

serverSettings​

readonly serverSettings: ISettings

Defined in: src/stateful/runtimes/apis.ts:131

The server settings.

Methods​

connectTo()​

connectTo(options): IKernelConnection

Defined in: src/stateful/runtimes/apis.ts:184

Connect to an existing kernel.

Parameters​

options​

IOptions

The connection options.

Returns​

IKernelConnection

A promise that resolves with the new kernel instance.

dispose()​

dispose(): void

Defined in: node_modules/@lumino/disposable/types/index.d.ts:28

Dispose of the resources held by the object.

Notes​

If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior​

It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns​

void

Inherited from​

IDisposable.dispose

findById()​

findById(id): Promise<IRuntimeModel | undefined>

Defined in: src/stateful/runtimes/apis.ts:175

Find a kernel by id.

Parameters​

id​

string

The id of the target kernel.

Returns​

Promise<IRuntimeModel | undefined>

A promise that resolves with the kernel's model, or undefined if not found.

get()​

get(): readonly IRuntimeModel[]

Defined in: src/stateful/runtimes/apis.ts:136

Get the list of remote kernels.

Returns​

readonly IRuntimeModel[]

getServices()​

getServices(serverName): any

Defined in: src/stateful/runtimes/apis.ts:144

Get the service manager for a remote server

Parameters​

serverName​

string

Remote kernel server name

Returns​

any

Service manager for the remote server

loadRuntimeSnapshot()​

loadRuntimeSnapshot(options): Promise<void>

Defined in: src/stateful/runtimes/apis.ts:245

Load a snapshot within a runtim

The runtime may be given by its id or podName.

Parameters​

options​
id?​

string

The kernel id

podName?​

string

The kernel pod name

snapshot​

string

The snapshot UID

Returns​

Promise<void>

refresh()​

refresh(): Promise<void>

Defined in: src/stateful/runtimes/apis.ts:149

Refresh the environment list

Returns​

Promise<void>

refreshKernels()​

refreshKernels(): Promise<void>

Defined in: src/stateful/runtimes/apis.ts:207

Returns​

Promise<void>

Deprecated​

Use refresh instead.

shutdown()​

shutdown(id): Promise<void>

Defined in: src/stateful/runtimes/apis.ts:195

Shut down a kernel by id.

Parameters​

id​

string

The id of the target kernel.

Returns​

Promise<void>

A promise that resolves when the operation is complete.

shutdownAll()​

shutdownAll(): Promise<void>

Defined in: src/stateful/runtimes/apis.ts:202

Shut down all kernels.

Returns​

Promise<void>

A promise that resolves when all of the kernels are shut down.

snapshotRuntime()​

snapshotRuntime(options): Promise<IRuntimeSnapshot | undefined>

Defined in: src/stateful/runtimes/apis.ts:217

Snapshot a runtime

The runtime may be given by its id or podName. A custom description for the snapshot can be provided.

Parameters​

options​
description?​

string

The snapshot description

id?​

string

The runtime id to snapshot

name?​

string

The snapshot name

podName?​

string

The kernel pod name to snapshot

stop?​

boolean

Whether to stop the kernel after the snapshot completion or not.

Returns​

Promise<IRuntimeSnapshot | undefined>

The snapshot description

startNew()​

startNew(createOptions, connectOptions?): Promise<IKernelConnection>

Defined in: src/stateful/runtimes/apis.ts:160

Launch a Kernel.

Parameters​

createOptions​

IRuntimeOptions

The kernel creation options

connectOptions?​

Omit<IOptions, "model" | "serverSettings">

The kernel connection options

Returns​

Promise<IKernelConnection>

A promise that resolves with the kernel connection.