rhino_health.lib.rhino_session

Module Contents

Classes

RhinoSession

Allows access to various endpoints directly from the RhinoSession

class rhino_health.lib.rhino_session.RhinoSession(authentication_details: rhino_health.lib.rest_api.rhino_authenticator.AuthenticationDetailType | None = None, otp_code: str | None = None, rhino_api_url: str = ApiEnvironment.PROD_API_URL, sdk_version: str = SDKVersion.PREVIEW, show_traceback: bool = False)

Bases: rhino_health.lib.rhino_client.RhinoClient

Allows access to various endpoints directly from the RhinoSession

See also

rhino_health.lib.endpoints.code_object.code_object_endpoints

Available code_object endpoints

rhino_health.lib.endpoints.code_run.code_run_endpoints

Available code_run endpoints

rhino_health.lib.endpoints.dataset.dataset_endpoints

Available dataset endpoints

rhino_health.lib.endpoints.data_schema.data_schema_endpoints

Available data_schema endpoints

rhino_health.lib.endpoints.project.project_endpoints

Available project endpoints

rhino_health.lib.endpoints.sql_query.sql_query_endpoints

Available sql_query endpoints

rhino_health.lib.endpoints.user.user_endpoints

Available user endpoints

rhino_health.lib.endpoints.workgroup.workgroup_endpoints

Available workgroup endpoints

Examples

>>> session.project.get_projects()
array[Project...]
>>> session.dataset.get_dataset(my_dataset_uid)
Dataset

Attributes:

code_object: Access endpoints at the code_object level

code_run: Access endpoints at the code_run level

dataset: Access endpoints at the dataset level

data_schema: Access endpoints at the data_schema level

federated_dataset: Access endpoints for federated_datasets

project: Access endpoints at the project level

sql_query: Access endpoints for sql queries

user: Access endpoints at the user level

workgroup: Access endpoints at the workgroup level

property current_user

Returns the logged in user

switch_user(authentication_details, otp_code=None)

Switch the currently logged in user.

Parameters:

authentication_details: AuthenticationDetailType

A dictionary containing authentication details

otp_code: Optional[str]

2FA login code if 2FA is enabled for the account

See also

rhino_health.lib.rest_api.rhino_authenticator.AuthenticationDetailType

AuthenticationDetailType