:py:mod:`rhino_health.lib.endpoints.project.project_dataclass` ============================================================== .. py:module:: rhino_health.lib.endpoints.project.project_dataclass Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: rhino_health.lib.endpoints.project.project_dataclass.ProjectCreateInput rhino_health.lib.endpoints.project.project_dataclass.Project rhino_health.lib.endpoints.project.project_dataclass.SystemResources .. py:class:: ProjectCreateInput(**data) Bases: :py:obj:`rhino_health.lib.dataclass.RhinoBaseModel` Input arguments for adding a new project. .. !! processed by numpydoc !! .. py:attribute:: name :type: str The name of the Project .. !! processed by numpydoc !! .. py:attribute:: description :type: str The description of the Project .. !! processed by numpydoc !! .. py:attribute:: type :type: typing_extensions.Literal[Validation, Refinement] The type of the Project .. !! processed by numpydoc !! .. py:attribute:: primary_workgroup_uid :type: typing_extensions.Annotated[str, Field(alias='primary_workgroup')] The unique ID of the Project's Primary Workgroup .. !! processed by numpydoc !! .. py:attribute:: permissions :type: Optional[str] JSON-encoded project-level permissions .. !! processed by numpydoc !! .. py:class:: Project(**data) Dataclass representing a Project on the Rhino platform. .. !! processed by numpydoc !! .. py:property:: stats Returns metadata for this project .. !! processed by numpydoc !! .. py:property:: datasets Get Datasets associated with this project .. seealso:: :obj:`rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.get_datasets` Full documentation .. !! processed by numpydoc !! .. py:property:: data_schemas Get Data Schemas associated with this project .. seealso:: :obj:`rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.get_data_schemas` Full documentation .. !! processed by numpydoc !! .. py:property:: code_objects Get CodeObjects associated with this project .. seealso:: :obj:`rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.get_code_objects` Full documentation .. !! processed by numpydoc !! .. py:property:: users Return users of this project .. !! processed by numpydoc !! .. py:property:: collaborating_workgroups :type: List[Workgroup] Return the Workgroup Dataclasses associated with collaborating_workgroup_uids .. warning:: The result of this function is cached. Be careful calling this function after making changes. All dataclasses must already exist on the platform before making this call. :Returns: collaborating_workgroups: List[Workgroup] Dataclasses representing the Workgroup .. py:property:: primary_workgroup :type: Workgroup Return the Workgroup Dataclass associated with primary_workgroup_uid .. warning:: The result of this function is cached. Be careful calling this function after making changes. All dataclasses must already exist on the platform before making this call. :Returns: primary_workgroup: Workgroup Dataclass representing the Workgroup .. py:property:: creator :type: User Return the User Dataclass associated with creator_uid .. warning:: The result of this function is cached. Be careful calling this function after making changes. All dataclasses must already exist on the platform before making this call. :Returns: creator: User Dataclass representing the User .. py:attribute:: uid :type: str The unique ID of the Project .. !! processed by numpydoc !! .. py:attribute:: slack_channel :type: str Slack Channel URL for communications for the Project .. !! processed by numpydoc !! .. py:attribute:: collaborating_workgroup_uids :type: List[str] A list of unique IDs of the Project's collaborating Workgroups .. !! processed by numpydoc !! .. py:attribute:: name :type: str The name of the Project .. !! processed by numpydoc !! .. py:attribute:: description :type: str The description of the Project .. !! processed by numpydoc !! .. py:attribute:: type :type: typing_extensions.Literal[Validation, Refinement] The type of the Project .. !! processed by numpydoc !! .. py:attribute:: permissions :type: Optional[str] JSON-encoded project-level permissions .. !! processed by numpydoc !! .. py:attribute:: creator_uid :type: str The UID of the creator of this dataclass on the system .. !! processed by numpydoc !! .. py:attribute:: created_at :type: str When this dataclass was created on the system .. !! processed by numpydoc !! .. py:attribute:: collaborating_workgroup_names :type: List[str] The collaborating_workgroup names .. py:attribute:: primary_workgroup_name :type: str The primary_workgroup name .. py:attribute:: creator_name :type: str The creator name .. py:method:: add_collaborator(collaborator_or_uid) Adds COLLABORATOR_OR_UID as a collaborator to this project .. warning:: This feature is under development and the interface may change .. !! processed by numpydoc !! .. py:method:: remove_collaborator(collaborator_or_uid) Removes COLLABORATOR_OR_UID as a collaborator from this project .. warning:: This feature is under development and the interface may change .. !! processed by numpydoc !! .. py:method:: get_dataset_by_name(name, version=VersionMode.LATEST, **_kwargs) Get Dataset associated with this project .. seealso:: :obj:`rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.get_dataset_by_name` Full documentation .. !! processed by numpydoc !! .. py:method:: search_for_datasets_by_name(name, version=VersionMode.LATEST, name_filter_mode=None, **_kwargs) Get Datasets associated with this project .. seealso:: :obj:`rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.search_for_datasets_by_name` Full documentation .. !! processed by numpydoc !! .. py:method:: get_data_schema_by_name(name, version=VersionMode.LATEST, **_kwargs) Get DataSchema associated with this project .. seealso:: :obj:`rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.get_data_schema_by_name` Full documentation .. !! processed by numpydoc !! .. py:method:: search_for_data_schemas_by_name(name, version=VersionMode.LATEST, name_filter_mode=None, **_kwargs) Get Data Schemas associated with this project .. seealso:: :obj:`rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.search_for_data_schemas_by_name` Full documentation .. !! processed by numpydoc !! .. py:method:: get_code_object_by_name(name, version=VersionMode.LATEST, **_kwargs) Get CodeObject associated with this project .. seealso:: :obj:`rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.get_code_object_by_name` Full documentation .. !! processed by numpydoc !! .. py:method:: search_for_code_objects_by_name(name, version=VersionMode.LATEST, name_filter_mode=None, **_kwargs) Get CodeObjects associated with this project .. seealso:: :obj:`rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.search_for_code_objects_by_name` Full documentation .. !! processed by numpydoc !! .. py:method:: aggregate_dataset_metric(*args, **kwargs) Performs an aggregate dataset metric .. seealso:: :obj:`rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.aggregate_dataset_metric` Full documentation .. !! processed by numpydoc !! .. py:method:: joined_dataset_metric(*args, **kwargs) Performs a federated join dataset metric .. seealso:: :obj:`rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.joined_dataset_metric` Full documentation .. !! processed by numpydoc !! .. py:method:: get_agent_resources_for_workgroup(*args, **kwargs) .. py:class:: SystemResources(**data) Bases: :py:obj:`rhino_health.lib.dataclass.RhinoBaseModel` Output when calling system resources. .. !! processed by numpydoc !! .. py:attribute:: filesystem_storage :type: dict filesystem storage in bytes (free, used, total) .. !! processed by numpydoc !! .. py:attribute:: cpu_percent_used :type: float used cpu percent .. !! processed by numpydoc !! .. py:attribute:: memory :type: dict Memory data in bytes (free, used, total) .. !! processed by numpydoc !! .. py:attribute:: gpu :type: dict The GPU usage data per gpu .. !! processed by numpydoc !!