Skip to content

flywheel.models.file

File

Bases: FileMixin

classification property writable

Gets the classification of this File.

Returns:

Type Description
dict(str, list[str])

The classification of this File

client_hash property writable

Gets the client_hash of this File.

Returns:

Type Description
str

The client_hash of this File

copy_of property writable

Gets the copy_of of this File.

Returns:

Type Description
FileVersionCopyOf

The copy_of of this File

created property writable

Gets the created of this File.

Returns:

Type Description
datetime

The created of this File

cvat property writable

Gets the cvat of this File.

Returns:

Type Description
CVATInfo

The cvat of this File

deid_log_id property writable

Gets the deid_log_id of this File.

Returns:

Type Description
str

The deid_log_id of this File

deid_log_skip_reason property writable

Gets the deid_log_skip_reason of this File.

Returns:

Type Description
DeidLogSkipReason

The deid_log_skip_reason of this File

deleted property writable

Gets the deleted of this File.

Returns:

Type Description
datetime

The deleted of this File

file_group property writable

Gets the file_group of this File.

Returns:

Type Description
FileGroup

The file_group of this File

gear_info property writable

Gets the gear_info of this File.

Returns:

Type Description
FileGearInfo

The gear_info of this File

hash property writable

Gets the hash of this File.

Returns:

Type Description
str

The hash of this File

id property writable

Gets the id of this File.

Returns:

Type Description
FileVersion

The id of this File

info property writable

Gets the info of this File.

Returns:

Type Description
object

The info of this File

info_exists property writable

Gets the info_exists of this File.

Returns:

Type Description
bool

The info_exists of this File

mimetype property writable

Gets the mimetype of this File.

Returns:

Type Description
str

The mimetype of this File

modality property writable

Gets the modality of this File.

Returns:

Type Description
str

The modality of this File

modified property writable

Gets the modified of this File.

Returns:

Type Description
datetime

The modified of this File

name property writable

Gets the name of this File.

Returns:

Type Description
str

The name of this File

origin property writable

Gets the origin of this File.

Returns:

Type Description
Origin

The origin of this File

original_copy_of property writable

Gets the original_copy_of of this File.

Returns:

Type Description
FileVersion

The original_copy_of of this File

parent_ref property writable

Gets the parent_ref of this File.

Returns:

Type Description
ContainerReference

The parent_ref of this File

parents property writable

Gets the parents of this File.

Returns:

Type Description
FileParents

The parents of this File

path property writable

Gets the path of this File.

Returns:

Type Description
str

The path of this File

provider_id property writable

Gets the provider_id of this File.

Returns:

Type Description
str

The provider_id of this File

reference property writable

Gets the reference of this File.

Returns:

Type Description
bool

The reference of this File

replaced property writable

Gets the replaced of this File.

Returns:

Type Description
datetime

The replaced of this File

restored_by property writable

Gets the restored_by of this File.

Returns:

Type Description
Origin

The restored_by of this File

restored_from property writable

Gets the restored_from of this File.

Returns:

Type Description
int

The restored_from of this File

revision property writable

Gets the revision of this File.

Returns:

Type Description
int

The revision of this File

size property writable

Gets the size of this File.

Returns:

Type Description
int

The size of this File

source property writable

Gets the source of this File.

Returns:

Type Description
CoreModelsCommonSource

The source of this File

source_file_id property writable

Gets the source_file_id of this File.

Returns:

Type Description
FileVersion

The source_file_id of this File

tags property writable

Gets the tags of this File.

Returns:

Type Description
list[str]

The tags of this File

type property writable

Gets the type of this File.

Returns:

Type Description
str

The type of this File

uuid property writable

Gets the uuid of this File.

Returns:

Type Description
str

The uuid of this File

virus_scan property writable

Gets the virus_scan of this File.

Returns:

Type Description
VirusScan

The virus_scan of this File

zip_member_count property writable

Gets the zip_member_count of this File.

Returns:

Type Description
int

The zip_member_count of this File

__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, parent_ref=None, name=None, file_group=None, provider_id=None, uuid=None, path=None, reference=None, size=None, hash=None, client_hash=None, zip_member_count=None, virus_scan=None, source_file_id=None, restored_from=None, restored_by=None, parents=None, revision=None, origin=None, source=None, type=None, mimetype='application/octet-stream', modality=None, classification=None, tags=None, info=None, cvat=None, info_exists=False, deid_log_id=None, deid_log_skip_reason=None, gear_info=None, created=None, modified=None, replaced=None, deleted=None, copy_of=None, original_copy_of=None)

File - a model defined in Swagger

Parameters:

Name Type Description Default
id (FileVersion, optional)

, defaults to None

None
parent_ref (ContainerReference, optional)

, defaults to None

None
name (str, optional)

, defaults to None

None
file_group (FileGroup, optional)

, defaults to None

None
provider_id (str, optional)

, defaults to None

None
uuid (str, optional)

, defaults to None

None
path (str, optional)

, defaults to None

None
reference (bool, 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
zip_member_count (int, optional)

, defaults to None

None
virus_scan (VirusScan, optional)

, defaults to None

None
source_file_id (FileVersion, optional)

, defaults to None

None
restored_from (int, optional)

, defaults to None

None
restored_by (Origin, optional)

, defaults to None

None
parents (FileParents, optional)

, defaults to None

None
revision (int, optional)

, defaults to None

None
origin (Origin, optional)

, defaults to None

None
source (CoreModelsCommonSource, optional)

, defaults to None

None
type (str, optional)

, defaults to None

None
mimetype (str, optional)

, defaults to 'application/octet-stream'

'application/octet-stream'
modality (str, optional)

, defaults to None

None
classification (dict(str, list[str]), optional)

, defaults to None

None
tags (list[str], optional)

, defaults to None

None
info (object, optional)

, defaults to None

None
cvat (CVATInfo, optional)

, defaults to None

None
info_exists (bool, optional)

, defaults to False

False
deid_log_id (str, optional)

, defaults to None

None
deid_log_skip_reason (DeidLogSkipReason, optional)

, defaults to None

None
gear_info (FileGearInfo, 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
copy_of (FileVersionCopyOf, optional)

, defaults to None

None
original_copy_of (FileVersion, 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