`rhino_health.lib.endpoints.project.project_dataclass`#

Module Contents#

Classes#

`ProjectCreateInput`	Input arguments for adding a new project.
`Project`	Dataclass representing a Project on the Rhino platform.
`SystemResources`	Output when calling system resources.

class rhino_health.lib.endpoints.project.project_dataclass.ProjectCreateInput(**data)#

Bases: rhino_health.lib.dataclass.RhinoBaseModel

Input arguments for adding a new project.

name: str#: The name of the Project

description: str#: The description of the Project

type: typing_extensions.Literal[Validation, Refinement]#: The type of the Project

primary_workgroup_uid: typing_extensions.Annotated[str, Field(alias='primary_workgroup')]#: The unique ID of the Project’s Primary Workgroup

permissions: str | None#: JSON-encoded project-level permissions

class rhino_health.lib.endpoints.project.project_dataclass.Project(**data)#

Dataclass representing a Project on the Rhino platform.

property stats#: Returns metadata for this project

property datasets#

Get Datasets associated with this project

See also

rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.get_datasets: Full documentation

property data_schemas#

Get Data Schemas associated with this project

See also

rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.get_data_schemas: Full documentation

property code_objects#

Get CodeObjects associated with this project

See also

rhino_health.lib.endpoints.project.project_endpoints.ProjectEndpoints.get_code_objects: Full documentation

property users#: Return users of this project

property collaborating_workgroups: 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

property primary_workgroup: 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

property creator: 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

uid: str#: The unique ID of the Project

slack_channel: str#: Slack Channel URL for communications for the Project

collaborating_workgroup_uids: List[str]#: A list of unique IDs of the Project’s collaborating Workgroups

name: str#: The name of the Project

description: str#: The description of the Project

type: typing_extensions.Literal[Validation, Refinement]#: The type of the Project

permissions: str | None#: JSON-encoded project-level permissions

creator_uid: str#: The UID of the creator of this dataclass on the system

created_at: str#: When this dataclass was created on the system

collaborating_workgroup_names: List[str]#: The collaborating_workgroup names

primary_workgroup_name: str#: The primary_workgroup name

creator_name: str#: The creator name

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

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

get_dataset_by_name(name, version=VersionMode.LATEST, **_kwargs)#