File

class ansys.hps.client.jms.File(src=None, id=<marshmallow.missing>, creation_time=<marshmallow.missing>, modification_time=<marshmallow.missing>, created_by=<marshmallow.missing>, modified_by=<marshmallow.missing>, name=<marshmallow.missing>, type=<marshmallow.missing>, storage_id=<marshmallow.missing>, size=<marshmallow.missing>, hash=<marshmallow.missing>, expiry_time=<marshmallow.missing>, format=<marshmallow.missing>, evaluation_path=<marshmallow.missing>, monitor=<marshmallow.missing>, collect=<marshmallow.missing>, collect_interval=<marshmallow.missing>, reference_id=<marshmallow.missing>, **kwargs)

Provides the file resource.

Parameters:

srcUnion[str, io.IOBase], optional

Client-only field to specify either the path of an input file or a file-like object. In the latter case, requests recommends that you open files in binary mode.

idstr, optional

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

namestr

Name of the file resource.

typestr, optional

Type of the file. While you can use any string, you should use the correct media type for the given resource.

storage_idstr, optional

ID of the file in the (orthogonal) file storage system.

sizeint, optional

hashstr, optional

creation_timedatetime, optional

Date and time that the file resource was created.

modification_timedatetime, optional

Date and time that the file 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.

formatstr, optional

expiry_timedatetime, optional

File expiration time.

evaluation_pathstr, optional

Relative path for the file instance to store the job evaluation under.

monitorbool, optional

Whether to live monitor the file’s content.

collectbool, optional

Whether the file should be collected per job.

collect_intervalint, optional

Collection frequency for a file with collect=True. The minimum value is limited by the evaluator’s settings. A value of 0 or None indicates that the evaluator should decide. Another value indicates the interval in seconds.

reference_idstr, optional

ID of the reference file that this file was created from.

Methods

File.declared_fields()	Provides a helper function for retrieving fields to define as class members for an object.
File.get(key[, default])