`rhino_health.lib.endpoints.federated_dataset.federated_dataset_endpoints`#

Module Contents#

class rhino_health.lib.endpoints.federated_dataset.federated_dataset_endpoints.FederatedDatasetEndpoints(session)#

Bases: rhino_health.lib.endpoints.endpoint.Endpoint

get_federated_datasets(federated_dataset_uids: List[str] | None = None) → List[rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass.FederatedDataset]#: Gets the Federated Datasets with the specified FEDERATED_DATASET_UIDS

Warning

This feature is under development and the interface may change

get_federated_dataset_by_name(name, version: int | rhino_health.lib.endpoints.endpoint.VersionMode | None = VersionMode.LATEST) → rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass.FederatedDataset | None#

Returns the latest or a specific Federated Dataset

Warning

This feature is under development and the interface may change

Warning

VersionMode.ALL will return the same as VersionMode.LATEST

Parameters:

name: str: Full name for the Federated Dataset
version: Optional[Union[int, VersionMode]]: Version of the Federated Dataset, latest by default, for an earlier version pass in an integer
project_uid: Optional[str]: Project UID to search under

Returns:

data_schema: Optional[FederatedDataset]: Federated Dataset with the name or None if not found

Examples

>>> session.federated_dataset.get_federated_dataset_by_name("My Federated Dataset")
FederatedDataset("My Federated Dataset")

search_for_federated_datasets_by_name(name: str, version: int | rhino_health.lib.endpoints.endpoint.VersionMode | None = VersionMode.LATEST, name_filter_mode: rhino_health.lib.endpoints.endpoint.NameFilterMode | None = NameFilterMode.CONTAINS) → List[rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass.FederatedDataset]#

Returns DataSchema dataclasses

Warning

This feature is under development and the interface may change

Parameters:

name: str: Full or partial name for the Federated Dataset
version: Optional[Union[int, VersionMode]]: Version of the Federated Dataset, latest by default
project_uid: Optional[str]: Project UID to search under
name_filter_mode: Optional[NameFilterMode]: Only return results with the specified filter mode. By default uses CONTAINS

Returns:

data_schemas: List[FederatedDataset]: Federated Dataset dataclasses that match the name