JobConfig

JobConfig(backend, path, success_func=None, finished_func=None, post_func=None, max_retries=0, tags=None, parent_tags=None, job_type=<Type.BATCH: 0>, output=None, starttime=None)

Config class for the Job class. Stores all necessary information to load the Job at a later time. All properties are assigned with a custom getter function, which keeps track of updates to the respective property (tracked with the "update" variable).

  • backend Backend instance used for the job setup.
  • path Path of the job's snapshot file.
  • success_func Success function used for the job setup.
  • finished_func Finished function used for the job setup.
  • post_func Post execution function used for the job setup.
  • max_retries Maximum number of retries that are attempted when job is failing.
  • tags List of tags attached to the job.
  • parent_tags List of parent tags attached to the job.
  • job_type Define the type of the job.
  • output Output file of the job.
  • starttime Timestamp at which job is started by the JobHandler.

Member functions

add_tags

JobConfig.add_tags(self, tags, is_parent=False)

Add a list of tags to the tags associated to the job.

  • tags Tags to be added.
  • is_parent Tags are added as parent tags.