flywheel.models.data_view_file_spec
DataViewFileSpec
Bases: object
analysis_filter property writable
Gets the analysis_filter of this DataViewFileSpec.
Returns:
| Type | Description |
|---|---|
DataViewAnalysisFilterSpec | The analysis_filter of this DataViewFileSpec |
columns property writable
Gets the columns of this DataViewFileSpec.
Returns:
| Type | Description |
|---|---|
list[DataViewColumnSpec] | The columns of this DataViewFileSpec |
container property writable
Gets the container of this DataViewFileSpec.
The type of container (e.g. session)
Returns:
| Type | Description |
|---|---|
str | The container of this DataViewFileSpec |
filter property writable
Gets the filter of this DataViewFileSpec.
Returns:
| Type | Description |
|---|---|
DataViewNameFilterSpec | The filter of this DataViewFileSpec |
format property writable
Gets the format of this DataViewFileSpec.
The expected data file format, default is auto-detect
Returns:
| Type | Description |
|---|---|
str | The format of this DataViewFileSpec |
format_options property writable
Gets the format_options of this DataViewFileSpec.
Returns:
| Type | Description |
|---|---|
object | The format_options of this DataViewFileSpec |
match property writable
Gets the match of this DataViewFileSpec.
If multiple file matches are encountered, which file to choose. Default is first
Returns:
| Type | Description |
|---|---|
str | The match of this DataViewFileSpec |
process_files property writable
Gets the process_files of this DataViewFileSpec.
Set to false to skip file reading, and return file attributes instead
Returns:
| Type | Description |
|---|---|
bool | The process_files of this DataViewFileSpec |
zip_member property writable
Gets the zip_member of this DataViewFileSpec.
Returns:
| Type | Description |
|---|---|
DataViewZipFilterSpec | The zip_member of this DataViewFileSpec |
__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__(container=None, analysis_filter=None, filter=None, zip_member=None, match=None, format=None, format_options=None, process_files=None, columns=None)
DataViewFileSpec - a model defined in Swagger
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
container | (str, optional) | The type of container (e.g. session), defaults to None | None |
analysis_filter | (DataViewAnalysisFilterSpec, optional) | , defaults to None | None |
filter | (DataViewNameFilterSpec, optional) | , defaults to None | None |
zip_member | (DataViewZipFilterSpec, optional) | , defaults to None | None |
match | (str, optional) | If multiple file matches are encountered, which file to choose. Default is first, defaults to None | None |
format | (str, optional) | The expected data file format, default is auto-detect, defaults to None | None |
format_options | (object, optional) | , defaults to None | None |
process_files | (bool, optional) | Set to false to skip file reading, and return file attributes instead, defaults to None | None |
columns | (list[DataViewColumnSpec], 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