cads_api_client.Remote
======================

.. py:class:: cads_api_client.Remote

   A class to interact with a submitted job.


   .. py:method:: delete()

      Delete job.

      :returns: Content of the response.
      :rtype: :class:`dict[str,Any]`



   .. py:method:: download(target = None)

      Download the results.

      :param target: Target path. If None, download to the working directory.
      :type target: :class:`str` or :obj:`None`

      :returns: Path to the retrieved file.
      :rtype: :class:`str`



   .. py:property:: collection_id
      :type: str

      Collection ID.

      :rtype: :class:`str`


   .. py:property:: creation_datetime
      :type: datetime.datetime

      Creation datetime of the job.

      :rtype: :class:`datetime.datetime`


   .. py:property:: end_datetime
      :type: datetime.datetime | None

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

      :rtype: :class:`datetime.datetime` or :obj:`None`


   .. py:property:: json
      :type: dict[str, Any]

      Content of the response.

      :rtype: :class:`dict[str,Any]`


   .. py:property:: request
      :type: dict[str, Any]

      Request parameters.

      :rtype: :class:`dict[str,Any]`


   .. py:property:: request_uid
      :type: str

      Request UID.

      :rtype: :class:`str`


   .. py:property:: start_datetime
      :type: datetime.datetime | None

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

      :rtype: :class:`datetime.datetime` or :obj:`None`


   .. py:property:: status
      :type: str

      Request status.

      :rtype: :class:`str`