Task

class ansys.hps.client.jms.Task(id=<marshmallow.missing>, creation_time=<marshmallow.missing>, modification_time=<marshmallow.missing>, created_by=<marshmallow.missing>, modified_by=<marshmallow.missing>, pending_time=<marshmallow.missing>, prolog_time=<marshmallow.missing>, running_time=<marshmallow.missing>, finished_time=<marshmallow.missing>, eval_status=<marshmallow.missing>, trial_number=<marshmallow.missing>, elapsed_time=<marshmallow.missing>, task_definition_id=<marshmallow.missing>, task_definition_snapshot=<marshmallow.missing>, executed_command=<marshmallow.missing>, job_id=<marshmallow.missing>, host_id=<marshmallow.missing>, input_file_ids=<marshmallow.missing>, output_file_ids=<marshmallow.missing>, monitored_file_ids=<marshmallow.missing>, inherited_file_ids=<marshmallow.missing>, owned_file_ids=<marshmallow.missing>, license_context_id=<marshmallow.missing>, custom_data=<marshmallow.missing>, working_directory=<marshmallow.missing>, **kwargs)

Provides the task 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.

pending_timedatetime, optional

Date and time that the task was set to pending.

prolog_timedatetime, optional

Date and time that the task was set to prolog.

running_timedatetime, optional

Date and time that the task was set to running.

finished_timedatetime, optional

Date and time that the task was completed.

eval_statusstr, optional

Evaluation status.

trial_numberint, optional

Which attempt to execute the process step this task represents.

elapsed_timefloat, optional

Number of seconds it took the evaluator to execute the task.

task_definition_idstr

ID of the TaskDefinition instance that the task is linked to.

task_definition_snapshotTaskDefinition, optional

Snapshot of the TaskDefinition instance that was created when the task status changed to prolog, before evaluation.

executed_commandstr, optional

job_idstr

ID of the Job instance that the task is linked to.

host_idstr, optional

UUID of the Evaluator instance that updated the task.

input_file_idslist[str]

List of IDs of input files of the task.

output_file_idslist[str]

List of IDs of output files of the task.

monitored_file_idslist[str]

List of IDs of monitored files of the task.

inherited_file_idslist[str]

List of IDs of inherited files of the task.

owned_file_idslist[str]

List of IDs of owned files of the task.

license_context_idstr, optional

ID of the license context in use.

custom_datadict, optional

Dictionary type field for storing custom data.

working_directorystr, optional

Working directory of the task.

Initialize the object.

Methods

Task.declared_fields()	Provide a helper function for retrieving fields.
Task.get(key[, default])	Get an item from the object, returning a default value if the key is not found.