l.r.t.t.IProductThingJob(IProductJob) : interface documentation

Part of lp.registry.tests.test_productjob View In Hierarchy

An interface for testing derived job classes.

Inherited from IProductJob:

Int id The tracking number of this job.
Object job Undocumented
Object product Undocumented
Attribute metadata A dict of data for the job

Inherited from IRunnableJob (via IProductJob):

Method notifyOops Notify interested parties that this job produced an OOPS.
Method getOopsVars Return a list of variables to appear in the OOPS.
Method getOperationDescription Describe the operation being performed, for use in oops emails.
Attribute user_error_types A tuple of exception classes which result from user error.
Attribute retry_error_types A tuple of exception classes which should cause a retry.
Attribute timeline_detail_filter An optional (category, detail) -> detail callable to filter timeline action details. This may be used when some details are expected to be very large.
Method notifyUserError Notify interested parties that this job encountered a user error.
Method run Run this job.
Method celeryRunOnCommit Request Celery to run this job on transaction commit.

Inherited from IJob (via IProductJob, IRunnableJob):

Int job_id Undocumented
Datetime scheduled_start Undocumented
Datetime date_created Undocumented
Datetime date_started Undocumented
Datetime date_finished Undocumented
Datetime lease_expires Undocumented
Text log Undocumented
Choice status The current state of the job.
Int attempt_count Undocumented
Int max_retries Undocumented
Bool is_pending Undocumented
Bool is_runnable Undocumented
Attribute base_json_data A dict of data about the job.
Choice base_job_type What type of job this is, only used for jobs that do not have their own tables.
Method acquireLease Acquire the lease for this Job, or raise LeaseHeld.
Method getTimeout Determine how long this job can run before timing out.
Method start Mark the job as started.
Method complete Mark the job as completed.
Method fail Indicate that the job has failed permanently.
Method queue Mark the job as queued for processing.
Method suspend Mark the job as suspended.
Method resume Mark the job as waiting.
API Documentation for Launchpad, generated by pydoctor at 2020-07-02 00:00:07.