job.configuration.results package¶

Subpackages¶

Defines exceptions that can occur when interacting with a job results

exception job.configuration.results.exceptions.InvalidResultsManifest(msg)¶

Error class indicating that a result manifest is invalid

exception job.configuration.results.exceptions.MissingRequiredOutput(output)¶

Error class indicating that a required output was not produced

exception job.configuration.results.exceptions.OutputCaptureError(msg)¶

Error class indicating that an error was encountered processing the output of Seed job

exception job.configuration.results.exceptions.UnexpectedMultipleOutputs(msg)¶

Error class indicating that an multiple output was found for an output value not marked as multiple

get_log_message()¶: See :meth: error.exceptions.ScaleError.get_log_message

Defines the results obtained after executing a job

class job.configuration.results.job_results.JobResults(results_dict=None)¶

Bases: object

Represents the results obtained after executing a job

add_file_list_parameter(name, file_ids)¶

Adds a list of files to the job results

Parameters:	name (string) – The output parameter name file_ids ([long]) – The file IDs

add_file_parameter(name, file_id)¶

Adds a file to the job results

Parameters:	name (string) – The output parameter name file_id (long) – The file ID

add_output_to_data(output_name, job_data, input_name)¶

Adds the given output from the results as a new input in the given job data

Parameters:	output_name (string) – The name of the results output to add to the data job_data (`job.configuration.data.job_data.JobData`) – The job data input_name (string) – The name of the data input

get_dict()¶

Returns the internal dictionary that represents these job results

Returns:	The dictionary representing the results
Return type:	dict