:tocdepth: 3

:py:mod:`gws.lib.job`
=====================

.. py:module:: gws.lib.job


**Source code:** :source:`gws.lib.job<gws/lib/job/__init__.py>`



Package Contents
----------------



.. py:function:: create(root: gws.Root, user: gws.User, worker: str, payload: dict = None) -> Object

.. py:exception:: Error


   Bases: :py:obj:`gws.Error`

   GWS error.


.. py:function:: get(root: gws.Root, uid) -> Optional[Object]

.. py:class:: Object(root: gws.Root, rec)


   Bases: :py:obj:`gws.Job`

   Background Job object.

   .. py:attribute:: error

   .. py:attribute:: payload

   .. py:attribute:: root

   .. py:attribute:: state

   .. py:attribute:: uid

   .. py:attribute:: user

   .. py:attribute:: worker
      :type:  str

   .. py:method:: cancel()

   .. py:method:: remove()

   .. py:method:: run()

   .. py:method:: update(payload=None, state=None, error=None)


.. py:exception:: PrematureTermination


   Bases: :py:obj:`Exception`

   Common base class for all non-exit exceptions.


.. py:function:: remove(uid)

.. py:function:: run(root: gws.Root, uid)