BaseDatasetCollectionClient

Abstract base class for dataset collection clients.

This collection client handles operations that involve multiple instances of a given resource type.

Hierarchy

• BaseDatasetCollectionClient
  • DatasetCollectionClient

Index

Methods

• get_or_create
• list

Methods

get_or_create

• async get_or_create(*, id, name, schema): DatasetMetadata

• Retrieve an existing dataset by its name or ID, or create a new one if it does not exist.

  ---

  Parameters

  • keyword-onlyid: str | None = None

    Optional ID of the dataset to retrieve or create. If provided, the method will attempt to find a dataset with the ID.

  • keyword-onlyname: str | None = None

    Optional name of the dataset resource to retrieve or create. If provided, the method will attempt to find a dataset with this name.

  • keyword-onlyschema: dict | None = None

    Optional schema for the dataset resource to be created.

  Returns DatasetMetadata

  Metadata object containing the information of the retrieved or created dataset.

list

• async list(*, unnamed, limit, offset, desc): DatasetListPage

• List the available datasets.

  ---

  Parameters

  • keyword-onlyunnamed: bool = False

    Whether to list only the unnamed datasets.

  • keyword-onlylimit: int | None = None

    Maximum number of datasets to return.

  • keyword-onlyoffset: int | None = None

    Number of datasets to skip from the beginning of the list.

  • keyword-onlydesc: bool = False

    Whether to sort the datasets in descending order.

  Returns DatasetListPage

  The list of available datasets matching the specified filters.