Galaxy Clusters

export_galaxy async

export_galaxy(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], galaxy_id: Annotated[str, Path(alias=galaxyId)], body: ExportGalaxyBody) -> list[ExportGalaxyClusterResponse]

Export galaxy cluster.

args:

• the user’s authentification status

• the current database

• the galaxy id

• the request body

returns:

• the exported galaxy cluster

galaxies_attachCluster async

galaxies_attachCluster(auth: Annotated[Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))], db: Annotated[Session, Depends(get_db)], attach_target_id: Annotated[str, Path(alias=attachTargetId)], attach_target_type: Annotated[AttachTargetTypes, Path(alias=attachTargetType)], body: AttachClusterGalaxyBody, local: bool) -> AttachClusterGalaxyResponse

Attach a Galaxy Cluster to given Galaxy.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SITE_ADMIN]))]	the user’s authentification status	required
db	Annotated[Session, Depends(get_db)]	the current database	required
attach_target_id	Annotated[str, Path(alias=attachTargetId)]	the id of the attach target	required
attach_target_type	Annotated[AttachTargetTypes, Path(alias=attachTargetType)]	the type of the attach target	required
body	AttachClusterGalaxyBody	the request body	required
local	bool	local	required

Returns:

Type	Description
AttachClusterGalaxyResponse	the attached galaxy cluster and the attach target

get_galaxy_cluster async

get_galaxy_cluster(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], cluster_id: Annotated[int, Path(alias=clusterID)]) -> GalaxyClusterResponse

Returns information from a galaxy cluster selected by its id.

args:

• the user’s authentification status

• the current database

• the galaxy id

returns:

• the information of the galaxy cluster

get_galaxy_cluster_view async

get_galaxy_cluster_view(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], cluster_id: Annotated[int | UUID, Path(alias=galaxyClusterId)]) -> GalaxyClusterResponse

Deprecated Returns information from a galaxy cluster selected by its id.

args:

• the user’s authentification status
• the current database
• the galaxy id

returns:

• the information of the galaxy cluster

import_galaxy_cluster async

import_galaxy_cluster(auth: Annotated[Auth, Depends(authorize(HYBRID, [GALAXY_EDITOR]))], db: Annotated[Session, Depends(get_db)], body: list[ImportGalaxyBody], request: Request) -> DeleteForceUpdateImportGalaxyResponse

Add a new galaxy cluster to an existing galaxy.

args:

• the user’s authentification status

• the current database

• the request body

• the request

returns:

• the new galaxy cluster

restsearch async

restsearch(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], body: GalaxyClusterSearchBody) -> GalaxyClusterSearchResponse

Search for galaxy_clusters based on various filters.

Input:

• the user’s authentification status

• the current database

• the request body

Output:

• the galaxy_clusters found by search