:py:mod:`rhino_health.lib.endpoints.dataset.dataset_endpoints`
==============================================================

.. py:module:: rhino_health.lib.endpoints.dataset.dataset_endpoints


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

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.endpoints.dataset.dataset_endpoints.DatasetEndpoints




.. py:class:: DatasetEndpoints(session)


   Bases: :py:obj:`LTSDatasetEndpoints`

   

   @base_class False

   Endpoints available to interact with Datasets on the Rhino Platform










   .. rubric:: Notes

   You should access these endpoints from the RhinoSession object





   ..
       !! processed by numpydoc !!
   .. py:method:: export_dataset(dataset_uid: str, output_location: str, output_format: str)

      
      Sends an export dataset request to the ON-PREM instance holding the specified DATASET_UID.
      The file will be exported to OUTPUT_LOCATION on the on-prem instance in OUTPUT_FORMAT

      .. warning:: This feature is under development and the interface may change

      :Parameters:

          **dataset_uid: str**
              UID for the Dataset to export information on

          **output_location: str**
              Path to output the exported data to on the remote on-prem instance

          **output_format: str**
              The format to export the Dataset data in














      ..
          !! processed by numpydoc !!

   .. py:method:: sync_dataset_info(dataset_uid: str)

      
      Initializes a data sync from the relevant on-prem instance for the provided DATASET_UID

      .. warning:: This feature is under development and the interface may change

      :Parameters:

          **dataset_uid: str**
              UID for the Dataset to sync info














      ..
          !! processed by numpydoc !!

   .. py:method:: remove_dataset(dataset_uid: str)

      
      Remove a Dataset with DATASET_UID from the system

      .. warning:: This feature is under development and the interface may change

      :Parameters:

          **dataset_uid: str**
              UID for the Dataset to remove














      ..
          !! processed by numpydoc !!

   .. py:method:: get_dataset(dataset_uid: str)

      

      Returns a Dataset dataclass


      :Parameters:

          **dataset_uid: str**
              UID for the Dataset

      :Returns:

          dataset: Dataset
              Dataset dataclass










      .. rubric:: Examples

      >>> session.dataset.get_dataset(my_dataset_uid)
      Dataset()



      ..
          !! processed by numpydoc !!

   .. py:method:: get_dataset_metric(dataset_uid: str, metric_configuration) -> rhino_health.lib.metrics.base_metric.MetricResponse

      

      Queries the Dataset with DATASET_UID on-prem and returns the result based on the METRIC_CONFIGURATION


      :Parameters:

          **dataset_uid: str**
              UID for the Dataset to query metrics against

          **metric_configuration:**
              Configuration for the query to run

      :Returns:

          metric_response: MetricResponse
              A response object containing the result of the query







      .. seealso::

          
          :obj:`rhino_health.lib.metrics`
              Dataclasses specifying possible metric configurations to send
          :obj:`rhino_health.lib.metrics.base_metric.MetricResponse`
              Response object
          
          





      ..
          !! processed by numpydoc !!