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:
- id
str
,optional
Unique ID to access the resource, generated internally by the server on creation.
- modification_time
datetime
,optional
Last time in UTC (Coordinated Universal Time) that the object was modified.
- creation_time
datetime
,optional
Time in UTC when the object was created.
- name
str
Name of the template.
- version
str
,optional
Version of the template.
- description
str
,optional
Description of the template.
- software_requirements
list
[Software
],optional
List of required software.
- resource_requirements
TemplateResourceRequirements
,optional
Hardware requirements such as the number of cores, memory, and disk space.
- worker_context
WorkerContext
,optional
WorkerContext
object.- execution_context
dict
[str
,TemplateProperty
],optional
Dictionary of additional arguments to pass to the executing command.
- environment
dict
[str
,TemplateProperty
],optional
Dictionary of environment variables to set for the executed process.
- execution_command
str
,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_id
str
,optional
Storage ID of the script to execute (command or execution script is required).
- execution_script_storage_bucket
str
,optional
File storage bucket where the execution script is located.
- input_files
list
[TemplateInputFile
],optional
List of predefined input files.
- output_files
list
[TemplateOutputFile
],optional
List of predefined output files.
- id
Methods
Provides a helper function for retrieving fields to define as class members for an object.
TaskDefinitionTemplate.get
(key[, default])