:py:mod:`buildtest.scheduler.job`
=================================

.. py:module:: buildtest.scheduler.job


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   buildtest.scheduler.job.Job




.. py:class:: Job(jobID)


   This is a base class for holding job level data and common methods for used
   for batch job submission.

   .. py:method:: state()

      Return job state


   .. py:method:: get()

      Return Job ID as string type


   .. py:method:: is_pending()
      :abstractmethod:

      Check if job is in pending state


   .. py:method:: is_running()
      :abstractmethod:

      Check if job is in running state


   .. py:method:: is_suspended()
      :abstractmethod:

      Check if job is in suspended state


   .. py:method:: cancel()
      :abstractmethod:

      Cancel job


   .. py:method:: poll()
      :abstractmethod:

      Poll job and update job state.


   .. py:method:: get_output_and_error_files()
      :abstractmethod:

      Get output and error of job


   .. py:method:: output_file()

      Return output file of job


   .. py:method:: error_file()

      Return error file of job


   .. py:method:: exitcode()

      Return exit code of job


   .. py:method:: retrieve_jobdata()
      :abstractmethod:


   .. py:method:: jobdata()