:py:mod:`rhino_health.lib.endpoints.federated_dataset.federated_dataset_endpoints`
==================================================================================

.. py:module:: rhino_health.lib.endpoints.federated_dataset.federated_dataset_endpoints


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.endpoints.federated_dataset.federated_dataset_endpoints.FederatedDatasetEndpoints




.. py:class:: FederatedDatasetEndpoints(session)


   Bases: :py:obj:`rhino_health.lib.endpoints.endpoint.Endpoint`

   

















   ..
       !! processed by numpydoc !!
   .. py:method:: get_federated_datasets(federated_dataset_uids: Optional[List[str]] = 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















      ..
          !! processed by numpydoc !!

   .. py:method:: get_federated_dataset_by_name(name, version: Optional[Union[int, rhino_health.lib.endpoints.endpoint.VersionMode]] = VersionMode.LATEST) -> Optional[rhino_health.lib.endpoints.federated_dataset.federated_dataset_dataclass.FederatedDataset]

      
      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










      .. rubric:: Examples

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



      ..
          !! processed by numpydoc !!

   .. py:method:: search_for_federated_datasets_by_name(name: str, version: Optional[Union[int, rhino_health.lib.endpoints.endpoint.VersionMode]] = VersionMode.LATEST, name_filter_mode: Optional[rhino_health.lib.endpoints.endpoint.NameFilterMode] = 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







      .. seealso::

          
          :obj:`rhino_health.lib.endpoints.endpoint.FilterMode`
              Different modes to filter by
          :obj:`rhino_health.lib.endpoints.endpoint.VersionMode`
              Return specific versions
          
          


      .. rubric:: Examples

      >>> session.data_schema.search_for_data_schemas_by_name("My Federated Dataset")
      [FederatedDataset(name="My Federated Dataset")]



      ..
          !! processed by numpydoc !!