flywheel.models.file_output
FileOutput
Bases: FileMixin
classification property writable
Gets the classification of this FileOutput.
Returns:
| Type | Description |
|---|---|
dict(str, list[str]) | The classification of this FileOutput |
client_hash property writable
Gets the client_hash of this FileOutput.
Returns:
| Type | Description |
|---|---|
str | The client_hash of this FileOutput |
copy_of property writable
Gets the copy_of of this FileOutput.
Returns:
| Type | Description |
|---|---|
FileVersionCopyOf | The copy_of of this FileOutput |
created property writable
Gets the created of this FileOutput.
Returns:
| Type | Description |
|---|---|
datetime | The created of this FileOutput |
cvat property writable
Gets the cvat of this FileOutput.
Returns:
| Type | Description |
|---|---|
CVATInfo | The cvat of this FileOutput |
deid_log_id property writable
Gets the deid_log_id of this FileOutput.
The UUID of the de-id log
Returns:
| Type | Description |
|---|---|
str | The deid_log_id of this FileOutput |
deid_log_skip_reason property writable
Gets the deid_log_skip_reason of this FileOutput.
Returns:
| Type | Description |
|---|---|
DeidLogSkipReason | The deid_log_skip_reason of this FileOutput |
deleted property writable
Gets the deleted of this FileOutput.
Returns:
| Type | Description |
|---|---|
datetime | The deleted of this FileOutput |
file_group property writable
Gets the file_group of this FileOutput.
Returns:
| Type | Description |
|---|---|
FileGroup | The file_group of this FileOutput |
file_id property writable
Gets the file_id of this FileOutput.
Returns:
| Type | Description |
|---|---|
str | The file_id of this FileOutput |
gear_info property writable
Gets the gear_info of this FileOutput.
Returns:
| Type | Description |
|---|---|
FileGearInfo | The gear_info of this FileOutput |
hash property writable
Gets the hash of this FileOutput.
Returns:
| Type | Description |
|---|---|
str | The hash of this FileOutput |
id property writable
Gets the id of this FileOutput.
Hyphen-separated universally unique identifier
Returns:
| Type | Description |
|---|---|
str | The id of this FileOutput |
info property writable
Gets the info of this FileOutput.
Free-form information storage
Returns:
| Type | Description |
|---|---|
object | The info of this FileOutput |
info_exists property writable
Gets the info_exists of this FileOutput.
Returns:
| Type | Description |
|---|---|
bool | The info_exists of this FileOutput |
mimetype property writable
Gets the mimetype of this FileOutput.
A MIME Content-Type of the file
Returns:
| Type | Description |
|---|---|
str | The mimetype of this FileOutput |
modality property writable
Gets the modality of this FileOutput.
The type of instrument that originated the file (e.g. MR, CT, ...)
Returns:
| Type | Description |
|---|---|
str | The modality of this FileOutput |
modified property writable
Gets the modified of this FileOutput.
Returns:
| Type | Description |
|---|---|
datetime | The modified of this FileOutput |
name property writable
Gets the name of this FileOutput.
The name of the file on disk
Returns:
| Type | Description |
|---|---|
str | The name of this FileOutput |
origin property writable
Gets the origin of this FileOutput.
Returns:
| Type | Description |
|---|---|
Origin | The origin of this FileOutput |
original_copy_of property writable
Gets the original_copy_of of this FileOutput.
Returns:
| Type | Description |
|---|---|
FileVersion | The original_copy_of of this FileOutput |
parent_ref property writable
Gets the parent_ref of this FileOutput.
Returns:
| Type | Description |
|---|---|
ContainerReference | The parent_ref of this FileOutput |
parents property writable
Gets the parents of this FileOutput.
Returns:
| Type | Description |
|---|---|
FileParents | The parents of this FileOutput |
path property writable
Gets the path of this FileOutput.
Returns:
| Type | Description |
|---|---|
str | The path of this FileOutput |
provider_id property writable
Gets the provider_id of this FileOutput.
Unique database ID
Returns:
| Type | Description |
|---|---|
str | The provider_id of this FileOutput |
reference property writable
Gets the reference of this FileOutput.
Returns:
| Type | Description |
|---|---|
bool | The reference of this FileOutput |
replaced property writable
Gets the replaced of this FileOutput.
Returns:
| Type | Description |
|---|---|
datetime | The replaced of this FileOutput |
restored_by property writable
Gets the restored_by of this FileOutput.
Returns:
| Type | Description |
|---|---|
Origin | The restored_by of this FileOutput |
restored_from property writable
Gets the restored_from of this FileOutput.
Returns:
| Type | Description |
|---|---|
int | The restored_from of this FileOutput |
revision property writable
Gets the revision of this FileOutput.
Returns:
| Type | Description |
|---|---|
int | The revision of this FileOutput |
size property writable
Gets the size of this FileOutput.
Returns:
| Type | Description |
|---|---|
int | The size of this FileOutput |
tags property writable
Gets the tags of this FileOutput.
Returns:
| Type | Description |
|---|---|
list[str] | The tags of this FileOutput |
type property writable
Gets the type of this FileOutput.
A descriptive file type (e.g. dicom, image, document, ...)
Returns:
| Type | Description |
|---|---|
str | The type of this FileOutput |
version property writable
Gets the version of this FileOutput.
Returns:
| Type | Description |
|---|---|
int | The version of this FileOutput |
virus_scan property writable
Gets the virus_scan of this FileOutput.
Returns:
| Type | Description |
|---|---|
VirusScan | The virus_scan of this FileOutput |
zip_member_count property writable
Gets the zip_member_count of this FileOutput.
Number of entries in the zip archive
Returns:
| Type | Description |
|---|---|
int | The zip_member_count of this FileOutput |
__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, name=None, type=None, file_id=None, version=None, mimetype=None, modality=None, deid_log_id=None, deid_log_skip_reason=None, classification=None, tags=None, provider_id=None, parent_ref=None, parents=None, restored_from=None, restored_by=None, path=None, reference=None, origin=None, virus_scan=None, created=None, modified=None, replaced=None, deleted=None, size=None, hash=None, client_hash=None, info=None, info_exists=False, cvat=None, zip_member_count=None, gear_info=None, copy_of=None, original_copy_of=None, revision=None, file_group=None)
FileOutput - a model defined in Swagger
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id | (str, optional) | Hyphen-separated universally unique identifier, 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 |
file_id | (str, optional) | , defaults to None | None |
version | (int, optional) | , 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 |
deid_log_skip_reason | (DeidLogSkipReason, optional) | , defaults to None | None |
classification | (dict(str, list[str]), optional) | , defaults to None | None |
tags | (list[str], optional) | , defaults to None | None |
provider_id | (str, optional) | Unique database ID, defaults to None | None |
parent_ref | (ContainerReference, optional) | , defaults to None | None |
parents | (FileParents, optional) | , defaults to None | None |
restored_from | (int, optional) | , defaults to None | None |
restored_by | (Origin, optional) | , defaults to None | None |
path | (str, optional) | , defaults to None | None |
reference | (bool, optional) | , defaults to None | None |
origin | (Origin, optional) | , defaults to None | None |
virus_scan | (VirusScan, optional) | , defaults to None | None |
created | (datetime, optional) | , defaults to None | None |
modified | (datetime, optional) | , defaults to None | None |
replaced | (datetime, optional) | , defaults to None | None |
deleted | (datetime, optional) | , defaults to None | None |
size | (int, optional) | , defaults to None | None |
hash | (str, optional) | , defaults to None | None |
client_hash | (str, optional) | , defaults to None | None |
info | (object, optional) | Free-form information storage, defaults to None | None |
info_exists | (bool, optional) | , defaults to False | False |
cvat | (CVATInfo, optional) | , defaults to None | None |
zip_member_count | (int, optional) | Number of entries in the zip archive, defaults to None | None |
gear_info | (FileGearInfo, optional) | , defaults to None | None |
copy_of | (FileVersionCopyOf, optional) | , defaults to None | None |
original_copy_of | (FileVersion, optional) | , defaults to None | None |
revision | (int, optional) | , defaults to None | None |
file_group | (FileGroup, optional) | , 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