foundry_dev_tools.clients.data_health module

foundry_dev_tools.clients.data_health module#

Implementation of the data-health API.

class foundry_dev_tools.clients.data_health.DataHealthClient[source]#

Bases: APIClient

DataHealthClient class that implements methods from the ‘foundry-data-health’ API.

api_name: ClassVar[str] = 'data-health'#
api_get_checks_for_dataset(dataset_rid, branch='master', **kwargs)[source]#

Gets all the Check RIDs available for the given Dataset RID and branch name.

Parameters:

  • dataset_rid (DatasetRid) – The RID of the dataset

  • branch (str) – The name of the branch

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

Return type:

requests.Response

api_get_latest_checks_history(check_rids, limit=5, **kwargs)[source]#

Returns CheckRun metadata for the last limit number of check runs for the given list of Check RIDs.

Parameters:

  • check_rids (list[CheckRid] | CheckRid) – a list of CheckRIDs or a single string value.

  • limit (int) – number of last check runs to go for for each Check RID. Defaults to 5.

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

Return type:

requests.Response

Contents