mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue_genomes module#
- async mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue_genomes.asyncio(catalogue_id, *, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#
Get genomes within the genome catalogue
- Parameters:
catalogue_id (str )
order (GetGenomeCatalogueGenomesOrderType0 | None | Unset)
biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes
search (None | str | Unset) – Search with genome taxonomies and accessions
client (AuthenticatedClient | Client)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
NinjaPaginationResponseSchemaGenomeList
- Return type:
- async mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue_genomes.asyncio_detailed(catalogue_id, *, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#
Get genomes within the genome catalogue
- Parameters:
catalogue_id (str )
order (GetGenomeCatalogueGenomesOrderType0 | None | Unset)
biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes
search (None | str | Unset) – Search with genome taxonomies and accessions
client (AuthenticatedClient | Client)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Response[NinjaPaginationResponseSchemaGenomeList]
- Return type:
- mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue_genomes.sync(catalogue_id, *, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#
Get genomes within the genome catalogue
- Parameters:
catalogue_id (str )
order (GetGenomeCatalogueGenomesOrderType0 | None | Unset)
biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes
search (None | str | Unset) – Search with genome taxonomies and accessions
client (AuthenticatedClient | Client)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
NinjaPaginationResponseSchemaGenomeList
- Return type:
- mgnipy.emgapi_v2_client.api.genomes.get_genome_catalogue_genomes.sync_detailed(catalogue_id, *, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#
Get genomes within the genome catalogue
- Parameters:
catalogue_id (str )
order (GetGenomeCatalogueGenomesOrderType0 | None | Unset)
biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes
search (None | str | Unset) – Search with genome taxonomies and accessions
client (AuthenticatedClient | Client)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Response[NinjaPaginationResponseSchemaGenomeList]
- Return type: