cads_api_client.Remote

class cads_api_client.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

property collection_id: str

Collection ID.

Return type:

str

property creation_datetime: datetime.datetime

Creation datetime of the job.

Return type:

datetime.datetime

property end_datetime: datetime.datetime | None

End datetime of the job. If None, job has not finished.

Return type:

datetime.datetime or None

property json: dict[str, Any]

Content of the response.

Return type:

dict[str,Any]

property request: dict[str, Any]

Request parameters.

Return type:

dict[str,Any]

property request_uid: str

Request UID.

Return type:

str

property start_datetime: datetime.datetime | None

Start datetime of the job. If None, job has not started.

Return type:

datetime.datetime or None

property status: str

Request status.

Return type:

str