Job

class ansys.hps.client.jms.Job(id=<marshmallow.missing>, creation_time=<marshmallow.missing>, modification_time=<marshmallow.missing>, created_by=<marshmallow.missing>, modified_by=<marshmallow.missing>, name=<marshmallow.missing>, eval_status=<marshmallow.missing>, job_definition_id=<marshmallow.missing>, priority=<marshmallow.missing>, values=<marshmallow.missing>, fitness=<marshmallow.missing>, fitness_term_values=<marshmallow.missing>, note=<marshmallow.missing>, creator=<marshmallow.missing>, executed_level=<marshmallow.missing>, elapsed_time=<marshmallow.missing>, host_ids=<marshmallow.missing>, file_ids=<marshmallow.missing>, **kwargs)

Provides the job resource.

Parameters:

idstr, optional

Unique ID to access the resource, generated internally by the server on creation.

creation_timedatetime, optional

Date and time that the resource was created.

modification_timedatetime, optional

Date and time that the resource was last modified.

created_bystr, optional

ID of the user who created the object.

modified_bystr, optional

ID of the user who last modified the object.

namestr, optional

Name of the job.

eval_statusstr

Evaluation status.

job_definition_idstr

ID of the linked job definition. For more information, see the JobDefinition class.

priorityint, optional

Priority for evaluating the job. The default is 0, which is the highest priority. Assigning a higher value to a job makes it a lower priority.

valuesdict[str, any], optional

Dictionary with (name,value) pairs for all parameters defined in the linked job definition.

fitnessfloat, optional

Fitness value computed.

fitness_term_valuesdict[str, float], optional

Dictionary with (name,value) pairs for all fitness terms computed.

notestr, optional

Note for the job.

creatorstr, optional

Additional information about the creator of the job.

executed_levelint, optional

Execution level of the last executed task. A value of -1 indicates that no task has been executed yet.

elapsed_timefloat

Number of seconds it took the evaluators to update the job.

host_idslist, optional

List of host IDs of the evaluators that updated the job.

file_idslist[str]

List of IDs of all files of the job.

Methods

Job.declared_fields()	Provides a helper function for retrieving fields to define as class members for an object.
Job.get(key[, default])