root.datasets

Classes

DataSets

DataSets (sub) API

Module Contents

class root.datasets.DataSets(client: Awaitable[root.generated.openapi_aclient.ApiClient] | root.generated.openapi_client.ApiClient, base_url: str, api_key: str)

DataSets (sub) API

Note

The construction of the API instance should be handled by accesing an attribute of a root.client.RootSignals instance.

Parameters:

  • client (Union[Awaitable[root.generated.openapi_aclient.ApiClient], root.generated.openapi_client.ApiClient])

  • base_url (str)

  • api_key (str)

async acreate(*, name: str | None = None, path: str | None = None, type: str = 'reference', _request_timeout: int | None = None) → root.generated.openapi_aclient.models.data_set_create.DataSetCreate | None

Asynchronously create a dataset object with the given parameters to the registry. If the dataset has a path, it will be uploaded to the registry.

Parameters:

  • name (Optional[str])

  • path (Optional[str])

  • type (str)

  • _request_timeout (Optional[int])

Return type:

Optional[root.generated.openapi_aclient.models.data_set_create.DataSetCreate]

async adelete(dataset_id: str, *, _request_timeout: int | None = None) → None

Asynchronously delete a dataset object from the registry.

Parameters:

  • dataset_id (str)

  • _request_timeout (Optional[int])

Return type:

None

async aget(dataset_id: str, *, _request_timeout: int | None = None) → root.generated.openapi_aclient.models.data_set_list.DataSetList

Asynchronously get a dataset object from the registry.

Parameters:

  • dataset_id (str)

  • _request_timeout (Optional[int])

Return type:

root.generated.openapi_aclient.models.data_set_list.DataSetList

async alist(search_term: str | None = None, *, limit: int = 100, _request_timeout: int | None = None) → AsyncIterator[root.generated.openapi_aclient.models.data_set_list.DataSetList]

Asynchronously iterate through the datasets.

Parameters:

  • limit (int) – Number of entries to iterate through at most.

  • search_term (Optional[str]) – Can be used to limit returned datasets.

  • _request_timeout (Optional[int])

Return type:

AsyncIterator[root.generated.openapi_aclient.models.data_set_list.DataSetList]

create(*, name: str | None = None, path: str | None = None, type: str = 'reference', _request_timeout: int | None = None) → root.generated.openapi_client.models.data_set_create.DataSetCreate | None

Create a dataset object with the given parameters to the registry. If the dataset has a path, it will be uploaded to the registry.

Parameters:

  • name (Optional[str])

  • path (Optional[str])

  • type (str)

  • _request_timeout (Optional[int])

Return type:

Optional[root.generated.openapi_client.models.data_set_create.DataSetCreate]

delete(dataset_id: str, *, _request_timeout: int | None = None) → None

Delete a dataset object from the registry.

Parameters:

  • dataset_id (str)

  • _request_timeout (Optional[int])

Return type:

None

get(dataset_id: str, *, _request_timeout: int | None = None) → root.generated.openapi_client.models.data_set_list.DataSetList

Get a dataset object from the registry.

Parameters:

  • dataset_id (str)

  • _request_timeout (Optional[int])

Return type:

root.generated.openapi_client.models.data_set_list.DataSetList

list(search_term: str | None = None, *, limit: int = 100, _request_timeout: int | None = None) → Iterator[root.generated.openapi_client.models.data_set_list.DataSetList]

Iterate through the datasets.

Parameters:

  • limit (int) – Number of entries to iterate through at most.

  • search_term (Optional[str]) – Can be used to limit returned datasets.

  • _request_timeout (Optional[int])

Return type:

Iterator[root.generated.openapi_client.models.data_set_list.DataSetList]

api_key
base_url
client