Skip to content

flywheel.models.collection_with_stats

CollectionWithStats

Bases: CollectionMixin

analyses property writable

Gets the analyses of this CollectionWithStats.

Returns:

Type Description
list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]

The analyses of this CollectionWithStats

attachment_count property writable

Gets the attachment_count of this CollectionWithStats.

Returns:

Type Description
int

The attachment_count of this CollectionWithStats

created property writable

Gets the created of this CollectionWithStats.

Returns:

Type Description
datetime

The created of this CollectionWithStats

curator property writable

Gets the curator of this CollectionWithStats.

Returns:

Type Description
str

The curator of this CollectionWithStats

description property writable

Gets the description of this CollectionWithStats.

Returns:

Type Description
str

The description of this CollectionWithStats

files property writable

Gets the files of this CollectionWithStats.

Returns:

Type Description
list[FileListOutput]

The files of this CollectionWithStats

id property writable

Gets the id of this CollectionWithStats.

Returns:

Type Description
str

The id of this CollectionWithStats

info property writable

Gets the info of this CollectionWithStats.

Returns:

Type Description
object

The info of this CollectionWithStats

join_origin property writable

Gets the join_origin of this CollectionWithStats.

Returns:

Type Description
JoinOrigins

The join_origin of this CollectionWithStats

label property writable

Gets the label of this CollectionWithStats.

Returns:

Type Description
str

The label of this CollectionWithStats

modified property writable

Gets the modified of this CollectionWithStats.

Returns:

Type Description
datetime

The modified of this CollectionWithStats

noncompliant_session_count property writable

Gets the noncompliant_session_count of this CollectionWithStats.

Returns:

Type Description
int

The noncompliant_session_count of this CollectionWithStats

notes property writable

Gets the notes of this CollectionWithStats.

Returns:

Type Description
list[Note]

The notes of this CollectionWithStats

permissions property writable

Gets the permissions of this CollectionWithStats.

Returns:

Type Description
list[AccessPermission]

The permissions of this CollectionWithStats

revision property writable

Gets the revision of this CollectionWithStats.

Returns:

Type Description
int

The revision of this CollectionWithStats

session_count property writable

Gets the session_count of this CollectionWithStats.

Returns:

Type Description
int

The session_count of this CollectionWithStats

subject_count property writable

Gets the subject_count of this CollectionWithStats.

Returns:

Type Description
int

The subject_count of this CollectionWithStats

tags property writable

Gets the tags of this CollectionWithStats.

Returns:

Type Description
list[str]

The tags of this CollectionWithStats

__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, created=None, modified=None, label=None, description=None, info=None, curator=None, revision=1, notes=None, tags=None, analyses=None, permissions=None, join_origin=None, files=None, attachment_count=0, session_count=0, noncompliant_session_count=0, subject_count=0)

CollectionWithStats - a model defined in Swagger

Parameters:

Name Type Description Default
id (str, optional)

, defaults to None

None
created (datetime, optional)

, defaults to None

None
modified (datetime, optional)

, defaults to None

None
label (str, optional)

, defaults to None

None
description (str, optional)

, defaults to None

None
info (object, optional)

, defaults to None

None
curator (str, optional)

, defaults to None

None
revision (int, optional)

, defaults to 1

1
notes (list[Note], optional)

, defaults to None

None
tags (list[str], optional)

, defaults to None

None
analyses (list[union[AnalysisListOutput, AnalysisListOutputInflatedJob]], optional)

, defaults to None

None
permissions (list[AccessPermission], optional)

, defaults to None

None
join_origin (JoinOrigins, optional)

, defaults to None

None
files (list[FileListOutput], optional)

, defaults to None

None
attachment_count (int, optional)

, defaults to 0

0
session_count (int, optional)

, defaults to 0

0
noncompliant_session_count (int, optional)

, defaults to 0

0
subject_count (int, optional)

, defaults to 0

0

__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