hiveWorkFileProperties-class: Class to contain WorkFile metadata

In agower/GeneHive: R interface to a GeneHive

Class to contain WorkFile metadata

Description

This class is the S4 representation of the WorkFileProperties record type. It is a container for metadata about a given WorkFile.

Slots

id

A hiveWorkFileID specifying the unique identifier of the WorkFile. Automatically populated when the file is uploaded.

hash

A character string specifying the MD5 checksum of the file. Automatically populated when the file is uploaded.

creator

A character string specifying the username of the User associated with the record. Automatically populated when the file is uploaded.

group

A character string specifying the name of the Group associated with the record. Automatically populated when the file is uploaded.

storage

A character string specifying the location in which the WorkFile is stored. This is supplied by the user when the file is uploaded.

creatorJobRun

A character string specifying the name of a JobRun associated with the WorkFile. (Not currently used.) Automatically populated when the file is uploaded.

originalName

A character string specifying the original name of the file. Automatically populated when the file is uploaded.

originalModifiedTime

A numeric value specifying the original timestamp of the file.

fileType

A character string specifying the type (e.g., extension) of the file. Created when the file is uploaded.

isTrashed

A logical value specifying whether the WorkFile is flagged to be trashed. Defaults to FALSE.

isTransient

A logical value specifying whether the WorkFile is flagged as temporary. Defaults to FALSE.

creationDatetime

A character string specifying the date and time that the record was created. Automatically populated when the file is uploaded.

length

A numeric value specifying the length of the file in bytes. Automatically populated when the file is uploaded.

token

A character string specifying a token that can be used for password-free authentication. Automatically populated when the file is uploaded.

permissions

A hivePermissions object specifying the permissions associated with the record. Defaults to read-only.

Author(s)

Adam C. Gower [e-mail]

See Also

Functions for working with WorkFileProperties records are described in WorkFileProperties.

agower/GeneHive documentation built on April 14, 2022, 5:08 a.m.