jade.jobs.job_container_interface.JobContainerInterface

class jade.jobs.job_container_interface.JobContainerInterface[source]

Bases: ABC

Defines interface for job containers.

Methods

add_job(job)

Add a job to the configuration.

clear()

Clear all configured jobs.

get_job(name)

Return the job matching name.

get_jobs([sort])

Return all jobs.

list_jobs()

Return a list of all jobs.

remove_job(job)

Remove a job from the configuration.

shuffle()

Shuffle the order of the jobs.

abstract add_job(job)[source]

Add a job to the configuration.

Parameters:

job (JobParametersInterface)

abstract clear()[source]

Clear all configured jobs.

abstract get_job(name)[source]

Return the job matching name.

Return type:

namedtuple

abstract get_jobs(sort=False)[source]

Return all jobs.

Parameters:

sort (bool)

Return type:

list

list_jobs()[source]

Return a list of all jobs.

Returns:

list of JobParametersInterface

Return type:

list

abstract remove_job(job)[source]

Remove a job from the configuration.

Parameters:

job (JobParametersInterface)

abstract shuffle()[source]

Shuffle the order of the jobs.