foundry_dev_tools.clients.metadata module

foundry_dev_tools.clients.metadata module#

Implementation of the metadata API.

class foundry_dev_tools.clients.metadata.MetadataClient[source]#

Bases: APIClient

MetadataClient class that implements methods from the ‘foundry-metadata’ API.

api_name: ClassVar[str] = 'foundry-metadata'#
api_upload_dataset_schema(dataset_rid, transaction_rid, schema, branch, **kwargs)[source]#

Uploads the foundry dataset schema for a dataset, transaction, branch combination.

Parameters:

  • dataset_rid (api_types.DatasetRid) – The rid of the dataset

  • transaction_rid (api_types.TransactionRid) – The rid of the transaction

  • schema (dict) – The foundry schema

  • branch (api_types.Ref) – The branch

  • **kwargs – gets passed to APIClient.api_request()

Return type:

requests.Response

api_get_dataset_schema(dataset_rid, branch, transaction_rid=None, **kwargs)[source]#

Returns the foundry dataset schema for a dataset, transaction, branch combination.

Parameters:

  • dataset_rid (api_types.DatasetRid) – The rid of the dataset

  • transaction_rid (api_types.TransactionRid | None) – The rid of the transaction

  • branch (api_types.Ref) – The branch

  • **kwargs – gets passed to APIClient.api_request()

Return type:

requests.Response

Contents