collections_archives_get_archive

Get the build state of a collection archive

Functions

async pydelfini.delfini_core.api.collections.collections_archives_get_archive.asyncio(collection_id, version_id, archive_id, *, client)[source]

Get the build state of a collection archive

Poll this while an archive is being built. numDone over numTotal gives progress. The archive can be downloaded once status is ready.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[CollectionArchive]

Return type:

CollectionArchive

async pydelfini.delfini_core.api.collections.collections_archives_get_archive.asyncio_detailed(collection_id, version_id, archive_id, *, client)[source]

Get the build state of a collection archive

Poll this while an archive is being built. numDone over numTotal gives progress. The archive can be downloaded once status is ready.

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[Union[CollectionArchive, ServerError]]

Return type:

Response[CollectionArchive | ServerError]

pydelfini.delfini_core.api.collections.collections_archives_get_archive.sync(collection_id, version_id, archive_id, *, client)[source]

Get the build state of a collection archive

Poll this while an archive is being built. numDone over numTotal gives progress. The archive can be downloaded once status is ready.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[CollectionArchive]

Return type:

CollectionArchive

pydelfini.delfini_core.api.collections.collections_archives_get_archive.sync_detailed(collection_id, version_id, archive_id, *, client)[source]

Get the build state of a collection archive

Poll this while an archive is being built. numDone over numTotal gives progress. The archive can be downloaded once status is ready.

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[Union[CollectionArchive, ServerError]]

Return type:

Response[CollectionArchive | ServerError]