models.ExpiringDownload

class ExpiringDownload(json: Dict, **kwargs)

Expiring Download class.

Init function.

Parameters:

json (dict) – the json response to construct the ExpiringDownload from

save_as(target_dir: str | None = None) → None

Save the Expiring Download content.

Parameters:

target_dir (str) – the target directory where the file will be stored

delete() → None

Delete this expiring download.

Raises:

APIError – if delete was not successful.

edit(expires_at: ~datetime.datetime | None = <pykechain.utils.Empty object>, expires_in: int | None = <pykechain.utils.Empty object>, **kwargs) → None

Edit Expiring Download details.

Parameters:

• expires_at (datetime.datetime) – The moment at which the ExpiringDownload will expire

• expires_in (int) – The amount of time (in seconds) in which the ExpiringDownload will expire

upload(content_path)

Upload a file to the Expiring Download.

New in version 3.10.0.

Parameters:

content_path (basestring) – path to the file to upload.

Raises:

• APIError – if the file could not be uploaded.

• OSError – if the file could not be located on disk.