Class: Datasets

repositories.Datasets

Datasets repository.

The Datasets class allows the user to manage datasets.

Hierarchy

• Repository

  ↳ Datasets

Implements

• IBundle < SDKDataset >

Table of contents

Constructors

• constructor

Methods

• create
• delete
• get
• query
• update

Constructors

constructor

• new Datasets(agent)

Creates an instance of Repository.

Parameters

Inherited from

Repository .constructor

Methods

create

▸ create(payload): Promise<SDKDataset>

Creates a new dataset.

Example

const dataset = await dl.datasets.create({
    name: 'My Dataset'
})

Parameters

Returns

Promise<SDKDataset>

• A promise that resolves to the created dataset.

delete

▸ delete(datasetId): Promise<void>

Deletes a dataset by id.

Example

await dl.datasets.delete('datasetId-123')

Parameters

Returns

Promise<void>

• A promise that resolves when the dataset is deleted.

get

▸ get(datasetId?): Promise<SDKDataset>

Retrieves a dataset by id.

If the dataset id is not provided, the active dataset is returned.

Example

const activeDataset = await dl.datasets.get()

Example

const dataset = await dl.datasets.get('datasetId-123')

Parameters

Returns

Promise<SDKDataset>

• A promise that resolves to the retrieved dataset.

query

▸ query(): Promise<IPagedResponse<SDKDataset>>

Retrieves a list of datasets.

Example

const pagedResponse = await dl.datasets.query()
const datasets = pagedResponse.items

Returns

Promise<IPagedResponse<SDKDataset>>

• Returns a Promise that resolves to a paged response object of datasets.

update

▸ update(payload): Promise<SDKDataset>

Updates a dataset --- currently not supported.

Parameters

Returns

Promise<SDKDataset>

• A promise that resolves to the updated dataset.