Algorithm

class ansys.hps.client.jms.Algorithm(id=<marshmallow.missing>, creation_time=<marshmallow.missing>, modification_time=<marshmallow.missing>, created_by=<marshmallow.missing>, modified_by=<marshmallow.missing>, name=<marshmallow.missing>, description=<marshmallow.missing>, data=<marshmallow.missing>, jobs=<marshmallow.missing>, **kwargs)

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

descriptionstr, optional

Description of the algorithm.

datastr, optional

Generic string field to hold arbitrary algorithm configuration data. For example, as a JSON dictionary.

jobslist[str]

List of job IDs.

Initialize the object.

Methods

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