TaskDefinitionTemplate

class ansys.hps.client.jms.TaskDefinitionTemplate(id=<marshmallow.missing>, modification_time=<marshmallow.missing>, creation_time=<marshmallow.missing>, name=<marshmallow.missing>, version=<marshmallow.missing>, description=<marshmallow.missing>, software_requirements=<marshmallow.missing>, resource_requirements=<marshmallow.missing>, worker_context=<marshmallow.missing>, execution_context=<marshmallow.missing>, environment=<marshmallow.missing>, execution_command=<marshmallow.missing>, use_execution_script=<marshmallow.missing>, execution_script_storage_id=<marshmallow.missing>, execution_script_storage_bucket=<marshmallow.missing>, input_files=<marshmallow.missing>, output_files=<marshmallow.missing>, **kwargs)

Provides the task definition template resource.

Parameters:

idstr, optional

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

modification_timedatetime, optional

Last time in UTC (Coordinated Universal Time) that the object was modified.

creation_timedatetime, optional

Time in UTC when the object was created.

namestr

Name of the template.

versionstr, optional

Version of the template.

descriptionstr, optional

Description of the template.

software_requirementslist[TemplateSoftware], optional

List of required software.

resource_requirementsTemplateResourceRequirements, optional

Hardware requirements such as the number of cores, memory, and disk space.

worker_contextWorkerContext, optional

WorkerContext object.

execution_contextdict[str, TemplateProperty], optional

Dictionary of additional arguments to pass to the executing command.

environmentdict[str, TemplateProperty], optional

Dictionary of environment variables to set for the executed process.

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_storage_idstr, optional

Storage ID of the script to execute (command or execution script is required).

execution_script_storage_bucketstr, optional

File storage bucket where the execution script is located.

input_fileslist[TemplateInputFile], optional

List of predefined input files.

output_fileslist[TemplateOutputFile], optional

List of predefined output files.

Initialize the object.

Methods

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