mgnipy.emgapi_v2_client.api.genomes.list_genome_catalogues module

mgnipy.emgapi_v2_client.api.genomes.list_genome_catalogues module#

async asyncio(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List all genome catalogues

MGnify Genomes Catalogues are biome-specific collections of isolate and MAG genomes.

Parameters:
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:

NinjaPaginationResponseSchemaGenomeCatalogueList

Return type:

NinjaPaginationResponseSchemaGenomeCatalogueList | None

async asyncio_detailed(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List all genome catalogues

MGnify Genomes Catalogues are biome-specific collections of isolate and MAG genomes.

Parameters:
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[NinjaPaginationResponseSchemaGenomeCatalogueList]

Return type:

Response[NinjaPaginationResponseSchemaGenomeCatalogueList]

sync(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List all genome catalogues

MGnify Genomes Catalogues are biome-specific collections of isolate and MAG genomes.

Parameters:
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:

NinjaPaginationResponseSchemaGenomeCatalogueList

Return type:

NinjaPaginationResponseSchemaGenomeCatalogueList | None

sync_detailed(*, client, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

List all genome catalogues

MGnify Genomes Catalogues are biome-specific collections of isolate and MAG genomes.

Parameters:
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[NinjaPaginationResponseSchemaGenomeCatalogueList]

Return type:

Response[NinjaPaginationResponseSchemaGenomeCatalogueList]

Contents