TaskDefinition

class ansys.hps.client.jms.TaskDefinition(id=<marshmallow.missing>, creation_time=<marshmallow.missing>, modification_time=<marshmallow.missing>, created_by=<marshmallow.missing>, modified_by=<marshmallow.missing>, name=<marshmallow.missing>, execution_command=<marshmallow.missing>, use_execution_script=<marshmallow.missing>, execution_script_id=<marshmallow.missing>, execution_level=<marshmallow.missing>, execution_context=<marshmallow.missing>, environment=<marshmallow.missing>, max_execution_time=<marshmallow.missing>, num_trials=<marshmallow.missing>, store_output=<marshmallow.missing>, input_file_ids=<marshmallow.missing>, output_file_ids=<marshmallow.missing>, success_criteria=<marshmallow.missing>, licensing=<marshmallow.missing>, software_requirements=<marshmallow.missing>, resource_requirements=<marshmallow.missing>, worker_context=<marshmallow.missing>, debug=<marshmallow.missing>, **kwargs)

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

execution_commandstr, optional

Command to execute. A command or execution script is required.

use_execution_scriptbool, optional

Whether to run the task with the execution script or the execution command.

execution_script_idstr, optional

Script to execute. A command or execution script is required.

execution_levelint

Execution level for the task.

execution_contextdict[str, Union[int, float, str, bool]], optional

Additional arguments to pass to the executing command.

environmentdict[str, str], optional

Environment variables to set for the executed process.

max_execution_timefloat, optional

Maximum time in seconds for executing the task.

num_trialsint, optional

Maximum number of attempts for executing the task.

store_outputbool, optional

Whether to store the standard output of the task.

input_file_idslist[str]

List of IDs of input files.

output_file_idslist[str]

List of IDs of output files.

success_criteriaSuccessCriteria, optional

licensingLicensing, optional

Licensing object.

software_requirementslist[Software], optional

List of Software objects.

resource_requirementsResourceRequirements, optional

ResourceRequirements object.

worker_contextWorkerContext, optional

WorkerContext object.

debugbool, optional

Enable debug logging and retain Task working directory.

Initialize the object.

Methods

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