flywheel.models.file_entry
FileEntry
Bases: FileMixin
classification property writable
Gets the classification of this FileEntry.
Returns:
| Type | Description |
|---|---|
CommonClassification | The classification of this FileEntry |
created property writable
Gets the created of this FileEntry.
Creation time (automatically set)
Returns:
| Type | Description |
|---|---|
datetime | The created of this FileEntry |
deid_log_id property writable
Gets the deid_log_id of this FileEntry.
The UUID of the de-id log
Returns:
| Type | Description |
|---|---|
str | The deid_log_id of this FileEntry |
file_id property writable
Gets the file_id of this FileEntry.
Unique database ID
Returns:
| Type | Description |
|---|---|
str | The file_id of this FileEntry |
hash property writable
Gets the hash of this FileEntry.
Cryptographic hash of the file
Returns:
| Type | Description |
|---|---|
str | The hash of this FileEntry |
id property writable
Gets the id of this FileEntry.
Returns:
| Type | Description |
|---|---|
str | The id of this FileEntry |
info property writable
Gets the info of this FileEntry.
Returns:
| Type | Description |
|---|---|
CommonInfo | The info of this FileEntry |
info_exists property writable
Gets the info_exists of this FileEntry.
Returns:
| Type | Description |
|---|---|
bool | The info_exists of this FileEntry |
mimetype property writable
Gets the mimetype of this FileEntry.
A MIME Content-Type of the file
Returns:
| Type | Description |
|---|---|
str | The mimetype of this FileEntry |
modality property writable
Gets the modality of this FileEntry.
The type of instrument that originated the file (e.g. MR, CT, ...)
Returns:
| Type | Description |
|---|---|
str | The modality of this FileEntry |
modified property writable
Gets the modified of this FileEntry.
Last modification time (automatically updated)
Returns:
| Type | Description |
|---|---|
datetime | The modified of this FileEntry |
name property writable
Gets the name of this FileEntry.
The name of the file on disk
Returns:
| Type | Description |
|---|---|
str | The name of this FileEntry |
origin property writable
Gets the origin of this FileEntry.
Returns:
| Type | Description |
|---|---|
FileOrigin | The origin of this FileEntry |
parent_ref property writable
Gets the parent_ref of this FileEntry.
Returns:
| Type | Description |
|---|---|
ContainerReference | The parent_ref of this FileEntry |
parents property writable
Gets the parents of this FileEntry.
Returns:
| Type | Description |
|---|---|
ContainerParents | The parents of this FileEntry |
replaced property writable
Gets the replaced of this FileEntry.
Last replaced time (automatically updated)
Returns:
| Type | Description |
|---|---|
datetime | The replaced of this FileEntry |
size property writable
Gets the size of this FileEntry.
Size of the file, in bytes
Returns:
| Type | Description |
|---|---|
int | The size of this FileEntry |
tags property writable
Gets the tags of this FileEntry.
Array of application-specific tags
Returns:
| Type | Description |
|---|---|
list[str] | The tags of this FileEntry |
type property writable
Gets the type of this FileEntry.
A descriptive file type (e.g. dicom, image, document, ...)
Returns:
| Type | Description |
|---|---|
str | The type of this FileEntry |
version property writable
Gets the version of this FileEntry.
Version of the file
Returns:
| Type | Description |
|---|---|
int | The version of this FileEntry |
zip_member_count property writable
Gets the zip_member_count of this FileEntry.
Number of entries in the zip archive
Returns:
| Type | Description |
|---|---|
int | The zip_member_count of this FileEntry |
__contains__(key)
Checks if the given value is a key in this object
__eq__(other)
Returns true if both objects are equal
__getitem__(key)
Returns the value of key
__init__(id=None, file_id=None, version=None, name=None, type=None, mimetype=None, modality=None, deid_log_id=None, classification=None, tags=None, info=None, origin=None, hash=None, parents=None, parent_ref=None, created=None, modified=None, replaced=None, size=None, info_exists=None, zip_member_count=None)
FileEntry - a model defined in Swagger
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id | (str, optional) | , defaults to None | None |
file_id | (str, optional) | Unique database ID, defaults to None | None |
version | (int, optional) | Version of the file, defaults to None | None |
name | (str, optional) | The name of the file on disk, defaults to None | None |
type | (str, optional) | A descriptive file type (e.g. dicom, image, document, ...), defaults to None | None |
mimetype | (str, optional) | A MIME Content-Type of the file, defaults to None | None |
modality | (str, optional) | The type of instrument that originated the file (e.g. MR, CT, ...), defaults to None | None |
deid_log_id | (str, optional) | The UUID of the de-id log, defaults to None | None |
classification | (CommonClassification, optional) | , defaults to None | None |
tags | (list[str], optional) | Array of application-specific tags, defaults to None | None |
info | (CommonInfo, optional) | , defaults to None | None |
origin | (FileOrigin, optional) | , defaults to None | None |
hash | (str, optional) | Cryptographic hash of the file, defaults to None | None |
parents | (ContainerParents, optional) | , defaults to None | None |
parent_ref | (ContainerReference, optional) | , defaults to None | None |
created | (datetime, optional) | Creation time (automatically set), defaults to None | None |
modified | (datetime, optional) | Last modification time (automatically updated), defaults to None | None |
replaced | (datetime, optional) | Last replaced time (automatically updated), defaults to None | None |
size | (int, optional) | Size of the file, in bytes, defaults to None | None |
info_exists | (bool, optional) | , defaults to None | None |
zip_member_count | (int, optional) | Number of entries in the zip archive, defaults to None | None |
__ne__(other)
Returns true if both objects are not equal
__repr__()
For print and pprint
__setitem__(key, value)
Sets the value of key
get(key, default=None)
Get the value of the provided json property, or default
items()
Returns the list of json property to value mapping
keys()
Returns the list of json properties in the object
positional_to_model(value) staticmethod
Converts a positional argument to a model value
return_value()
Unwraps return value from model
to_dict()
Returns the model properties as a dict
to_str()
Returns the string representation of the model
values()
Returns the list of values in the object