Skip to content

flywheel.models.file_upsert_input

FileUpsertInput

Bases: object

classification property writable

Gets the classification of this FileUpsertInput.

Returns:

Type Description
dict(str, list[str])

The classification of this FileUpsertInput

client_hash property writable

Gets the client_hash of this FileUpsertInput.

Returns:

Type Description
str

The client_hash of this FileUpsertInput

info property writable

Gets the info of this FileUpsertInput.

Free-form information storage

Returns:

Type Description
dict(str, object)

The info of this FileUpsertInput

mimetype property writable

Gets the mimetype of this FileUpsertInput.

A MIME Content-Type of the file

Returns:

Type Description
str

The mimetype of this FileUpsertInput

modality property writable

Gets the modality of this FileUpsertInput.

The type of instrument that originated the file (e.g. MR, CT, ...)

Returns:

Type Description
str

The modality of this FileUpsertInput

name property writable

Gets the name of this FileUpsertInput.

The name of the file on disk

Returns:

Type Description
str

The name of this FileUpsertInput

origin property writable

Gets the origin of this FileUpsertInput.

Returns:

Type Description
Origin

The origin of this FileUpsertInput

parent_ref property writable

Gets the parent_ref of this FileUpsertInput.

Returns:

Type Description
ContainerReference

The parent_ref of this FileUpsertInput

path property writable

Gets the path of this FileUpsertInput.

Returns:

Type Description
str

The path of this FileUpsertInput

provider_id property writable

Gets the provider_id of this FileUpsertInput.

Unique database ID

Returns:

Type Description
str

The provider_id of this FileUpsertInput

reference property writable

Gets the reference of this FileUpsertInput.

Returns:

Type Description
bool

The reference of this FileUpsertInput

size property writable

Gets the size of this FileUpsertInput.

Returns:

Type Description
int

The size of this FileUpsertInput

source property writable

Gets the source of this FileUpsertInput.

Returns:

Type Description
CoreModelsCommonSource

The source of this FileUpsertInput

tags property writable

Gets the tags of this FileUpsertInput.

Returns:

Type Description
list[str]

The tags of this FileUpsertInput

type property writable

Gets the type of this FileUpsertInput.

A descriptive file type (e.g. dicom, image, document, ...)

Returns:

Type Description
str

The type of this FileUpsertInput

uuid property writable

Gets the uuid of this FileUpsertInput.

Hyphen-separated universally unique identifier

Returns:

Type Description
str

The uuid of this FileUpsertInput

zip_member_count property writable

Gets the zip_member_count of this FileUpsertInput.

Number of entries in the zip archive

Returns:

Type Description
int

The zip_member_count of this FileUpsertInput

__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__(provider_id=None, uuid=None, path=None, reference=None, client_hash=None, name=None, size=None, type=None, mimetype=None, modality=None, classification=None, info=None, zip_member_count=None, tags=None, parent_ref=None, origin=None, source=None)

FileUpsertInput - a model defined in Swagger

Parameters:

Name Type Description Default
provider_id (str, optional)

Unique database ID, defaults to None

None
uuid (str, optional)

Hyphen-separated universally unique identifier, defaults to None

None
path (str, optional)

, defaults to None

None
reference (bool, optional)

, defaults to None

None
client_hash (str, optional)

, defaults to None

None
name (str, optional)

The name of the file on disk, defaults to None

None
size (int, optional)

, 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
classification (dict(str, list[str]), optional)

, defaults to None

None
info (dict(str, object), optional)

Free-form information storage, defaults to None

None
zip_member_count (int, optional)

Number of entries in the zip archive, defaults to None

None
tags (list[str], optional)

, defaults to None

None
parent_ref (ContainerReference, optional)

, defaults to None

None
origin (Origin, optional)

, defaults to None

None
source (CoreModelsCommonSource, 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