datastores.Remote#

class datastores.Remote#

A class to interact with a submitted job.

delete()#

Delete job.

Returns:: Content of the response.
Return type:: dict[str,Any]

download(target=None)#

Download the results.

Parameters:: target (str or None) – Target path. If None, download to the working directory.
Returns:: Path to the retrieved file.
Return type:: str

get_results()#

Retrieve results.

Return type:: datastores.Results

property collection_id: str#: Collection ID.

property created_at: datetime.datetime#: When the job was created.

property finished_at: datetime.datetime | None#: When the job finished. If None, the job has not finished.

property json: dict[str, Any]#: Content of the response.

property request: dict[str, Any]#: Request parameters.

property request_id: str#: Request ID.

property results_ready: bool#: Check if results are ready.

property started_at: datetime.datetime | None#: When the job started. If None, the job has not started.

property status: str#: Request status.

property updated_at: datetime.datetime#: When the job was last updated.