View Source Bildad.Job.Jobs (Bildad v0.1.5)

The Jobs module is responsible for managing job templates, job queue entries, and job runs.

Summary

Functions

Creates a new job template with the provided attributes.

Deletes the provided job template.

Lists all the active job templates without pagination.

Lists all the job runs with pagination.

Lists all the active job templates without pagination.

Lists all the jobs in the queue without pagination.

Lists all the jobs in the queue with pagination.

Lists all the jobs that were running, have not been killed and have expired without pagination.

Lists all the jobs that were running, have not been killed and have expired with pagination (with the default page size if nil provided as the page size).

Lists all the inactive job templates without pagination.

Lists all the jobs that have finished with the provided result without pagination.

Lists all the jobs that have finished with the provided result with pagination (with the default page size if nil provided as the page size).

Lists all the jobs that are running and have timed out without pagination.

Lists all the jobs that are running and have timed out with pagination (with the default page size if nil provided as the page size).

Lists all the active job templates without pagination.

Lists all the jobs for the given status in the queue without pagination.

Lists all the jobs for the given status in the queue with pagination (with the default page size if nil provided for the page size).

Lists all the jobs that are available to run in the queue without pagination.

Lists all the jobs that are available to run in the queue with pagination.

Lists all the jobs that are running in the queue without pagination.

Lists all the jobs that are running in the queue with pagination.

Updates the provided job template with the provided attributes.

Functions

Link to this function

create_job_template(job_config, attrs)

View Source

Creates a new job template with the provided attributes.

Note that the module_name should be a string version of the Elixir module name that will be used to run the job.

Note that the job_context_schema should be a map that represents the schema of the context that will be passed to the job module. It will be used to validate the context before running the job.

Link to this function

delete_job_template(job_config, job_template)

View Source

Deletes the provided job template.

Link to this function

list_active_job_templates(job_config)

View Source

Lists all the active job templates without pagination.

Link to this function

list_all_job_runs(job_config, page, page_size)

View Source

Lists all the job runs with pagination.

Link to this function

list_all_job_templates(job_config)

View Source

Lists all the active job templates without pagination.

Link to this function

list_all_jobs_in_the_queue(job_config)

View Source

Lists all the jobs in the queue without pagination.

Link to this function

list_all_jobs_in_the_queue(job_config, page, limit)

View Source

Lists all the jobs in the queue with pagination.

Link to this function

list_expired_jobs(job_config)

View Source

Lists all the jobs that were running, have not been killed and have expired without pagination.

Link to this function

list_expired_jobs(job_config, page, limit)

View Source

Lists all the jobs that were running, have not been killed and have expired with pagination (with the default page size if nil provided as the page size).

Link to this function

list_inactive_job_templates(job_config)

View Source

Lists all the inactive job templates without pagination.

Link to this function

list_job_runs_for_result(job_config, result)

View Source

Lists all the jobs that have finished with the provided result without pagination.

Link to this function

list_job_runs_for_result(job_config, result, page, limit)

View Source

Lists all the jobs that have finished with the provided result with pagination (with the default page size if nil provided as the page size).

Link to this function

list_job_runs_to_kill(job_config)

View Source

Lists all the jobs that are running and have timed out without pagination.

Link to this function

list_job_runs_to_kill(job_config, page, limit)

View Source

Lists all the jobs that are running and have timed out with pagination (with the default page size if nil provided as the page size).

Link to this function

list_job_templates(job_config)

View Source

Lists all the active job templates without pagination.

Link to this function

list_jobs_for_status_in_the_queue(job_config, status)

View Source

Lists all the jobs for the given status in the queue without pagination.

Link to this function

list_jobs_for_status_in_the_queue(job_config, status, page, limit)

View Source

Lists all the jobs for the given status in the queue with pagination (with the default page size if nil provided for the page size).

Link to this function

list_jobs_to_run_in_the_queue(job_config)

View Source

Lists all the jobs that are available to run in the queue without pagination.

Link to this function

list_jobs_to_run_in_the_queue(job_config, page, limit \\ nil)

View Source

Lists all the jobs that are available to run in the queue with pagination.

Link to this function

list_running_jobs_in_the_queue(job_config)

View Source

Lists all the jobs that are running in the queue without pagination.

Link to this function

list_running_jobs_in_the_queue(job_config, page, limit \\ nil)

View Source

Lists all the jobs that are running in the queue with pagination.

Link to this function

update_job_template(job_config, job_template, attrs)

View Source

Updates the provided job template with the provided attributes.