collections_items_initiate_multipart_upload

Initiate a multipart item data upload sequence

Functions

async pydelfini.delfini_core.api.items.collections_items_initiate_multipart_upload.asyncio(collection_id, version_id, item_id, *, client, body)[source]

Initiate a multipart item data upload sequence

Starts the process of uploading an item’s data as a sequence of parts. This method will return a mapping of byte ranges to URLs; the client should break up the item data into segments and upload each segment to the respective URL. Uploads can be performed out-of-order and can be retried if an individual upload fails. Once all uploads are complete, the `complete_multipart_upload’ method should be requested.

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[MultipartUploadDetails]

Return type:

MultipartUploadDetails

async pydelfini.delfini_core.api.items.collections_items_initiate_multipart_upload.asyncio_detailed(collection_id, version_id, item_id, *, client, body)[source]

Initiate a multipart item data upload sequence

Starts the process of uploading an item’s data as a sequence of parts. This method will return a mapping of byte ranges to URLs; the client should break up the item data into segments and upload each segment to the respective URL. Uploads can be performed out-of-order and can be retried if an individual upload fails. Once all uploads are complete, the `complete_multipart_upload’ method should be requested.

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

Return type:

Response[MultipartUploadDetails | ServerError]

pydelfini.delfini_core.api.items.collections_items_initiate_multipart_upload.sync(collection_id, version_id, item_id, *, client, body)[source]

Initiate a multipart item data upload sequence

Starts the process of uploading an item’s data as a sequence of parts. This method will return a mapping of byte ranges to URLs; the client should break up the item data into segments and upload each segment to the respective URL. Uploads can be performed out-of-order and can be retried if an individual upload fails. Once all uploads are complete, the `complete_multipart_upload’ method should be requested.

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[MultipartUploadDetails]

Return type:

MultipartUploadDetails

pydelfini.delfini_core.api.items.collections_items_initiate_multipart_upload.sync_detailed(collection_id, version_id, item_id, *, client, body)[source]

Initiate a multipart item data upload sequence

Starts the process of uploading an item’s data as a sequence of parts. This method will return a mapping of byte ranges to URLs; the client should break up the item data into segments and upload each segment to the respective URL. Uploads can be performed out-of-order and can be retried if an individual upload fails. Once all uploads are complete, the `complete_multipart_upload’ method should be requested.

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

Return type:

Response[MultipartUploadDetails | ServerError]