Job Manager Subsystem for Python

Subsystem Methods

Name	Description
get_num_jobs	Get the total number of jobs in the queue.
cancel_job	Cancels the job with the given ID. If the job has already started it may or may not listen to the request.
cancel_all_jobs	Cancels all the jobs in the queue. If any job has already started it may or may not listen to the request.
is_pending_jobs_paused	Checks if the job manager has been asked to pause.
pause_pending_jobs	Pause pending jobs. No new jobs will be started, but those already running will continue on. Call ResumePendingJobs() to be able to run the jobs again.
resume_pending_jobs	Resume running pending jobs. Called after PausePendingJobs() have been called and when the jobs can be started again.
wait_for_job_to_complete	Waits for the job with the given ID to complete.
wait_for_all_jobs_to_complete	Waits for all the jobs in the job queue to complete.

Subsystem Properties

Name	Description
on_job_added	Called when a new job has been added.
on_job_completed	Called when a job has completed.
on_job_progress_updated	Called when a job's progress is updated.
on_job_state_changed	Called when a job's state changes.

Data structs

Name	Description
JobInfo	Represents a snapshot of a job's state and related information.

Enums

Name	Description
JobState	This enum specifies what state the job has.

Functions details

get_num_jobs

Get the total number of jobs in the queue.

Signature

def get_num_jobs() -> int

Parameters

Function has no parameters

Return value

Type: int The total number of jobs in the queue.

cancel_job

Cancels the job with the given ID. If the job has already started it may or may not listen to the request.

Signature

def cancel_job(
		job_id: Guid
	) -> None

Parameters

Name	Type	Description
job_id	Guid	The id of the job to cancel.

Return value

Type: None

cancel_all_jobs

Cancels all the jobs in the queue. If any job has already started it may or may not listen to the request.

Signature

def cancel_all_jobs() -> None

Parameters

Function has no parameters

Return value

Type: None

is_pending_jobs_paused

Checks if the job manager has been asked to pause.

Signature

def is_pending_jobs_paused() -> bool

Parameters

Function has no parameters

Return value

Type: bool Whether the pending jobs have been paused.

pause_pending_jobs

Pause pending jobs. No new jobs will be started, but those already running will continue on. Call ResumePendingJobs() to be able to run the jobs again.

Signature

def pause_pending_jobs() -> None

Parameters

Function has no parameters

Return value

Type: None

resume_pending_jobs

Resume running pending jobs. Called after PausePendingJobs() have been called and when the jobs can be started again.

Signature

def resume_pending_jobs() -> None

Parameters

Function has no parameters

Return value

Type: None

wait_for_job_to_complete

Waits for the job with the given ID to complete.

Signature

def wait_for_job_to_complete(
		job_id: Guid
	) -> None

Parameters

Name	Type	Description
job_id	Guid	The id of the job to wait for.

Return value

Type: None

wait_for_all_jobs_to_complete

Waits for all the jobs in the job queue to complete.

Signature

def wait_for_all_jobs_to_complete() -> None

Parameters

Function has no parameters

Return value

Type: None

Properties details

on_job_added

Called when a new job has been added.

Type

SgDynamicOnJobAdded

on_job_completed

Called when a job has completed.

Type

SgDynamicOnJobCompleted

on_job_progress_updated

Called when a job's progress is updated.

Type

SgDynamicOnJobProgress

on_job_state_changed

Called when a job's state changes.

Type

SgDynamicOnJobStateChanged

Data structs details

JobInfo

Represents a snapshot of a job's state and related information.

Signature

class JobInfo

Properties

Name	Type	Description
id	Guid	Job Id
name	String	Job name
progress	float	Current job progress
state	JobState	Current job state
tags	Map	Tags associated with the current job

Enums details

JobState

This enum specifies what state the job has.

Values

Name	Description
UNKNOWN	Unknown job state. Used for default construction.
CREATED	Job has been constructed, but it has not yet been added to the job manager for processing.
PENDING	Job has been added to the job manager queue.
RUNNING	Job is currently being processed.
CANCEL_REQUESTED	Intermediate state when a job has been requested to be canceled but not reacted to it yet.
CANCELED	Job has been canceled.
FAILED	Job has failed during processing.
COMPLETED	Job has processed successfully.