DatalayerClient

Datalayer Core

---

Datalayer Core / DatalayerClient

Class: DatalayerClient

Defined in: tech/datalayer/core/src/client/index.ts:78

Main Datalayer Client providing unified access to all platform services. Uses TypeScript mixins to provide a flat, discoverable API.

Example

const client = new DatalayerClient({
  token: 'your-token'
});

const user = await client.whoami();
const runtime = await client.createRuntime({
  environment_name: 'python-cpu-env',
  credits_limit: 100
});

Extends

• DatalayerClientWithMixins

Constructors

Constructor

new DatalayerClient(config): DatalayerClient

Defined in: tech/datalayer/core/src/client/index.ts:84

Create a DatalayerClient instance.

Parameters

config

DatalayerClientConfig

Client configuration options

Returns

DatalayerClient

Overrides

DatalayerClientWithMixins.constructor

Properties

environments

readonly environments: Environment[] = []

Defined in: tech/datalayer/core/src/client/base.ts:49

Environments

Inherited from

DatalayerClientWithMixins.environments

---

handlers?

readonly optional handlers: SDKHandlers

Defined in: tech/datalayer/core/src/client/base.ts:51

Method lifecycle handlers

Inherited from

DatalayerClientWithMixins.handlers

---

iamRunUrl

readonly iamRunUrl: string

Defined in: tech/datalayer/core/src/client/base.ts:41

URL for IAM service

Inherited from

DatalayerClientWithMixins.iamRunUrl

---

runtimesRunUrl

readonly runtimesRunUrl: string

Defined in: tech/datalayer/core/src/client/base.ts:43

URL for Runtimes service

Inherited from

DatalayerClientWithMixins.runtimesRunUrl

---

spacerRunUrl

readonly spacerRunUrl: string

Defined in: tech/datalayer/core/src/client/base.ts:45

URL for Spacer service

Inherited from

DatalayerClientWithMixins.spacerRunUrl

---

token?

optional token: string

Defined in: tech/datalayer/core/src/client/base.ts:47

Authentication token

Inherited from

DatalayerClientWithMixins.token

Methods

calculateCreditsFromMinutes()

calculateCreditsFromMinutes(minutes, burningRate): number

Defined in: tech/datalayer/core/src/client/index.ts:207

Parameters

minutes

number

burningRate

number

Returns

number

Inherited from

DatalayerClientWithMixins.calculateCreditsFromMinutes

---

calculateCreditsRequired()

calculateCreditsRequired(minutes, burningRate): number

Defined in: tech/datalayer/core/src/client/index.ts:131

Parameters

minutes

number

burningRate

number

Returns

number

---

calculateMaxRuntimeMinutes()

calculateMaxRuntimeMinutes(availableCredits, burningRate): number

Defined in: tech/datalayer/core/src/client/index.ts:127

Parameters

availableCredits

number

burningRate

number

Returns

number

---

checkIAMHealth()

checkIAMHealth(): Promise<HealthCheck>

Defined in: tech/datalayer/core/src/client/index.ts:132

Returns

Promise<HealthCheck>

---

checkRuntimesHealth()

checkRuntimesHealth(): Promise<HealthCheck>

Defined in: tech/datalayer/core/src/client/index.ts:163

Returns

Promise<HealthCheck>

---

checkSpacerHealth()

checkSpacerHealth(): Promise<HealthCheck>

Defined in: tech/datalayer/core/src/client/index.ts:205

Returns

Promise<HealthCheck>

---

createLexical()

createLexical(spaceId, name, description, file?): Promise<Lexical>

Defined in: tech/datalayer/core/src/client/index.ts:188

Parameters

spaceId

string

name

string

description

string

file?

Blob | File

Returns

Promise<Lexical>

---

createNotebook()

createNotebook(spaceId, name, description, file?): Promise<Notebook>

Defined in: tech/datalayer/core/src/client/index.ts:176

Parameters

spaceId

string

name

string

description

string

file?

Blob | File

Returns

Promise<Notebook>

---

createRuntime()

createRuntime(environmentName, type, givenName, minutesLimit, fromSnapshotId?): Promise<Runtime>

Defined in: tech/datalayer/core/src/client/index.ts:144

Parameters

environmentName

string

type

"notebook" | "terminal" | "job"

givenName

string

minutesLimit

number

fromSnapshotId?

string

Returns

Promise<Runtime>

---

createSnapshot()

createSnapshot(podName, name, description, stop?): Promise<Snapshot>

Defined in: tech/datalayer/core/src/client/index.ts:154

Parameters

podName

string

name

string

description

string

stop?

boolean

Returns

Promise<Snapshot>

---

createSpace()

createSpace(name, description, variant, spaceHandle, organizationId, seedSpaceId, isPublic): Promise<Space>

Defined in: tech/datalayer/core/src/client/index.ts:167

Parameters

name

string

description

string

variant

string

spaceHandle

string

organizationId

string

seedSpaceId

string

isPublic

boolean

Returns

Promise<Space>

---

deleteRuntime()

deleteRuntime(podName): Promise<void>

Defined in: tech/datalayer/core/src/client/index.ts:153

Parameters

podName

string

Returns

Promise<void>

---

deleteSnapshot()

deleteSnapshot(id): Promise<void>

Defined in: tech/datalayer/core/src/client/index.ts:162

Parameters

id

string

Returns

Promise<void>

---

deleteSpaceItem()

deleteSpaceItem(itemId): Promise<void>

Defined in: tech/datalayer/core/src/client/index.ts:202

Parameters

itemId

string

Returns

Promise<void>

---

ensureRuntime()

ensureRuntime(environmentName?, creditsLimit?, waitForReady?, maxWaitTime?, reuseExisting?, snapshotId?): Promise<Runtime>

Defined in: tech/datalayer/core/src/client/index.ts:136

Parameters

environmentName?

string

creditsLimit?

number

waitForReady?

boolean

maxWaitTime?

number

reuseExisting?

boolean

snapshotId?

string

Returns

Promise<Runtime>

---

getCollaborationSessionId()

getCollaborationSessionId(documentId): Promise<string>

Defined in: tech/datalayer/core/src/client/index.ts:203

Parameters

documentId

string

Returns

Promise<string>

---

getConfig()

getConfig(): DatalayerClientConfig

Defined in: tech/datalayer/core/src/client/base.ts:70

Get the current configuration including service URLs and token.

Returns

DatalayerClientConfig

Current configuration

Inherited from

DatalayerClientWithMixins.getConfig

---

getContent()

getContent(itemId): Promise<any>

Defined in: tech/datalayer/core/src/client/index.ts:204

Parameters

itemId

string

Returns

Promise<any>

---

getCredits()

getCredits(): Promise<Credits>

Defined in: tech/datalayer/core/src/client/index.ts:126

Returns

Promise<Credits>

---

getIamRunUrl()

getIamRunUrl(): string

Defined in: tech/datalayer/core/src/client/base.ts:80

Get the IAM service URL.

Returns

string

Inherited from

DatalayerClientWithMixins.getIamRunUrl

---

getLexical()

getLexical(id): Promise<Lexical>

Defined in: tech/datalayer/core/src/client/index.ts:194

Parameters

id

string

Returns

Promise<Lexical>

---

getMySpaces()

getMySpaces(): Promise<Space[]>

Defined in: tech/datalayer/core/src/client/index.ts:166

Returns

Promise<Space[]>

---

getNotebook()

getNotebook(id): Promise<Notebook>

Defined in: tech/datalayer/core/src/client/index.ts:182

Parameters

id

string

Returns

Promise<Notebook>

---

getRuntime()

getRuntime(podName): Promise<Runtime>

Defined in: tech/datalayer/core/src/client/index.ts:152

Parameters

podName

string

Returns

Promise<Runtime>

---

getRuntimesRunUrl()

getRuntimesRunUrl(): string

Defined in: tech/datalayer/core/src/client/base.ts:85

Get the Runtimes service URL.

Returns

string

Inherited from

DatalayerClientWithMixins.getRuntimesRunUrl

---

getSnapshot()

getSnapshot(id): Promise<Snapshot>

Defined in: tech/datalayer/core/src/client/index.ts:161

Parameters

id

string

Returns

Promise<Snapshot>

---

getSpaceItem()

getSpaceItem(itemId): Promise<Notebook | Lexical>

Defined in: tech/datalayer/core/src/client/index.ts:201

Parameters

itemId

string

Returns

Promise<Notebook | Lexical>

---

getSpaceItems()

getSpaceItems(spaceId): Promise<(Notebook | Lexical)[]>

Defined in: tech/datalayer/core/src/client/index.ts:200

Parameters

spaceId

string

Returns

Promise<(Notebook | Lexical)[]>

---

getSpacerRunUrl()

getSpacerRunUrl(): string

Defined in: tech/datalayer/core/src/client/base.ts:90

Get the Spacer service URL.

Returns

string

Inherited from

DatalayerClientWithMixins.getSpacerRunUrl

---

getToken()

getToken(): undefined | string

Defined in: tech/datalayer/core/src/client/index.ts:119

Returns

undefined | string

Inherited from

DatalayerClientWithMixins.getToken

---

listEnvironments()

listEnvironments(): Promise<Environment[]>

Defined in: tech/datalayer/core/src/client/index.ts:135

Returns

Promise<Environment[]>

---

listRuntimes()

listRuntimes(): Promise<Runtime[]>

Defined in: tech/datalayer/core/src/client/index.ts:151

Returns

Promise<Runtime[]>

---

listSnapshots()

listSnapshots(): Promise<Snapshot[]>

Defined in: tech/datalayer/core/src/client/index.ts:160

Returns

Promise<Snapshot[]>

---

login()

login(token): Promise<User>

Defined in: tech/datalayer/core/src/client/index.ts:124

Parameters

token

string

Returns

Promise<User>

---

logout()

logout(): Promise<void>

Defined in: tech/datalayer/core/src/client/index.ts:125

Returns

Promise<void>

---

setToken()

setToken(token): Promise<void>

Defined in: tech/datalayer/core/src/client/index.ts:120

Parameters

token

string

Returns

Promise<void>

Inherited from

DatalayerClientWithMixins.setToken

---

updateLexical()

updateLexical(id, name?, description?): Promise<Lexical>

Defined in: tech/datalayer/core/src/client/index.ts:195

Parameters

id

string

name?

string

description?

string

Returns

Promise<Lexical>

---

updateNotebook()

updateNotebook(id, name?, description?): Promise<Notebook>

Defined in: tech/datalayer/core/src/client/index.ts:183

Parameters

id

string

name?

string

description?

string

Returns

Promise<Notebook>

---

whoami()

whoami(): Promise<User>

Defined in: tech/datalayer/core/src/client/index.ts:123

Returns

Promise<User>

---

wrapAllMethods()

protected wrapAllMethods(): void

Defined in: tech/datalayer/core/src/client/base.ts:113

Internal

Wrap all SDK methods with handlers for cross-cutting concerns. Called automatically by the DatalayerClient constructor.

Returns

void

Inherited from

DatalayerClientWithMixins.wrapAllMethods