jade.jobs.job_parameters_interface.JobParametersInterface

class jade.jobs.job_parameters_interface.JobParametersInterface

Bases: ABC

Job Parameters interface definition.

Methods

deserialize(data)	Deserialize parameters from a dictionary.
get_blocking_jobs()	Return the job names blocking this job.
is_spark_job()	Return True if the job is a Spark job.
remove_blocking_job(name)	Remove the name from the job's blocking list.
serialize()	Serialize data to a dictionary.
set_blocking_jobs(blocking_jobs)	Set the blocking jobs.

Attributes

DELIMITER
cancel_on_blocking_job_failure	Return False if the job should be canceled if any blocking job fails.
estimated_run_minutes	Return the estimated execution time or None if it isn't known.
extension	Return the extension name.
name	Return the job name.
submission_group	Return the submission group for the job.

abstract property estimated_run_minutes

Return the estimated execution time or None if it isn’t known.

Return type:

float | None

abstract property extension

Return the extension name.

Return type:

str

abstract property name

Return the job name. The job name must be unique in a configuration and must be usable as a directory or file name on any filesystem.

Return type:

str

abstract serialize()

Serialize data to a dictionary.

Return type:

dict

abstract classmethod deserialize(data)

Deserialize parameters from a dictionary.

Parameters:

data (dict)

Return type:

JobParametersInterface

abstract get_blocking_jobs()

Return the job names blocking this job.

Returns:

Empty set means that the job is not blocked.

Return type:

set

abstract remove_blocking_job(name)

Remove the name from the job’s blocking list.

Parameters:

name (str) – name of job that is now finished

abstract set_blocking_jobs(blocking_jobs)

Set the blocking jobs.

Parameters:

blocking_jobs (set)

abstract property cancel_on_blocking_job_failure

Return False if the job should be canceled if any blocking job fails.

Return type:

bool

abstract property submission_group

Return the submission group for the job.

is_spark_job()

Return True if the job is a Spark job.

Return type:

bool