Notebook
Datalayer Core / Notebook
Class: Notebook
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:57
Notebook domain model that extends the base Item class. Provides notebook-specific functionality for managing Jupyter notebooks.
Example
const notebook = await sdk.createNotebook(formData);
const kernelSpec = await notebook.getKernelSpec();
Extends
Item<NotebookData>
Constructors
Constructor
new Notebook(
data,sdk):Notebook
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:64
Create a Notebook instance.
Parameters
data
Notebook
Notebook data from API
sdk
SDK instance
Returns
Notebook
Overrides
Properties
_data
protected_data:Notebook
Defined in: tech/datalayer/core/src/client/models/Item.ts:23
Inherited from
Accessors
content
Get Signature
get content():
any
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:90
The cached content.
Returns
any
Overrides
createdAt
Get Signature
get createdAt():
Date
Defined in: tech/datalayer/core/src/client/models/Item.ts:105
When the item was created.
Returns
Date
Inherited from
description
Get Signature
get description():
string
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:164
Description of the notebook.
Returns
string
extension
Get Signature
get extension():
string
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:170
Get the notebook extension.
Returns
string
id
Get Signature
get id():
string
Defined in: tech/datalayer/core/src/client/models/Item.ts:63
Item ID.
Returns
string
Inherited from
isDeleted
Get Signature
get isDeleted():
boolean
Defined in: tech/datalayer/core/src/client/models/Item.ts:42
Check if this item has been deleted.
Returns
boolean
Inherited from
kernelSpec
Get Signature
get kernelSpec():
any
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:158
Kernel specification (cached).
Returns
any
metadata
Get Signature
get metadata():
Record<string,any>
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:152
Notebook metadata.
Returns
Record<string, any>
name
Get Signature
get name():
string
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:79
The cached name of the notebook.
Returns
string
Overrides
ownerId
Get Signature
get ownerId():
string
Defined in: tech/datalayer/core/src/client/models/Item.ts:97
Owner user ID.
Returns
string
Inherited from
path
Get Signature
get path():
string
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:140
File path within the space.
Returns
string
spaceId
Get Signature
get spaceId():
string
Defined in: tech/datalayer/core/src/client/models/Item.ts:75
Parent space ID.
Returns
string
Inherited from
type
Get Signature
get type():
string
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:73
Document type identifier.
Returns
string
Overrides
uid
Get Signature
get uid():
string
Defined in: tech/datalayer/core/src/client/models/Item.ts:69
Unique identifier for the item.
Returns
string
Inherited from
updatedAt
Get Signature
get updatedAt():
Date
Defined in: tech/datalayer/core/src/client/models/Item.ts:118
The cached update time.
Returns
Date
Inherited from
version
Get Signature
get version():
number
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:146
Version number.
Returns
number
Methods
_checkDeleted()
protected_checkDeleted():void
Defined in: tech/datalayer/core/src/client/models/Item.ts:50
Check if this item has been deleted and throw error if so.
Returns
void
Throws
Error if deleted
Inherited from
_getSpacerRunUrl()
protected_getSpacerRunUrl():string
Defined in: tech/datalayer/core/src/client/models/Item.ts:251
Get spacer API URL for API calls.
Returns
string
Inherited from
_getToken()
protected_getToken():string
Defined in: tech/datalayer/core/src/client/models/Item.ts:246
Get SDK token for API calls.
Returns
string
Inherited from
_updateData()
protected_updateData(newData):void
Defined in: tech/datalayer/core/src/client/models/Item.ts:256
Update internal data after API call.
Parameters
newData
Notebook
Returns
void
Inherited from
delete()
delete():
Promise<void>
Defined in: tech/datalayer/core/src/client/models/Item.ts:163
Delete this item permanently. After deletion, all subsequent method calls will throw errors.
Returns
Promise<void>
Inherited from
getContent()
getContent():
Promise<any>
Defined in: tech/datalayer/core/src/client/models/Item.ts:172
Get the document content from API.
Returns
Promise<any>
Inherited from
getName()
getName():
Promise<string>
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:103
Get the current name from API.
Returns
Promise<string>
Overrides
getUpdatedAt()
getUpdatedAt():
Promise<Date>
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:110
Get when the notebook was last updated from API.
Returns
Promise<Date>
Overrides
rawData()
rawData():
Notebook
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:204
Get the raw notebook data exactly as received from the API. This preserves the original snake_case naming from the API response.
Returns
Notebook
Raw notebook data from API
Overrides
toJSON()
toJSON():
NotebookJSON
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:183
Get notebook data in camelCase format. Returns only the core fields that consumers need. This provides a stable interface regardless of API changes.
Returns
NotebookJSON
Core notebook data with camelCase properties
Overrides
toString()
toString():
string
Defined in: tech/datalayer/core/src/client/models/Item.ts:235
String representation of the item.
Returns
string
Inherited from
update()
update(
name?,description?):Promise<Notebook>
Defined in: tech/datalayer/core/src/client/models/Notebook.ts:121
Update the notebook.
Parameters
name?
string
description?
string
Returns
Promise<Notebook>