flywheel.models package¶
Submodules¶
flywheel.models.access_level module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.access_permission module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.access_permission.AccessPermission(id=None, access=None)¶ Bases:
object-
property
access¶ Gets the access of this AccessPermission.
- Returns
The access of this AccessPermission.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this AccessPermission.
- Returns
The id of this AccessPermission.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.access_permission_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.access_permission_output.AccessPermissionOutput(id=None, access=None)¶ Bases:
object-
property
access¶ Gets the access of this AccessPermissionOutput.
- Returns
The access of this AccessPermissionOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this AccessPermissionOutput.
- Returns
The id of this AccessPermissionOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.access_permission_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.access_permission_update.AccessPermissionUpdate(access=None)¶ Bases:
object-
property
access¶ Gets the access of this AccessPermissionUpdate.
- Returns
The access of this AccessPermissionUpdate.
- Return type
-
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
-
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
-
property
flywheel.models.accumulator module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.acquisition module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.acquisition_container_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.acquisition_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.acquisition_input.AcquisitionInput(label=None, session=None, uid=None, timestamp=None, timezone=None, info=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this AcquisitionInput.
- Returns
The info of this AcquisitionInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AcquisitionInput.
- Returns
The label of this AcquisitionInput.
- Return type
str
-
property
session¶ Gets the session of this AcquisitionInput.
- Returns
The session of this AcquisitionInput.
- Return type
str
-
property
timestamp¶ Gets the timestamp of this AcquisitionInput.
- Returns
The timestamp of this AcquisitionInput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this AcquisitionInput.
- Returns
The timezone of this AcquisitionInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this AcquisitionInput.
- Returns
The uid of this AcquisitionInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.acquisition_list_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.acquisition_list_output.AcquisitionListOutput(id=None, parents=None, label=None, session=None, info=None, info_exists=None, metadata=None, uid=None, timestamp=None, timezone=None, created=None, tags=None, modified=None, revision=1, permissions=None, notes=None, analyses=None, collections=None, join_origin=None, files=None, copy_of=None, original_copy_of=None)¶ Bases:
flywheel.models.mixins.AcquisitionMixin-
property
analyses¶ Gets the analyses of this AcquisitionListOutput.
- Returns
The analyses of this AcquisitionListOutput.
- Return type
list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]
-
property
collections¶ Gets the collections of this AcquisitionListOutput.
- Returns
The collections of this AcquisitionListOutput.
- Return type
list[str]
-
property
copy_of¶ Gets the copy_of of this AcquisitionListOutput.
- Returns
The copy_of of this AcquisitionListOutput.
- Return type
str
-
property
created¶ Gets the created of this AcquisitionListOutput.
- Returns
The created of this AcquisitionListOutput.
- Return type
datetime
-
property
files¶ Gets the files of this AcquisitionListOutput.
- Returns
The files of this AcquisitionListOutput.
- Return type
list[FileListOutput]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this AcquisitionListOutput.
- Returns
The id of this AcquisitionListOutput.
- Return type
str
-
property
info¶ Gets the info of this AcquisitionListOutput.
- Returns
The info of this AcquisitionListOutput.
- Return type
object
-
property
info_exists¶ Gets the info_exists of this AcquisitionListOutput.
- Returns
The info_exists of this AcquisitionListOutput.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
property
join_origin¶ Gets the join_origin of this AcquisitionListOutput.
- Returns
The join_origin of this AcquisitionListOutput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AcquisitionListOutput.
- Returns
The label of this AcquisitionListOutput.
- Return type
str
-
property
metadata¶ Gets the metadata of this AcquisitionListOutput.
- Returns
The metadata of this AcquisitionListOutput.
- Return type
object
-
property
modified¶ Gets the modified of this AcquisitionListOutput.
- Returns
The modified of this AcquisitionListOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this AcquisitionListOutput.
- Returns
The notes of this AcquisitionListOutput.
- Return type
list[Note]
-
property
original_copy_of¶ Gets the original_copy_of of this AcquisitionListOutput.
- Returns
The original_copy_of of this AcquisitionListOutput.
- Return type
str
-
property
parents¶ Gets the parents of this AcquisitionListOutput.
- Returns
The parents of this AcquisitionListOutput.
- Return type
-
property
permissions¶ Gets the permissions of this AcquisitionListOutput.
- Returns
The permissions of this AcquisitionListOutput.
- Return type
list[RolePermission]
-
property
revision¶ Gets the revision of this AcquisitionListOutput.
- Returns
The revision of this AcquisitionListOutput.
- Return type
int
-
property
session¶ Gets the session of this AcquisitionListOutput.
- Returns
The session of this AcquisitionListOutput.
- Return type
str
Gets the tags of this AcquisitionListOutput.
- Returns
The tags of this AcquisitionListOutput.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this AcquisitionListOutput.
- Returns
The timestamp of this AcquisitionListOutput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this AcquisitionListOutput.
- Returns
The timezone of this AcquisitionListOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this AcquisitionListOutput.
- Returns
The uid of this AcquisitionListOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.acquisition_modify_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.acquisition_modify_input.AcquisitionModifyInput(label=None, session=None, info=None, uid=None, timestamp=None, timezone=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this AcquisitionModifyInput.
- Returns
The info of this AcquisitionModifyInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AcquisitionModifyInput.
- Returns
The label of this AcquisitionModifyInput.
- Return type
str
-
property
session¶ Gets the session of this AcquisitionModifyInput.
- Returns
The session of this AcquisitionModifyInput.
- Return type
str
-
property
timestamp¶ Gets the timestamp of this AcquisitionModifyInput.
- Returns
The timestamp of this AcquisitionModifyInput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this AcquisitionModifyInput.
- Returns
The timezone of this AcquisitionModifyInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this AcquisitionModifyInput.
- Returns
The uid of this AcquisitionModifyInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.acquisition_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.acquisition_output.AcquisitionOutput(id=None, parents=None, label=None, session=None, info_exists=None, info=None, metadata=None, uid=None, timestamp=None, timezone=None, created=None, modified=None, revision=1, permissions=None, tags=None, notes=None, analyses=None, collections=None, join_origin=None, files=None, copy_of=None, original_copy_of=None)¶ Bases:
flywheel.models.mixins.AcquisitionMixin-
property
analyses¶ Gets the analyses of this AcquisitionOutput.
- Returns
The analyses of this AcquisitionOutput.
- Return type
list[union[AnalysisOutput,AnalysisOutputInflatedJob]]
-
property
collections¶ Gets the collections of this AcquisitionOutput.
- Returns
The collections of this AcquisitionOutput.
- Return type
list[str]
-
property
copy_of¶ Gets the copy_of of this AcquisitionOutput.
- Returns
The copy_of of this AcquisitionOutput.
- Return type
str
-
property
created¶ Gets the created of this AcquisitionOutput.
- Returns
The created of this AcquisitionOutput.
- Return type
datetime
-
property
files¶ Gets the files of this AcquisitionOutput.
- Returns
The files of this AcquisitionOutput.
- Return type
list[FileOutput]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this AcquisitionOutput.
- Returns
The id of this AcquisitionOutput.
- Return type
str
-
property
info¶ Gets the info of this AcquisitionOutput.
- Returns
The info of this AcquisitionOutput.
- Return type
object
-
property
info_exists¶ Gets the info_exists of this AcquisitionOutput.
- Returns
The info_exists of this AcquisitionOutput.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
property
join_origin¶ Gets the join_origin of this AcquisitionOutput.
- Returns
The join_origin of this AcquisitionOutput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AcquisitionOutput.
- Returns
The label of this AcquisitionOutput.
- Return type
str
-
property
metadata¶ Gets the metadata of this AcquisitionOutput.
- Returns
The metadata of this AcquisitionOutput.
- Return type
object
-
property
modified¶ Gets the modified of this AcquisitionOutput.
- Returns
The modified of this AcquisitionOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this AcquisitionOutput.
- Returns
The notes of this AcquisitionOutput.
- Return type
list[Note]
-
property
original_copy_of¶ Gets the original_copy_of of this AcquisitionOutput.
- Returns
The original_copy_of of this AcquisitionOutput.
- Return type
str
-
property
parents¶ Gets the parents of this AcquisitionOutput.
- Returns
The parents of this AcquisitionOutput.
- Return type
-
property
permissions¶ Gets the permissions of this AcquisitionOutput.
- Returns
The permissions of this AcquisitionOutput.
- Return type
list[RolePermission]
-
property
revision¶ Gets the revision of this AcquisitionOutput.
- Returns
The revision of this AcquisitionOutput.
- Return type
int
-
property
session¶ Gets the session of this AcquisitionOutput.
- Returns
The session of this AcquisitionOutput.
- Return type
str
Gets the tags of this AcquisitionOutput.
- Returns
The tags of this AcquisitionOutput.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this AcquisitionOutput.
- Returns
The timestamp of this AcquisitionOutput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this AcquisitionOutput.
- Returns
The timezone of this AcquisitionOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this AcquisitionOutput.
- Returns
The uid of this AcquisitionOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.acquisition_parents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.acquisition_parents.AcquisitionParents(group=None, project=None, subject=None, session=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this AcquisitionParents.
- Returns
The group of this AcquisitionParents.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this AcquisitionParents.
- Returns
The project of this AcquisitionParents.
- Return type
str
-
property
session¶ Gets the session of this AcquisitionParents.
- Returns
The session of this AcquisitionParents.
- Return type
str
-
property
subject¶ Gets the subject of this AcquisitionParents.
- Returns
The subject of this AcquisitionParents.
- Return type
str
-
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
-
flywheel.models.acquisition_template_options module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.acquisition_template_options.AcquisitionTemplateOptions(minimum=None, maximum=None, files=None, label=None, tags=None)¶ Bases:
object-
property
files¶ Gets the files of this AcquisitionTemplateOptions.
- Returns
The files of this AcquisitionTemplateOptions.
- Return type
list[FileTemplateOptions]
-
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
-
property
label¶ Gets the label of this AcquisitionTemplateOptions.
- Returns
The label of this AcquisitionTemplateOptions.
- Return type
str
-
property
maximum¶ Gets the maximum of this AcquisitionTemplateOptions.
- Returns
The maximum of this AcquisitionTemplateOptions.
- Return type
int
-
property
minimum¶ Gets the minimum of this AcquisitionTemplateOptions.
- Returns
The minimum of this AcquisitionTemplateOptions.
- Return type
int
Gets the tags of this AcquisitionTemplateOptions.
- Returns
The tags of this AcquisitionTemplateOptions.
- Return type
str
-
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
-
property
flywheel.models.action module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.action.Action¶ Bases:
str,enum.EnumAn enumeration.
-
ANALYSES_CREATE_JOB= 'analyses_create_job'¶
-
ANALYSES_CREATE_SDK= 'analyses_create_sdk'¶
-
ANALYSES_DELETE= 'analyses_delete'¶
-
ANALYSES_MODIFY_METADATA= 'analyses_modify_metadata'¶
-
ANALYSES_VIEW_METADATA= 'analyses_view_metadata'¶
-
ANNOTATIONS_EDIT_OTHERS= 'annotations_edit_others'¶
-
ANNOTATIONS_MANAGE= 'annotations_manage'¶
-
ANNOTATIONS_VIEW_OTHERS= 'annotations_view_others'¶
-
AUDIT_TRAIL_REPORTS_MANAGE= 'audit_trail_reports_manage'¶
-
AUDIT_TRAIL_REPORTS_VIEW= 'audit_trail_reports_view'¶
-
CONTAINERS_CREATE_HIERARCHY= 'containers_create_hierarchy'¶
-
CONTAINERS_DELETE_HIERARCHY= 'containers_delete_hierarchy'¶
-
CONTAINERS_DELETE_PROJECT= 'containers_delete_project'¶
-
CONTAINERS_MODIFY_METADATA= 'containers_modify_metadata'¶
-
CONTAINERS_VIEW_METADATA= 'containers_view_metadata'¶
-
COPY_BY_REFERENCE= 'copy_by_reference'¶
-
DATA_VIEWS_MANAGE= 'data_views_manage'¶
-
DATA_VIEWS_VIEW= 'data_views_view'¶
-
EXPORTS_MANAGE= 'exports_manage'¶
-
FILES_CREATE_UPLOAD= 'files_create_upload'¶
-
FILES_DELETE_DEVICE_DATA= 'files_delete_device_data'¶
-
FILES_DELETE_NON_DEVICE_DATA= 'files_delete_non_device_data'¶
-
FILES_DOWNLOAD= 'files_download'¶
-
FILES_MODIFY_METADATA= 'files_modify_metadata'¶
-
FILES_MOVE= 'files_move'¶
-
FILES_VIEW_CONTENTS= 'files_view_contents'¶
-
FILES_VIEW_METADATA= 'files_view_metadata'¶
-
FORM_ADMIN= 'form_admin'¶
-
FORM_RESPONSES_EDIT_OTHERS= 'form_responses_edit_others'¶
-
FORM_RESPONSES_MANAGE= 'form_responses_manage'¶
-
FORM_RESPONSES_VIEW_OTHERS= 'form_responses_view_others'¶
-
GEAR_RULES_MANAGE= 'gear_rules_manage'¶
-
GEAR_RULES_VIEW= 'gear_rules_view'¶
-
IMPORTS_MANAGE= 'imports_manage'¶
-
JOBS_MANAGE= 'jobs_manage'¶
-
JOBS_MANAGE_OTHERS= 'jobs_manage_others'¶
-
JOBS_VIEW= 'jobs_view'¶
-
NOTES_MANAGE= 'notes_manage'¶
-
NOTES_VIEW= 'notes_view'¶
-
PROJECT_PERMISSIONS_MANAGE= 'project_permissions_manage'¶
-
PROJECT_PERMISSIONS_VIEW= 'project_permissions_view'¶
-
PROJECT_SHARING_MANAGE= 'project_sharing_manage'¶
-
READER_TASK_ADMIN= 'reader_task_admin'¶
-
READER_TASK_VIEW= 'reader_task_view'¶
-
SESSION_TEMPLATES_MANAGE= 'session_templates_manage'¶
-
SESSION_TEMPLATES_VIEW= 'session_templates_view'¶
-
SETTINGS_MODIFY= 'settings_modify'¶
-
SETTINGS_VIEW= 'settings_view'¶
-
TAGS_MANAGE= 'tags_manage'¶
-
TAGS_VIEW= 'tags_view'¶
-
WORKSPACES_DELETE= 'workspaces_delete'¶
-
WORKSPACES_MANAGE= 'workspaces_manage'¶
-
flywheel.models.adhoc_analysis_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.adhoc_analysis_input.AdhocAnalysisInput(label=None, inputs=None, description='', info=None)¶ Bases:
object-
property
description¶ Gets the description of this AdhocAnalysisInput.
- Returns
The description of this AdhocAnalysisInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this AdhocAnalysisInput.
- Returns
The info of this AdhocAnalysisInput.
- Return type
object
-
property
inputs¶ Gets the inputs of this AdhocAnalysisInput.
- Returns
The inputs of this AdhocAnalysisInput.
- Return type
list[FileReference]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AdhocAnalysisInput.
- Returns
The label of this AdhocAnalysisInput.
- Return type
str
-
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
-
property
flywheel.models.analysis module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.analysis_container_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.analysis_files_create_ticket_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_files_create_ticket_output.AnalysisFilesCreateTicketOutput(ticket=None, filename=None, file_cnt=None, size=None)¶ Bases:
object-
property
file_cnt¶ Gets the file_cnt of this AnalysisFilesCreateTicketOutput.
- Returns
The file_cnt of this AnalysisFilesCreateTicketOutput.
- Return type
int
-
property
filename¶ Gets the filename of this AnalysisFilesCreateTicketOutput.
- Returns
The filename of this AnalysisFilesCreateTicketOutput.
- Return type
str
-
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
-
property
size¶ Gets the size of this AnalysisFilesCreateTicketOutput.
- Returns
The size of this AnalysisFilesCreateTicketOutput.
- Return type
int
-
property
ticket¶ Gets the ticket of this AnalysisFilesCreateTicketOutput.
- Returns
The ticket of this AnalysisFilesCreateTicketOutput.
- Return type
str
-
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
-
property
flywheel.models.analysis_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_input.AnalysisInput(inputs=None, description=None, info=None, label=None, job=None, compute_provider_id=None)¶ Bases:
object-
property
compute_provider_id¶ Gets the compute_provider_id of this AnalysisInput.
Unique database ID
- Returns
The compute_provider_id of this AnalysisInput.
- Return type
str
-
property
description¶ Gets the description of this AnalysisInput.
- Returns
The description of this AnalysisInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this AnalysisInput.
- Returns
The info of this AnalysisInput.
- Return type
-
property
inputs¶ Gets the inputs of this AnalysisInput.
The set of inputs that this analysis is based on
- Returns
The inputs of this AnalysisInput.
- Return type
list[FileReference]
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this AnalysisInput.
- Returns
The job of this AnalysisInput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AnalysisInput.
Application-specific label
- Returns
The label of this AnalysisInput.
- Return type
str
-
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
-
property
flywheel.models.analysis_input_legacy module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_input_legacy.AnalysisInputLegacy(inputs=None, outputs=None, description=None, label=None)¶ Bases:
object-
property
description¶ Gets the description of this AnalysisInputLegacy.
- Returns
The description of this AnalysisInputLegacy.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
inputs¶ Gets the inputs of this AnalysisInputLegacy.
The set of inputs that this analysis is based on
- Returns
The inputs of this AnalysisInputLegacy.
- Return type
list[FileEntry]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AnalysisInputLegacy.
Application-specific label
- Returns
The label of this AnalysisInputLegacy.
- Return type
str
-
property
outputs¶ Gets the outputs of this AnalysisInputLegacy.
- Returns
The outputs of this AnalysisInputLegacy.
- Return type
list[FileEntry]
-
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
-
property
flywheel.models.analysis_list_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_list_output.AnalysisListOutput(id=None, label=None, parent=None, parents=None, created=None, modified=None, revision=None, tags=None, inputs=None, description=None, files=None, notes=None, job=None, gear_info=None, compute_provider_id=None, join_origin=None, copy_of=None, original_copy_of=None, timestamp=None, info=None)¶ Bases:
flywheel.models.mixins.AnalysisMixin-
property
compute_provider_id¶ Gets the compute_provider_id of this AnalysisListOutput.
- Returns
The compute_provider_id of this AnalysisListOutput.
- Return type
str
-
property
copy_of¶ Gets the copy_of of this AnalysisListOutput.
- Returns
The copy_of of this AnalysisListOutput.
- Return type
str
-
property
created¶ Gets the created of this AnalysisListOutput.
- Returns
The created of this AnalysisListOutput.
- Return type
datetime
-
property
description¶ Gets the description of this AnalysisListOutput.
- Returns
The description of this AnalysisListOutput.
- Return type
str
-
property
files¶ Gets the files of this AnalysisListOutput.
- Returns
The files of this AnalysisListOutput.
- Return type
list[FileListOutput]
-
property
gear_info¶ Gets the gear_info of this AnalysisListOutput.
- Returns
The gear_info of this AnalysisListOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this AnalysisListOutput.
- Returns
The id of this AnalysisListOutput.
- Return type
str
-
property
info¶ Gets the info of this AnalysisListOutput.
- Returns
The info of this AnalysisListOutput.
- Return type
object
-
property
inputs¶ Gets the inputs of this AnalysisListOutput.
- Returns
The inputs of this AnalysisListOutput.
- Return type
list[FileListOutput]
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this AnalysisListOutput.
- Returns
The job of this AnalysisListOutput.
- Return type
str
-
property
join_origin¶ Gets the join_origin of this AnalysisListOutput.
- Returns
The join_origin of this AnalysisListOutput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AnalysisListOutput.
- Returns
The label of this AnalysisListOutput.
- Return type
str
-
property
modified¶ Gets the modified of this AnalysisListOutput.
- Returns
The modified of this AnalysisListOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this AnalysisListOutput.
- Returns
The notes of this AnalysisListOutput.
- Return type
list[Note]
-
property
original_copy_of¶ Gets the original_copy_of of this AnalysisListOutput.
- Returns
The original_copy_of of this AnalysisListOutput.
- Return type
str
-
property
parent¶ Gets the parent of this AnalysisListOutput.
- Returns
The parent of this AnalysisListOutput.
- Return type
-
property
parents¶ Gets the parents of this AnalysisListOutput.
- Returns
The parents of this AnalysisListOutput.
- Return type
-
property
revision¶ Gets the revision of this AnalysisListOutput.
- Returns
The revision of this AnalysisListOutput.
- Return type
int
Gets the tags of this AnalysisListOutput.
- Returns
The tags of this AnalysisListOutput.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this AnalysisListOutput.
- Returns
The timestamp of this AnalysisListOutput.
- Return type
datetime
-
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
-
property
flywheel.models.analysis_list_output_inflated_job module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_list_output_inflated_job.AnalysisListOutputInflatedJob(id=None, label=None, parent=None, parents=None, created=None, modified=None, revision=None, inputs=None, description=None, tags=None, files=None, notes=None, job_id=None, job=None, gear_info=None, compute_provider_id=None, join_origin=None, copy_of=None, original_copy_of=None)¶ Bases:
object-
property
compute_provider_id¶ Gets the compute_provider_id of this AnalysisListOutputInflatedJob.
- Returns
The compute_provider_id of this AnalysisListOutputInflatedJob.
- Return type
str
-
property
copy_of¶ Gets the copy_of of this AnalysisListOutputInflatedJob.
- Returns
The copy_of of this AnalysisListOutputInflatedJob.
- Return type
str
-
property
created¶ Gets the created of this AnalysisListOutputInflatedJob.
- Returns
The created of this AnalysisListOutputInflatedJob.
- Return type
datetime
-
property
description¶ Gets the description of this AnalysisListOutputInflatedJob.
- Returns
The description of this AnalysisListOutputInflatedJob.
- Return type
str
-
property
files¶ Gets the files of this AnalysisListOutputInflatedJob.
- Returns
The files of this AnalysisListOutputInflatedJob.
- Return type
list[FileListOutput]
-
property
gear_info¶ Gets the gear_info of this AnalysisListOutputInflatedJob.
- Returns
The gear_info of this AnalysisListOutputInflatedJob.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this AnalysisListOutputInflatedJob.
- Returns
The id of this AnalysisListOutputInflatedJob.
- Return type
str
-
property
inputs¶ Gets the inputs of this AnalysisListOutputInflatedJob.
- Returns
The inputs of this AnalysisListOutputInflatedJob.
- Return type
list[FileListOutput]
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this AnalysisListOutputInflatedJob.
- Returns
The job of this AnalysisListOutputInflatedJob.
- Return type
-
property
job_id¶ Gets the job_id of this AnalysisListOutputInflatedJob.
- Returns
The job_id of this AnalysisListOutputInflatedJob.
- Return type
str
-
property
join_origin¶ Gets the join_origin of this AnalysisListOutputInflatedJob.
- Returns
The join_origin of this AnalysisListOutputInflatedJob.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AnalysisListOutputInflatedJob.
- Returns
The label of this AnalysisListOutputInflatedJob.
- Return type
str
-
property
modified¶ Gets the modified of this AnalysisListOutputInflatedJob.
- Returns
The modified of this AnalysisListOutputInflatedJob.
- Return type
datetime
-
property
notes¶ Gets the notes of this AnalysisListOutputInflatedJob.
- Returns
The notes of this AnalysisListOutputInflatedJob.
- Return type
list[Note]
-
property
original_copy_of¶ Gets the original_copy_of of this AnalysisListOutputInflatedJob.
- Returns
The original_copy_of of this AnalysisListOutputInflatedJob.
- Return type
str
-
property
parent¶ Gets the parent of this AnalysisListOutputInflatedJob.
- Returns
The parent of this AnalysisListOutputInflatedJob.
- Return type
-
property
parents¶ Gets the parents of this AnalysisListOutputInflatedJob.
- Returns
The parents of this AnalysisListOutputInflatedJob.
- Return type
-
property
revision¶ Gets the revision of this AnalysisListOutputInflatedJob.
- Returns
The revision of this AnalysisListOutputInflatedJob.
- Return type
int
Gets the tags of this AnalysisListOutputInflatedJob.
- Returns
The tags of this AnalysisListOutputInflatedJob.
- Return type
list[str]
-
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
-
property
flywheel.models.analysis_modify_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_modify_input.AnalysisModifyInput(description=None, label=None)¶ Bases:
object-
property
description¶ Gets the description of this AnalysisModifyInput.
- Returns
The description of this AnalysisModifyInput.
- Return type
str
-
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
-
property
label¶ Gets the label of this AnalysisModifyInput.
- Returns
The label of this AnalysisModifyInput.
- Return type
str
-
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
-
property
flywheel.models.analysis_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_output.AnalysisOutput(id=None, label=None, parent=None, parents=None, created=None, modified=None, timestamp=None, revision=None, inputs=None, description=None, info=None, files=None, notes=None, tags=None, job=None, gear_info=None, compute_provider_id=None, join_origin=None, copy_of=None, original_copy_of=None)¶ Bases:
flywheel.models.mixins.AnalysisMixin-
property
compute_provider_id¶ Gets the compute_provider_id of this AnalysisOutput.
- Returns
The compute_provider_id of this AnalysisOutput.
- Return type
str
-
property
copy_of¶ Gets the copy_of of this AnalysisOutput.
- Returns
The copy_of of this AnalysisOutput.
- Return type
str
-
property
created¶ Gets the created of this AnalysisOutput.
- Returns
The created of this AnalysisOutput.
- Return type
datetime
-
property
description¶ Gets the description of this AnalysisOutput.
- Returns
The description of this AnalysisOutput.
- Return type
str
-
property
files¶ Gets the files of this AnalysisOutput.
- Returns
The files of this AnalysisOutput.
- Return type
list[FileOutput]
-
property
gear_info¶ Gets the gear_info of this AnalysisOutput.
- Returns
The gear_info of this AnalysisOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this AnalysisOutput.
- Returns
The id of this AnalysisOutput.
- Return type
str
-
property
info¶ Gets the info of this AnalysisOutput.
- Returns
The info of this AnalysisOutput.
- Return type
object
-
property
inputs¶ Gets the inputs of this AnalysisOutput.
- Returns
The inputs of this AnalysisOutput.
- Return type
list[FileOutput]
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this AnalysisOutput.
- Returns
The job of this AnalysisOutput.
- Return type
-
property
join_origin¶ Gets the join_origin of this AnalysisOutput.
- Returns
The join_origin of this AnalysisOutput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AnalysisOutput.
- Returns
The label of this AnalysisOutput.
- Return type
str
-
property
modified¶ Gets the modified of this AnalysisOutput.
- Returns
The modified of this AnalysisOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this AnalysisOutput.
- Returns
The notes of this AnalysisOutput.
- Return type
list[Note]
-
property
original_copy_of¶ Gets the original_copy_of of this AnalysisOutput.
- Returns
The original_copy_of of this AnalysisOutput.
- Return type
str
-
property
parent¶ Gets the parent of this AnalysisOutput.
- Returns
The parent of this AnalysisOutput.
- Return type
-
property
parents¶ Gets the parents of this AnalysisOutput.
- Returns
The parents of this AnalysisOutput.
- Return type
-
property
revision¶ Gets the revision of this AnalysisOutput.
- Returns
The revision of this AnalysisOutput.
- Return type
int
Gets the tags of this AnalysisOutput.
- Returns
The tags of this AnalysisOutput.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this AnalysisOutput.
- Returns
The timestamp of this AnalysisOutput.
- Return type
datetime
-
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
-
property
flywheel.models.analysis_output_inflated_job module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_output_inflated_job.AnalysisOutputInflatedJob(id=None, label=None, parent=None, parents=None, created=None, modified=None, revision=None, inputs=None, description=None, info=None, files=None, notes=None, tags=None, job_id=None, job=None, gear_info=None, compute_provider_id=None, join_origin=None, copy_of=None, original_copy_of=None)¶ Bases:
object-
property
compute_provider_id¶ Gets the compute_provider_id of this AnalysisOutputInflatedJob.
- Returns
The compute_provider_id of this AnalysisOutputInflatedJob.
- Return type
str
-
property
copy_of¶ Gets the copy_of of this AnalysisOutputInflatedJob.
- Returns
The copy_of of this AnalysisOutputInflatedJob.
- Return type
str
-
property
created¶ Gets the created of this AnalysisOutputInflatedJob.
- Returns
The created of this AnalysisOutputInflatedJob.
- Return type
datetime
-
property
description¶ Gets the description of this AnalysisOutputInflatedJob.
- Returns
The description of this AnalysisOutputInflatedJob.
- Return type
str
-
property
files¶ Gets the files of this AnalysisOutputInflatedJob.
- Returns
The files of this AnalysisOutputInflatedJob.
- Return type
list[FileOutput]
-
property
gear_info¶ Gets the gear_info of this AnalysisOutputInflatedJob.
- Returns
The gear_info of this AnalysisOutputInflatedJob.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this AnalysisOutputInflatedJob.
- Returns
The id of this AnalysisOutputInflatedJob.
- Return type
str
-
property
info¶ Gets the info of this AnalysisOutputInflatedJob.
- Returns
The info of this AnalysisOutputInflatedJob.
- Return type
object
-
property
inputs¶ Gets the inputs of this AnalysisOutputInflatedJob.
- Returns
The inputs of this AnalysisOutputInflatedJob.
- Return type
list[FileOutput]
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this AnalysisOutputInflatedJob.
- Returns
The job of this AnalysisOutputInflatedJob.
- Return type
-
property
job_id¶ Gets the job_id of this AnalysisOutputInflatedJob.
- Returns
The job_id of this AnalysisOutputInflatedJob.
- Return type
str
-
property
join_origin¶ Gets the join_origin of this AnalysisOutputInflatedJob.
- Returns
The join_origin of this AnalysisOutputInflatedJob.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AnalysisOutputInflatedJob.
- Returns
The label of this AnalysisOutputInflatedJob.
- Return type
str
-
property
modified¶ Gets the modified of this AnalysisOutputInflatedJob.
- Returns
The modified of this AnalysisOutputInflatedJob.
- Return type
datetime
-
property
notes¶ Gets the notes of this AnalysisOutputInflatedJob.
- Returns
The notes of this AnalysisOutputInflatedJob.
- Return type
list[Note]
-
property
original_copy_of¶ Gets the original_copy_of of this AnalysisOutputInflatedJob.
- Returns
The original_copy_of of this AnalysisOutputInflatedJob.
- Return type
str
-
property
parent¶ Gets the parent of this AnalysisOutputInflatedJob.
- Returns
The parent of this AnalysisOutputInflatedJob.
- Return type
-
property
parents¶ Gets the parents of this AnalysisOutputInflatedJob.
- Returns
The parents of this AnalysisOutputInflatedJob.
- Return type
-
property
revision¶ Gets the revision of this AnalysisOutputInflatedJob.
- Returns
The revision of this AnalysisOutputInflatedJob.
- Return type
int
Gets the tags of this AnalysisOutputInflatedJob.
- Returns
The tags of this AnalysisOutputInflatedJob.
- Return type
list[str]
-
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
-
property
flywheel.models.analysis_parents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_parents.AnalysisParents(group=None, project=None, subject=None, session=None, acquisition=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this AnalysisParents.
- Returns
The acquisition of this AnalysisParents.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this AnalysisParents.
- Returns
The group of this AnalysisParents.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this AnalysisParents.
- Returns
The project of this AnalysisParents.
- Return type
str
-
property
session¶ Gets the session of this AnalysisParents.
- Returns
The session of this AnalysisParents.
- Return type
str
-
property
subject¶ Gets the subject of this AnalysisParents.
- Returns
The subject of this AnalysisParents.
- Return type
str
-
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
-
property
flywheel.models.analysis_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_update.AnalysisUpdate(label=None)¶ Bases:
object-
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
-
property
label¶ Gets the label of this AnalysisUpdate.
Application-specific label
- Returns
The label of this AnalysisUpdate.
- Return type
str
-
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
-
flywheel.models.api_key_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.api_key_output.ApiKeyOutput(label=None, key=None, created=None, last_used=None, unencrypted_secret=None)¶ Bases:
object-
property
created¶ Gets the created of this ApiKeyOutput.
- Returns
The created of this ApiKeyOutput.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
key¶ Gets the key of this ApiKeyOutput.
- Returns
The key of this ApiKeyOutput.
- Return type
str
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ApiKeyOutput.
- Returns
The label of this ApiKeyOutput.
- Return type
str
-
property
last_used¶ Gets the last_used of this ApiKeyOutput.
- Returns
The last_used of this ApiKeyOutput.
- Return type
datetime
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
unencrypted_secret¶ Gets the unencrypted_secret of this ApiKeyOutput.
- Returns
The unencrypted_secret of this ApiKeyOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.as_storage module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.as_storage.AsStorage(bucket=None, path='', signed_urls=True, region=None, config_type=None, config_class=None)¶ Bases:
object-
property
bucket¶ Gets the bucket of this AsStorage.
- Returns
The bucket of this AsStorage.
- Return type
str
-
property
config_class¶ Gets the config_class of this AsStorage.
- Returns
The config_class of this AsStorage.
- Return type
str
-
property
config_type¶ Gets the config_type of this AsStorage.
- Returns
The config_type of this AsStorage.
- Return type
str
-
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
-
property
path¶ Gets the path of this AsStorage.
- Returns
The path of this AsStorage.
- Return type
str
-
property
region¶ Gets the region of this AsStorage.
- Returns
The region of this AsStorage.
- Return type
str
-
property
signed_urls¶ Gets the signed_urls of this AsStorage.
- Returns
The signed_urls of this AsStorage.
- Return type
bool
-
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
-
property
flywheel.models.audit_trail_report module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.audit_trail_report.AuditTrailReport(id=None, origin=None, project_id=None, subject_ids=None, label=None, status=None, created=None, finished=None, revision=1, deleted=None, error=None, celery_task_id=None, size=None)¶ Bases:
object-
property
celery_task_id¶ Gets the celery_task_id of this AuditTrailReport.
- Returns
The celery_task_id of this AuditTrailReport.
- Return type
str
-
property
created¶ Gets the created of this AuditTrailReport.
- Returns
The created of this AuditTrailReport.
- Return type
datetime
-
property
deleted¶ Gets the deleted of this AuditTrailReport.
- Returns
The deleted of this AuditTrailReport.
- Return type
datetime
-
property
error¶ Gets the error of this AuditTrailReport.
- Returns
The error of this AuditTrailReport.
- Return type
str
-
property
finished¶ Gets the finished of this AuditTrailReport.
- Returns
The finished of this AuditTrailReport.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this AuditTrailReport.
- Returns
The id of this AuditTrailReport.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AuditTrailReport.
- Returns
The label of this AuditTrailReport.
- Return type
str
-
property
origin¶ Gets the origin of this AuditTrailReport.
- Returns
The origin of this AuditTrailReport.
- Return type
-
property
project_id¶ Gets the project_id of this AuditTrailReport.
- Returns
The project_id of this AuditTrailReport.
- Return type
str
-
property
revision¶ Gets the revision of this AuditTrailReport.
- Returns
The revision of this AuditTrailReport.
- Return type
int
-
property
size¶ Gets the size of this AuditTrailReport.
- Returns
The size of this AuditTrailReport.
- Return type
int
-
property
status¶ Gets the status of this AuditTrailReport.
- Returns
The status of this AuditTrailReport.
- Return type
-
property
subject_ids¶ Gets the subject_ids of this AuditTrailReport.
- Returns
The subject_ids of this AuditTrailReport.
- Return type
list[str]
-
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
-
property
flywheel.models.audit_trail_report_status module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.auth0_auth_out module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.auth0_auth_out.Auth0AuthOut(client_id=None, domain=None, audience=None, claim_namespace=None, jwks=None, options=None)¶ Bases:
object-
property
audience¶ Gets the audience of this Auth0AuthOut.
- Returns
The audience of this Auth0AuthOut.
- Return type
list[str]
-
property
claim_namespace¶ Gets the claim_namespace of this Auth0AuthOut.
- Returns
The claim_namespace of this Auth0AuthOut.
- Return type
str
-
property
client_id¶ Gets the client_id of this Auth0AuthOut.
- Returns
The client_id of this Auth0AuthOut.
- Return type
str
-
property
domain¶ Gets the domain of this Auth0AuthOut.
- Returns
The domain of this Auth0AuthOut.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
jwks¶ Gets the jwks of this Auth0AuthOut.
- Returns
The jwks of this Auth0AuthOut.
- Return type
dict(str, object)
-
keys()¶ Returns the list of json properties in the object
-
property
options¶ Gets the options of this Auth0AuthOut.
- Returns
The options of this Auth0AuthOut.
- Return type
-
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
-
property
flywheel.models.auth0_options_out module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.auth0_options_out.Auth0OptionsOut(onboarding=None, onboarding_eppn=None, fetch_profile=None, limit_social_domains=None, social_domain_whitelist=None, academic_idp_whitelist=None, federated_logout_subs=None)¶ Bases:
object-
property
academic_idp_whitelist¶ Gets the academic_idp_whitelist of this Auth0OptionsOut.
- Returns
The academic_idp_whitelist of this Auth0OptionsOut.
- Return type
list[str]
-
property
federated_logout_subs¶ Gets the federated_logout_subs of this Auth0OptionsOut.
- Returns
The federated_logout_subs of this Auth0OptionsOut.
- Return type
list[str]
-
property
fetch_profile¶ Gets the fetch_profile of this Auth0OptionsOut.
- Returns
The fetch_profile of this Auth0OptionsOut.
- Return type
bool
-
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
Gets the limit_social_domains of this Auth0OptionsOut.
- Returns
The limit_social_domains of this Auth0OptionsOut.
- Return type
bool
-
property
onboarding¶ Gets the onboarding of this Auth0OptionsOut.
- Returns
The onboarding of this Auth0OptionsOut.
- Return type
bool
-
property
onboarding_eppn¶ Gets the onboarding_eppn of this Auth0OptionsOut.
- Returns
The onboarding_eppn of this Auth0OptionsOut.
- Return type
bool
Gets the social_domain_whitelist of this Auth0OptionsOut.
- Returns
The social_domain_whitelist of this Auth0OptionsOut.
- Return type
list[str]
-
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
-
property
flywheel.models.auth_login_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.auth_login_output.AuthLoginOutput(token=None)¶ Bases:
object-
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
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
token¶ Gets the token of this AuthLoginOutput.
- Returns
The token of this AuthLoginOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.auth_login_status module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.auth_login_status.AuthLoginStatus(origin=None, user_is_admin=None, is_device=None, roles=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
is_device¶ Gets the is_device of this AuthLoginStatus.
Whether or not the credentials identified a device
- Returns
The is_device of this AuthLoginStatus.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
origin¶ Gets the origin of this AuthLoginStatus.
- Returns
The origin of this AuthLoginStatus.
- Return type
-
property
roles¶ Gets the roles of this AuthLoginStatus.
- Returns
The roles of this AuthLoginStatus.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
user_is_admin¶ Gets the user_is_admin of this AuthLoginStatus.
Whether or not the user has admin privileges
- Returns
The user_is_admin of this AuthLoginStatus.
- Return type
bool
-
values()¶ Returns the list of values in the object
-
flywheel.models.auth_logout_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.auth_logout_output.AuthLogoutOutput(tokens_removed=None)¶ Bases:
object-
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
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
tokens_removed¶ Gets the tokens_removed of this AuthLogoutOutput.
- Returns
The tokens_removed of this AuthLogoutOutput.
- Return type
int
-
values()¶ Returns the list of values in the object
-
flywheel.models.auth_out module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.auth_out.AuthOut(google=None, auth0=None, basic=None, cas=None, ldap=None, mail=None, saml=None, wechat=None)¶ Bases:
object-
property
auth0¶ Gets the auth0 of this AuthOut.
- Returns
The auth0 of this AuthOut.
- Return type
-
property
basic¶ Gets the basic of this AuthOut.
- Returns
The basic of this AuthOut.
- Return type
object
-
property
cas¶ Gets the cas of this AuthOut.
- Returns
The cas of this AuthOut.
- Return type
object
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
google¶ Gets the google of this AuthOut.
- Returns
The google of this AuthOut.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
ldap¶ Gets the ldap of this AuthOut.
- Returns
The ldap of this AuthOut.
- Return type
object
-
property
mail¶ Gets the mail of this AuthOut.
- Returns
The mail of this AuthOut.
- Return type
object
-
property
saml¶ Gets the saml of this AuthOut.
- Returns
The saml of this AuthOut.
- Return type
object
-
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
-
property
wechat¶ Gets the wechat of this AuthOut.
- Returns
The wechat of this AuthOut.
- Return type
object
-
property
flywheel.models.avatars module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.avatars.Avatars(gravatar=None, provider=None, custom=None)¶ Bases:
object-
property
custom¶ Gets the custom of this Avatars.
- Returns
The custom of this Avatars.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
gravatar¶ Gets the gravatar of this Avatars.
- Returns
The gravatar of this Avatars.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
provider¶ Gets the provider of this Avatars.
- Returns
The provider of this Avatars.
- Return type
str
-
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
-
property
flywheel.models.aws_creds module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.aws_creds.AwsCreds(aws_access_key_id=None, aws_secret_access_key=None)¶ Bases:
object-
property
aws_access_key_id¶ Gets the aws_access_key_id of this AwsCreds.
- Returns
The aws_access_key_id of this AwsCreds.
- Return type
str
-
property
aws_secret_access_key¶ Gets the aws_secret_access_key of this AwsCreds.
- Returns
The aws_secret_access_key of this AwsCreds.
- Return type
str
-
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
-
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
-
property
flywheel.models.aws_storage module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.aws_storage.AwsStorage(region=None, bucket=None, path='', zone=None, endpoint_url=None, config_type=None, config_class=None)¶ Bases:
object-
property
bucket¶ Gets the bucket of this AwsStorage.
- Returns
The bucket of this AwsStorage.
- Return type
str
-
property
config_class¶ Gets the config_class of this AwsStorage.
- Returns
The config_class of this AwsStorage.
- Return type
str
-
property
config_type¶ Gets the config_type of this AwsStorage.
- Returns
The config_type of this AwsStorage.
- Return type
str
-
property
endpoint_url¶ Gets the endpoint_url of this AwsStorage.
- Returns
The endpoint_url of this AwsStorage.
- Return type
str
-
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
-
property
path¶ Gets the path of this AwsStorage.
- Returns
The path of this AwsStorage.
- Return type
str
-
property
region¶ Gets the region of this AwsStorage.
- Returns
The region of this AwsStorage.
- Return type
str
-
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
-
property
zone¶ Gets the zone of this AwsStorage.
- Returns
The zone of this AwsStorage.
- Return type
str
-
property
flywheel.models.azure_creds module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.azure_creds.AzureCreds(azure_account_name=None, azure_account_key=None)¶ Bases:
object-
property
azure_account_key¶ Gets the azure_account_key of this AzureCreds.
- Returns
The azure_account_key of this AzureCreds.
- Return type
str
-
property
azure_account_name¶ Gets the azure_account_name of this AzureCreds.
- Returns
The azure_account_name of this AzureCreds.
- Return type
str
-
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
-
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
-
property
flywheel.models.base_aet module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.base_aet.BaseAET(id=None, created=None, aet=None, creator=None)¶ Bases:
object-
property
aet¶ Gets the aet of this BaseAET.
- Returns
The aet of this BaseAET.
- Return type
str
-
property
created¶ Gets the created of this BaseAET.
- Returns
The created of this BaseAET.
- Return type
datetime
-
property
creator¶ Gets the creator of this BaseAET.
- Returns
The creator of this BaseAET.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this BaseAET.
- Returns
The id of this BaseAET.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.base_compute module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.base_compute.BaseCompute(queue_threshold=None, max_compute=None, machine_type=None, disk_size=None, swap_size='30G', preemptible=None, zone=None, region=None, tags=None, config_type=None, config_class=None)¶ Bases:
object-
property
config_class¶ Gets the config_class of this BaseCompute.
- Returns
The config_class of this BaseCompute.
- Return type
str
-
property
config_type¶ Gets the config_type of this BaseCompute.
- Returns
The config_type of this BaseCompute.
- Return type
str
-
property
disk_size¶ Gets the disk_size of this BaseCompute.
- Returns
The disk_size of this BaseCompute.
- Return type
int
-
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
-
property
machine_type¶ Gets the machine_type of this BaseCompute.
- Returns
The machine_type of this BaseCompute.
- Return type
str
-
property
max_compute¶ Gets the max_compute of this BaseCompute.
- Returns
The max_compute of this BaseCompute.
- Return type
int
-
property
preemptible¶ Gets the preemptible of this BaseCompute.
- Returns
The preemptible of this BaseCompute.
- Return type
bool
-
property
queue_threshold¶ Gets the queue_threshold of this BaseCompute.
- Returns
The queue_threshold of this BaseCompute.
- Return type
int
-
property
region¶ Gets the region of this BaseCompute.
- Returns
The region of this BaseCompute.
- Return type
str
-
property
swap_size¶ Gets the swap_size of this BaseCompute.
- Returns
The swap_size of this BaseCompute.
- Return type
str
Gets the tags of this BaseCompute.
- Returns
The tags of this BaseCompute.
- Return type
object
-
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
-
property
zone¶ Gets the zone of this BaseCompute.
- Returns
The zone of this BaseCompute.
- Return type
str
-
property
flywheel.models.batch module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.batch.Batch(id=None, gear_id=None, state=None, origin=None, config=None, priority=None, jobs=None, created=None, modified=None)¶ Bases:
flywheel.models.mixins.BatchMixin-
property
config¶ Gets the config of this Batch.
- Returns
The config of this Batch.
- Return type
-
property
created¶ Gets the created of this Batch.
Creation time (automatically set)
- Returns
The created of this Batch.
- Return type
datetime
-
property
gear_id¶ Gets the gear_id of this Batch.
- Returns
The gear_id of this Batch.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this Batch.
Unique database ID
- Returns
The id of this Batch.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
property
jobs¶ Gets the jobs of this Batch.
- Returns
The jobs of this Batch.
- Return type
list[str]
-
keys()¶ Returns the list of json properties in the object
-
property
modified¶ Gets the modified of this Batch.
Last modification time (automatically updated)
- Returns
The modified of this Batch.
- Return type
datetime
-
property
origin¶ Gets the origin of this Batch.
- Returns
The origin of this Batch.
- Return type
-
property
priority¶ Gets the priority of this Batch.
- Returns
The priority of this Batch.
- Return type
str
-
property
state¶ Gets the state of this Batch.
- Returns
The state of this Batch.
- Return type
str
-
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
-
property
flywheel.models.batch_cancel_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.batch_cancel_output.BatchCancelOutput(number_cancelled=None)¶ Bases:
object-
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
-
property
number_cancelled¶ Gets the number_cancelled of this BatchCancelOutput.
- Returns
The number_cancelled of this BatchCancelOutput.
- Return type
int
-
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
-
flywheel.models.batch_proposal module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.batch_proposal.BatchProposal(id=None, gear_id=None, state=None, config=None, origin=None, priority=None, proposal=None, ambiguous=None, matched=None, not_matched=None, optional_input_policy=None, improper_permissions=None, created=None, modified=None)¶ Bases:
flywheel.models.mixins.BatchProposalMixin-
property
ambiguous¶ Gets the ambiguous of this BatchProposal.
- Returns
The ambiguous of this BatchProposal.
- Return type
list[ContainerOutputWithFiles]
-
property
config¶ Gets the config of this BatchProposal.
- Returns
The config of this BatchProposal.
- Return type
-
property
created¶ Gets the created of this BatchProposal.
Creation time (automatically set)
- Returns
The created of this BatchProposal.
- Return type
datetime
-
property
gear_id¶ Gets the gear_id of this BatchProposal.
- Returns
The gear_id of this BatchProposal.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this BatchProposal.
Unique database ID
- Returns
The id of this BatchProposal.
- Return type
str
-
property
improper_permissions¶ Gets the improper_permissions of this BatchProposal.
- Returns
The improper_permissions of this BatchProposal.
- Return type
list[str]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
matched¶ Gets the matched of this BatchProposal.
- Returns
The matched of this BatchProposal.
- Return type
list[ContainerOutputWithFiles]
-
property
modified¶ Gets the modified of this BatchProposal.
Last modification time (automatically updated)
- Returns
The modified of this BatchProposal.
- Return type
datetime
-
property
not_matched¶ Gets the not_matched of this BatchProposal.
- Returns
The not_matched of this BatchProposal.
- Return type
list[ContainerOutputWithFiles]
-
property
optional_input_policy¶ Gets the optional_input_policy of this BatchProposal.
ignored: Ignore all optional inputs, flexible: match a file if it’s there, otherwise still match the container, required: treat all optional inputs as required inputs.
- Returns
The optional_input_policy of this BatchProposal.
- Return type
str
-
property
origin¶ Gets the origin of this BatchProposal.
- Returns
The origin of this BatchProposal.
- Return type
-
property
priority¶ Gets the priority of this BatchProposal.
- Returns
The priority of this BatchProposal.
- Return type
str
-
property
proposal¶ Gets the proposal of this BatchProposal.
- Returns
The proposal of this BatchProposal.
- Return type
-
property
state¶ Gets the state of this BatchProposal.
- Returns
The state of this BatchProposal.
- Return type
str
-
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
-
property
flywheel.models.batch_proposal_detail module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.batch_proposal_detail.BatchProposalDetail(analysis=None, tags=None)¶ Bases:
object-
property
analysis¶ Gets the analysis of this BatchProposalDetail.
- Returns
The analysis of this BatchProposalDetail.
- Return type
-
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
Gets the tags of this BatchProposalDetail.
Array of application-specific tags
- Returns
The tags of this BatchProposalDetail.
- Return type
list[str]
-
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
-
property
flywheel.models.batch_proposal_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.batch_proposal_input.BatchProposalInput(gear_id=None, config=None, tags=None, priority=None, optional_input_policy=None, analysis=None, compute_provider_id=None, targets=None)¶ Bases:
object-
property
analysis¶ Gets the analysis of this BatchProposalInput.
- Returns
The analysis of this BatchProposalInput.
- Return type
-
property
compute_provider_id¶ Gets the compute_provider_id of this BatchProposalInput.
Unique database ID
- Returns
The compute_provider_id of this BatchProposalInput.
- Return type
str
-
property
config¶ Gets the config of this BatchProposalInput.
- Returns
The config of this BatchProposalInput.
- Return type
-
property
gear_id¶ Gets the gear_id of this BatchProposalInput.
- Returns
The gear_id of this BatchProposalInput.
- Return type
str
-
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
-
property
optional_input_policy¶ Gets the optional_input_policy of this BatchProposalInput.
ignored: Ignore all optional inputs, flexible: match a file if it’s there, otherwise still match the container, required: treat all optional inputs as required inputs.
- Returns
The optional_input_policy of this BatchProposalInput.
- Return type
str
-
property
priority¶ Gets the priority of this BatchProposalInput.
- Returns
The priority of this BatchProposalInput.
- Return type
str
Gets the tags of this BatchProposalInput.
Array of application-specific tags
- Returns
The tags of this BatchProposalInput.
- Return type
list[str]
-
property
targets¶ Gets the targets of this BatchProposalInput.
- Returns
The targets of this BatchProposalInput.
- Return type
list[ContainerReference]
-
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
-
property
flywheel.models.body module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.body.Body(first_name=None, last_name=None, date_of_birth=None, patient_id=None, use_patient_id=None)¶ Bases:
object-
property
date_of_birth¶ Gets the date_of_birth of this Body.
Date of birth in YYYY-MM-DD format
- Returns
The date_of_birth of this Body.
- Return type
str
-
property
first_name¶ Gets the first_name of this Body.
First name
- Returns
The first_name of this Body.
- Return type
str
-
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
-
property
last_name¶ Gets the last_name of this Body.
Last name
- Returns
The last_name of this Body.
- Return type
str
-
property
patient_id¶ Gets the patient_id of this Body.
Patient id
- Returns
The patient_id of this Body.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
use_patient_id¶ Gets the use_patient_id of this Body.
Use patient ID for identification or first name, last name, DOB
- Returns
The use_patient_id of this Body.
- Return type
bool
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.body_regenerate_key_api_devices_device_id_key_post module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.body_regenerate_key_api_devices_device_id_key_post.BodyRegenerateKeyApiDevicesDeviceIdKeyPost(label=None)¶ Bases:
object-
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
-
property
label¶ Gets the label of this BodyRegenerateKeyApiDevicesDeviceIdKeyPost.
- Returns
The label of this BodyRegenerateKeyApiDevicesDeviceIdKeyPost.
- Return type
str
-
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
-
flywheel.models.body_region module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.body_region.BodyRegion¶ Bases:
str,enum.EnumAn enumeration.
-
ABDOMEN= 'Abdomen'¶
-
ABDOMEN_PELVIS= 'Abdomen+Pelvis'¶
-
ABDOMEN_PELVIS_LOWER_EXTREMITY= 'Abdomen+Pelvis+Lower extremity'¶
-
BREAST= 'Breast'¶
-
CHEST= 'Chest'¶
-
CHEST_ABDOMEN= 'Chest+Abdomen'¶
-
CHEST_ABDOMEN_PELVIS= 'Chest+Abdomen+Pelvis'¶
-
EXTREMITY= 'Extremity'¶
-
HEAD= 'Head'¶
-
HEAD_NECK= 'Head+Neck'¶
-
HEAD_NECK_CHEST_ABDOMEN= 'Head+Neck+Chest+Abdomen'¶
-
HEAD_NECK_CHEST_ABDOMEN_PELVIS= 'Head+Neck+Chest+Abdomen+Pelvis'¶
-
LOWER_EXTREMITY= 'Lower extremity'¶
-
NECK= 'Neck'¶
-
NECK_CHEST= 'Neck+Chest'¶
-
PELVIS= 'Pelvis'¶
-
PELVIS_LOWER_EXTREMITY= 'Pelvis+Lower extremity'¶
-
UPPER_EXTREMITY= 'Upper extremity'¶
-
WHOLE_BODY= 'Whole body'¶
-
flywheel.models.bulk_move_sessions module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.bulk_move_sessions.BulkMoveSessions(destination_container_type=None, sources=None, destinations=None, conflict_mode=None)¶ Bases:
object-
property
conflict_mode¶ Gets the conflict_mode of this BulkMoveSessions.
How to handle conflicts. Required even if no conflicts are found
- Returns
The conflict_mode of this BulkMoveSessions.
- Return type
str
-
property
destination_container_type¶ Gets the destination_container_type of this BulkMoveSessions.
The type of destination container
- Returns
The destination_container_type of this BulkMoveSessions.
- Return type
str
-
property
destinations¶ Gets the destinations of this BulkMoveSessions.
Array with a single continer Id of the destination container’s Id
- Returns
The destinations of this BulkMoveSessions.
- Return type
list[str]
-
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
-
property
sources¶ Gets the sources of this BulkMoveSessions.
Array of continer Ids that you would like to bulk move
- Returns
The sources of this BulkMoveSessions.
- Return type
list[str]
-
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
-
property
flywheel.models.callbacks_virus_scan_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.callbacks_virus_scan_input.CallbacksVirusScanInput(state=None)¶ Bases:
object-
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
-
property
state¶ Gets the state of this CallbacksVirusScanInput.
- Returns
The state of this CallbacksVirusScanInput.
- Return type
str
-
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
-
flywheel.models.catalog_list_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.catalog_list_output.CatalogListOutput(id=None, label=None, tags=None, therapeutic_areas=None, body_regions=None, organ_systems=None, project_institutions=None, project_contacts=None, summary=None, stats=None)¶ Bases:
object-
property
body_regions¶ Gets the body_regions of this CatalogListOutput.
- Returns
The body_regions of this CatalogListOutput.
- Return type
list[BodyRegion]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this CatalogListOutput.
- Returns
The id of this CatalogListOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this CatalogListOutput.
- Returns
The label of this CatalogListOutput.
- Return type
str
-
property
organ_systems¶ Gets the organ_systems of this CatalogListOutput.
- Returns
The organ_systems of this CatalogListOutput.
- Return type
list[OrganSystem]
-
property
project_contacts¶ Gets the project_contacts of this CatalogListOutput.
- Returns
The project_contacts of this CatalogListOutput.
- Return type
list[ProjectContact]
-
property
project_institutions¶ Gets the project_institutions of this CatalogListOutput.
- Returns
The project_institutions of this CatalogListOutput.
- Return type
list[ProjectInstitution]
-
property
stats¶ Gets the stats of this CatalogListOutput.
- Returns
The stats of this CatalogListOutput.
- Return type
-
property
summary¶ Gets the summary of this CatalogListOutput.
- Returns
The summary of this CatalogListOutput.
- Return type
str
Gets the tags of this CatalogListOutput.
- Returns
The tags of this CatalogListOutput.
- Return type
list[str]
-
property
therapeutic_areas¶ Gets the therapeutic_areas of this CatalogListOutput.
- Returns
The therapeutic_areas of this CatalogListOutput.
- Return type
list[TherapeuticArea]
-
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
-
property
flywheel.models.channel module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.classification_add_delete module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.classification_add_delete.ClassificationAddDelete(add=None, delete=None)¶ Bases:
object-
property
add¶ Gets the add of this ClassificationAddDelete.
- Returns
The add of this ClassificationAddDelete.
- Return type
-
property
delete¶ Gets the delete of this ClassificationAddDelete.
- Returns
The delete of this ClassificationAddDelete.
- Return type
-
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
-
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
-
property
flywheel.models.classification_replace module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.classification_replace.ClassificationReplace(modality=None, replace=None)¶ Bases:
object-
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
-
property
modality¶ Gets the modality of this ClassificationReplace.
The type of instrument that originated the file (e.g. MR, CT, …)
- Returns
The modality of this ClassificationReplace.
- Return type
str
-
property
replace¶ Gets the replace of this ClassificationReplace.
- Returns
The replace of this ClassificationReplace.
- Return type
object
-
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
-
flywheel.models.classification_update_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.classification_update_input.ClassificationUpdateInput(add=None, delete=None, modality=None, replace=None)¶ Bases:
object-
property
add¶ Gets the add of this ClassificationUpdateInput.
- Returns
The add of this ClassificationUpdateInput.
- Return type
-
property
delete¶ Gets the delete of this ClassificationUpdateInput.
- Returns
The delete of this ClassificationUpdateInput.
- Return type
-
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
-
property
modality¶ Gets the modality of this ClassificationUpdateInput.
The type of instrument that originated the file (e.g. MR, CT, …)
- Returns
The modality of this ClassificationUpdateInput.
- Return type
str
-
property
replace¶ Gets the replace of this ClassificationUpdateInput.
- Returns
The replace of this ClassificationUpdateInput.
- Return type
object
-
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
-
property
flywheel.models.cohort module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.collection module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.collection_container_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.collection_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.collection_input.CollectionInput(label=None, info=None, description=None)¶ Bases:
object-
property
description¶ Gets the description of this CollectionInput.
- Returns
The description of this CollectionInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this CollectionInput.
- Returns
The info of this CollectionInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this CollectionInput.
- Returns
The label of this CollectionInput.
- Return type
str
-
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
-
property
flywheel.models.collection_input_with_contents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.collection_input_with_contents.CollectionInputWithContents(contents=None, label=None, info=None, description=None)¶ Bases:
object-
property
contents¶ Gets the contents of this CollectionInputWithContents.
- Returns
The contents of this CollectionInputWithContents.
- Return type
-
property
description¶ Gets the description of this CollectionInputWithContents.
- Returns
The description of this CollectionInputWithContents.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this CollectionInputWithContents.
- Returns
The info of this CollectionInputWithContents.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this CollectionInputWithContents.
- Returns
The label of this CollectionInputWithContents.
- Return type
str
-
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
-
property
flywheel.models.collection_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.collection_node.CollectionNode(level=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this CollectionNode.
- Returns
The id of this CollectionNode.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
level¶ Gets the level of this CollectionNode.
- Returns
The level of this CollectionNode.
- Return type
-
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
-
flywheel.models.collection_node_level module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.collection_operation module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.collection_operation.CollectionOperation(operation=None, nodes=None)¶ Bases:
object-
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
-
property
nodes¶ Gets the nodes of this CollectionOperation.
- Returns
The nodes of this CollectionOperation.
- Return type
list[CollectionNode]
-
property
operation¶ Gets the operation of this CollectionOperation.
- Returns
The operation of this CollectionOperation.
- Return type
-
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
-
flywheel.models.collection_operation_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.collection_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.collection_output.CollectionOutput(created=None, modified=None, label=None, description=None, info=None, id=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)¶ Bases:
flywheel.models.mixins.CollectionMixin-
property
analyses¶ Gets the analyses of this CollectionOutput.
- Returns
The analyses of this CollectionOutput.
- Return type
list[Analysis]
-
property
attachment_count¶ Gets the attachment_count of this CollectionOutput.
- Returns
The attachment_count of this CollectionOutput.
- Return type
int
-
property
created¶ Gets the created of this CollectionOutput.
- Returns
The created of this CollectionOutput.
- Return type
datetime
-
property
curator¶ Gets the curator of this CollectionOutput.
- Returns
The curator of this CollectionOutput.
- Return type
str
-
property
description¶ Gets the description of this CollectionOutput.
- Returns
The description of this CollectionOutput.
- Return type
str
-
property
files¶ Gets the files of this CollectionOutput.
- Returns
The files of this CollectionOutput.
- Return type
list[FileOutput]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this CollectionOutput.
- Returns
The id of this CollectionOutput.
- Return type
str
-
property
info¶ Gets the info of this CollectionOutput.
- Returns
The info of this CollectionOutput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
property
join_origin¶ Gets the join_origin of this CollectionOutput.
- Returns
The join_origin of this CollectionOutput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this CollectionOutput.
- Returns
The label of this CollectionOutput.
- Return type
str
-
property
modified¶ Gets the modified of this CollectionOutput.
- Returns
The modified of this CollectionOutput.
- Return type
datetime
-
property
noncompliant_session_count¶ Gets the noncompliant_session_count of this CollectionOutput.
- Returns
The noncompliant_session_count of this CollectionOutput.
- Return type
int
-
property
notes¶ Gets the notes of this CollectionOutput.
- Returns
The notes of this CollectionOutput.
- Return type
list[Note]
-
property
permissions¶ Gets the permissions of this CollectionOutput.
- Returns
The permissions of this CollectionOutput.
- Return type
list[AccessPermission]
-
property
revision¶ Gets the revision of this CollectionOutput.
- Returns
The revision of this CollectionOutput.
- Return type
int
-
property
session_count¶ Gets the session_count of this CollectionOutput.
- Returns
The session_count of this CollectionOutput.
- Return type
int
-
property
subject_count¶ Gets the subject_count of this CollectionOutput.
- Returns
The subject_count of this CollectionOutput.
- Return type
int
Gets the tags of this CollectionOutput.
- Returns
The tags of this CollectionOutput.
- Return type
list[str]
-
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
-
property
flywheel.models.collection_with_stats module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.collection_with_stats.CollectionWithStats(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)¶ Bases:
flywheel.models.mixins.CollectionMixin-
property
analyses¶ Gets the analyses of this CollectionWithStats.
- Returns
The analyses of this CollectionWithStats.
- Return type
list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]
-
property
attachment_count¶ Gets the attachment_count of this CollectionWithStats.
- Returns
The attachment_count of this CollectionWithStats.
- Return type
int
-
property
created¶ Gets the created of this CollectionWithStats.
- Returns
The created of this CollectionWithStats.
- Return type
datetime
-
property
curator¶ Gets the curator of this CollectionWithStats.
- Returns
The curator of this CollectionWithStats.
- Return type
str
-
property
description¶ Gets the description of this CollectionWithStats.
- Returns
The description of this CollectionWithStats.
- Return type
str
-
property
files¶ Gets the files of this CollectionWithStats.
- Returns
The files of this CollectionWithStats.
- Return type
list[FileListOutput]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this CollectionWithStats.
- Returns
The id of this CollectionWithStats.
- Return type
str
-
property
info¶ Gets the info of this CollectionWithStats.
- Returns
The info of this CollectionWithStats.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
property
join_origin¶ Gets the join_origin of this CollectionWithStats.
- Returns
The join_origin of this CollectionWithStats.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this CollectionWithStats.
- Returns
The label of this CollectionWithStats.
- Return type
str
-
property
modified¶ Gets the modified of this CollectionWithStats.
- Returns
The modified of this CollectionWithStats.
- Return type
datetime
-
property
noncompliant_session_count¶ Gets the noncompliant_session_count of this CollectionWithStats.
- Returns
The noncompliant_session_count of this CollectionWithStats.
- Return type
int
-
property
notes¶ Gets the notes of this CollectionWithStats.
- Returns
The notes of this CollectionWithStats.
- Return type
list[Note]
-
property
permissions¶ Gets the permissions of this CollectionWithStats.
- Returns
The permissions of this CollectionWithStats.
- Return type
list[AccessPermission]
-
property
revision¶ Gets the revision of this CollectionWithStats.
- Returns
The revision of this CollectionWithStats.
- Return type
int
-
property
session_count¶ Gets the session_count of this CollectionWithStats.
- Returns
The session_count of this CollectionWithStats.
- Return type
int
-
property
subject_count¶ Gets the subject_count of this CollectionWithStats.
- Returns
The subject_count of this CollectionWithStats.
- Return type
int
Gets the tags of this CollectionWithStats.
- Returns
The tags of this CollectionWithStats.
- Return type
list[str]
-
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
-
property
flywheel.models.column module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.column.Column(src=None, dst=None, type=None, expr=None, accumulator=None)¶ Bases:
object-
property
accumulator¶ Gets the accumulator of this Column.
If a groupBy is selected, the column will be accumulated to a value using the specified method
- Returns
The accumulator of this Column.
- Return type
-
property
dst¶ Gets the dst of this Column.
- Returns
The dst of this Column.
- Return type
str
-
property
expr¶ Gets the expr of this Column.
- Returns
The expr of this Column.
- Return type
str
-
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
-
property
src¶ Gets the src of this Column.
- Returns
The src of this Column.
- Return type
str
-
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
-
property
flywheel.models.common_classification module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.common_classification.CommonClassification¶ Bases:
object-
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
-
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
-
flywheel.models.common_deleted_count module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.common_deleted_count.CommonDeletedCount(deleted=None)¶ Bases:
object-
property
deleted¶ Gets the deleted of this CommonDeletedCount.
- Returns
The deleted of this CommonDeletedCount.
- Return type
int
-
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
-
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
-
property
flywheel.models.common_editions module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.common_editions.CommonEditions(lab=None)¶ Bases:
object-
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
-
property
lab¶ Gets the lab of this CommonEditions.
- Returns
The lab of this CommonEditions.
- Return type
bool
-
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
-
flywheel.models.common_info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.common_info.CommonInfo¶ Bases:
object-
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
-
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
-
flywheel.models.common_join_origins module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.common_join_origins.CommonJoinOrigins(device=None, job=None, user=None)¶ Bases:
object-
property
device¶ Gets the device of this CommonJoinOrigins.
- Returns
The device of this CommonJoinOrigins.
- Return type
object
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this CommonJoinOrigins.
- Returns
The job of this CommonJoinOrigins.
- Return type
object
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
user¶ Gets the user of this CommonJoinOrigins.
- Returns
The user of this CommonJoinOrigins.
- Return type
object
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.common_key module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.common_key.CommonKey(key=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
key¶ Gets the key of this CommonKey.
- Returns
The key of this CommonKey.
- Return type
str
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.common_modified_count module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.common_modified_count.CommonModifiedCount(modified=None)¶ Bases:
object-
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
-
property
modified¶ Gets the modified of this CommonModifiedCount.
- Returns
The modified of this CommonModifiedCount.
- Return type
int
-
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
-
flywheel.models.common_object_created module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.common_object_created.CommonObjectCreated(id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this CommonObjectCreated.
- Returns
The id of this CommonObjectCreated.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.common_project_settings module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.common_project_settings.CommonProjectSettings(external_routing_id=None, forms=None, viewer_apps=None, deid_profile=None, sharing=None)¶ Bases:
object-
property
deid_profile¶ Gets the deid_profile of this CommonProjectSettings.
- Returns
The deid_profile of this CommonProjectSettings.
- Return type
object
-
property
external_routing_id¶ Gets the external_routing_id of this CommonProjectSettings.
- Returns
The external_routing_id of this CommonProjectSettings.
- Return type
object
-
property
forms¶ Gets the forms of this CommonProjectSettings.
- Returns
The forms of this CommonProjectSettings.
- Return type
object
-
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
-
property
sharing¶ Gets the sharing of this CommonProjectSettings.
- Returns
The sharing of this CommonProjectSettings.
- Return type
object
-
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
-
property
viewer_apps¶ Gets the viewer_apps of this CommonProjectSettings.
- Returns
The viewer_apps of this CommonProjectSettings.
- Return type
object
-
property
flywheel.models.common_settings module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.common_settings.CommonSettings(external_routing_id=None, forms=None, viewer_apps=None, deid_profile=None)¶ Bases:
object-
property
deid_profile¶ Gets the deid_profile of this CommonSettings.
- Returns
The deid_profile of this CommonSettings.
- Return type
object
-
property
external_routing_id¶ Gets the external_routing_id of this CommonSettings.
- Returns
The external_routing_id of this CommonSettings.
- Return type
object
-
property
forms¶ Gets the forms of this CommonSettings.
- Returns
The forms of this CommonSettings.
- Return type
object
-
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
-
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
-
property
viewer_apps¶ Gets the viewer_apps of this CommonSettings.
- Returns
The viewer_apps of this CommonSettings.
- Return type
object
-
property
flywheel.models.config_auth_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.config_auth_output.ConfigAuthOutput(verify_endpoint=None, client_id=None, client_secret=None, auth_endpoint=None, refresh_endpoint=None)¶ Bases:
object-
property
auth_endpoint¶ Gets the auth_endpoint of this ConfigAuthOutput.
- Returns
The auth_endpoint of this ConfigAuthOutput.
- Return type
str
-
property
client_id¶ Gets the client_id of this ConfigAuthOutput.
- Returns
The client_id of this ConfigAuthOutput.
- Return type
str
-
property
client_secret¶ Gets the client_secret of this ConfigAuthOutput.
- Returns
The client_secret of this ConfigAuthOutput.
- Return type
str
-
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
-
property
refresh_endpoint¶ Gets the refresh_endpoint of this ConfigAuthOutput.
- Returns
The refresh_endpoint of this ConfigAuthOutput.
- Return type
str
-
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
-
property
verify_endpoint¶ Gets the verify_endpoint of this ConfigAuthOutput.
- Returns
The verify_endpoint of this ConfigAuthOutput.
- Return type
str
-
property
flywheel.models.config_feature_map module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.config_feature_map.ConfigFeatureMap(signed_url=None, job_tickets=None, job_ask=None, multiproject=None, healthcare_api=None, crawler=None, task_manager_data_views=None)¶ Bases:
object-
property
crawler¶ Gets the crawler of this ConfigFeatureMap.
Whether or not this server uses crawler as the search driver
- Returns
The crawler of this ConfigFeatureMap.
- Return type
bool
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
healthcare_api¶ Gets the healthcare_api of this ConfigFeatureMap.
Google Healthcare API integration
- Returns
The healthcare_api of this ConfigFeatureMap.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
property
job_ask¶ Gets the job_ask of this ConfigFeatureMap.
Whether or not this server supports the /jobs/ask endpoint
- Returns
The job_ask of this ConfigFeatureMap.
- Return type
bool
-
property
job_tickets¶ Gets the job_tickets of this ConfigFeatureMap.
Whether or not this server supports new job tickets
- Returns
The job_tickets of this ConfigFeatureMap.
- Return type
bool
-
keys()¶ Returns the list of json properties in the object
-
property
multiproject¶ Gets the multiproject of this ConfigFeatureMap.
Whether or not this server has the multiproject feature enabled
- Returns
The multiproject of this ConfigFeatureMap.
- Return type
bool
-
property
signed_url¶ Gets the signed_url of this ConfigFeatureMap.
Whether or not this server supports signed url uploads
- Returns
The signed_url of this ConfigFeatureMap.
- Return type
bool
-
property
task_manager_data_views¶ Gets the task_manager_data_views of this ConfigFeatureMap.
Whether or not this server uses task manager for data views
- Returns
The task_manager_data_views of this ConfigFeatureMap.
- Return type
bool
-
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
-
property
flywheel.models.config_out module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.config_out.ConfigOut(last_updated=None, site=None, features=None, signed_url=False, auth=None, open_tracing=None, created=None, modified=None)¶ Bases:
object-
property
auth¶ Gets the auth of this ConfigOut.
- Returns
The auth of this ConfigOut.
- Return type
-
property
created¶ Gets the created of this ConfigOut.
- Returns
The created of this ConfigOut.
- Return type
datetime
-
property
features¶ Gets the features of this ConfigOut.
- Returns
The features of this ConfigOut.
- Return type
-
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
-
property
last_updated¶ Gets the last_updated of this ConfigOut.
- Returns
The last_updated of this ConfigOut.
- Return type
datetime
-
property
modified¶ Gets the modified of this ConfigOut.
- Returns
The modified of this ConfigOut.
- Return type
datetime
-
property
open_tracing¶ Gets the open_tracing of this ConfigOut.
- Returns
The open_tracing of this ConfigOut.
- Return type
-
property
signed_url¶ Gets the signed_url of this ConfigOut.
- Returns
The signed_url of this ConfigOut.
- Return type
bool
-
property
site¶ Gets the site of this ConfigOut.
- Returns
The site of this ConfigOut.
- Return type
-
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
-
property
flywheel.models.config_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.config_output.ConfigOutput(site=None, modified=None, auth=None, created=None, signed_url=None, features=None)¶ Bases:
object-
property
auth¶ Gets the auth of this ConfigOutput.
- Returns
The auth of this ConfigOutput.
- Return type
dict(str, ConfigAuthOutput)
-
property
created¶ Gets the created of this ConfigOutput.
- Returns
The created of this ConfigOutput.
- Return type
str
-
property
features¶ Gets the features of this ConfigOutput.
- Returns
The features of this ConfigOutput.
- Return type
-
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
-
property
modified¶ Gets the modified of this ConfigOutput.
- Returns
The modified of this ConfigOutput.
- Return type
str
-
property
signed_url¶ Gets the signed_url of this ConfigOutput.
Whether or not this server supports signed url uploads
- Returns
The signed_url of this ConfigOutput.
- Return type
bool
-
property
site¶ Gets the site of this ConfigOutput.
- Returns
The site of this ConfigOutput.
- Return type
-
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
-
property
flywheel.models.config_site_config_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.config_site_config_output.ConfigSiteConfigOutput(central_url=None, ssl_cert=None, api_url=None, registered=None, id=None, name=None)¶ Bases:
object-
property
api_url¶ Gets the api_url of this ConfigSiteConfigOutput.
- Returns
The api_url of this ConfigSiteConfigOutput.
- Return type
str
-
property
central_url¶ Gets the central_url of this ConfigSiteConfigOutput.
- Returns
The central_url of this ConfigSiteConfigOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ConfigSiteConfigOutput.
- Returns
The id of this ConfigSiteConfigOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
name¶ Gets the name of this ConfigSiteConfigOutput.
- Returns
The name of this ConfigSiteConfigOutput.
- Return type
str
-
property
registered¶ Gets the registered of this ConfigSiteConfigOutput.
- Returns
The registered of this ConfigSiteConfigOutput.
- Return type
bool
-
property
ssl_cert¶ Gets the ssl_cert of this ConfigSiteConfigOutput.
- Returns
The ssl_cert of this ConfigSiteConfigOutput.
- Return type
str
-
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
-
property
flywheel.models.config_site_settings module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.config_site_settings.ConfigSiteSettings(created=None, modified=None, center_gears=None, providers=None, viewer_apps=None, ldap_sync=None)¶ Bases:
object-
property
center_gears¶ Gets the center_gears of this ConfigSiteSettings.
A list of gear algorithm names that are treated as center-pays for the purpose of the billing report
- Returns
The center_gears of this ConfigSiteSettings.
- Return type
list[str]
-
property
created¶ Gets the created of this ConfigSiteSettings.
- Returns
The created of this ConfigSiteSettings.
- Return type
str
-
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
-
property
ldap_sync¶ Gets the ldap_sync of this ConfigSiteSettings.
- Returns
The ldap_sync of this ConfigSiteSettings.
- Return type
-
property
modified¶ Gets the modified of this ConfigSiteSettings.
- Returns
The modified of this ConfigSiteSettings.
- Return type
str
-
property
providers¶ Gets the providers of this ConfigSiteSettings.
- Returns
The providers of this ConfigSiteSettings.
- Return type
-
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
-
property
flywheel.models.config_site_settings_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.config_site_settings_input.ConfigSiteSettingsInput(center_gears=None, providers=None, viewer_apps=None, ldap_sync=None)¶ Bases:
object-
property
center_gears¶ Gets the center_gears of this ConfigSiteSettingsInput.
A list of gear algorithm names that are treated as center-pays for the purpose of the billing report
- Returns
The center_gears of this ConfigSiteSettingsInput.
- Return type
list[str]
-
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
-
property
ldap_sync¶ Gets the ldap_sync of this ConfigSiteSettingsInput.
- Returns
The ldap_sync of this ConfigSiteSettingsInput.
- Return type
-
property
providers¶ Gets the providers of this ConfigSiteSettingsInput.
- Returns
The providers of this ConfigSiteSettingsInput.
- Return type
-
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
-
property
flywheel.models.container_delete_reason module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_delete_reason.ContainerDeleteReason¶ Bases:
str,enum.EnumAn enumeration.
-
ANALYSIS_OR_PROCESSING_FAILED_OR_CANCELLED= 'analysis_or_processing_failed_or_cancelled'¶
-
COMPLIANCE_CONSENT_WITHDRAWN= 'compliance_consent_withdrawn'¶
-
COMPLIANCE_DATA_POLICY= 'compliance_data_policy'¶
-
COMPLIANCE_PHI= 'compliance_phi'¶
-
CONTAINER_IS_EMPTY= 'container_is_empty'¶
-
DATA_HAS_BEEN_EXPORTED_OR_MOVED= 'data_has_been_exported_or_moved'¶
-
DATA_INCOMPLETE_OR_CORRUPT= 'data_incomplete_or_corrupt'¶
-
DATA_IS_NOT_PART_OF_STUDY= 'data_is_not_part_of_study'¶
-
DATA_STRUCTURED_INCORRECTLY= 'data_structured_incorrectly'¶
-
DUPLICATE_DATA= 'duplicate_data'¶
-
PACKFILE_CLEANUP= 'packfile_cleanup'¶
-
TEST_DATA= 'test_data'¶
-
flywheel.models.container_id_view_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_id_view_input.ContainerIdViewInput(parent=None, label=None, description=None, columns=None, file_spec=None, filter=None, group_by=None, include_ids=True, include_labels=True, error_column=None, missing_data_strategy=None, sort=False, id=None, origin=None)¶ Bases:
object-
property
columns¶ Gets the columns of this ContainerIdViewInput.
- Returns
The columns of this ContainerIdViewInput.
- Return type
list[Column]
-
property
description¶ Gets the description of this ContainerIdViewInput.
- Returns
The description of this ContainerIdViewInput.
- Return type
str
-
property
error_column¶ Gets the error_column of this ContainerIdViewInput.
- Returns
The error_column of this ContainerIdViewInput.
- Return type
bool
-
property
file_spec¶ Gets the file_spec of this ContainerIdViewInput.
- Returns
The file_spec of this ContainerIdViewInput.
- Return type
object
-
property
filter¶ Gets the filter of this ContainerIdViewInput.
- Returns
The filter of this ContainerIdViewInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group_by¶ Gets the group_by of this ContainerIdViewInput.
- Returns
The group_by of this ContainerIdViewInput.
- Return type
-
property
id¶ Gets the id of this ContainerIdViewInput.
- Returns
The id of this ContainerIdViewInput.
- Return type
str
-
property
include_ids¶ Gets the include_ids of this ContainerIdViewInput.
- Returns
The include_ids of this ContainerIdViewInput.
- Return type
bool
-
property
include_labels¶ Gets the include_labels of this ContainerIdViewInput.
- Returns
The include_labels of this ContainerIdViewInput.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ContainerIdViewInput.
- Returns
The label of this ContainerIdViewInput.
- Return type
str
-
property
missing_data_strategy¶ Gets the missing_data_strategy of this ContainerIdViewInput.
- Returns
The missing_data_strategy of this ContainerIdViewInput.
- Return type
-
property
origin¶ Gets the origin of this ContainerIdViewInput.
- Returns
The origin of this ContainerIdViewInput.
- Return type
-
property
parent¶ Gets the parent of this ContainerIdViewInput.
- Returns
The parent of this ContainerIdViewInput.
- Return type
str
-
property
sort¶ Gets the sort of this ContainerIdViewInput.
- Returns
The sort of this ContainerIdViewInput.
- Return type
bool
-
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
-
property
flywheel.models.container_new_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_new_output.ContainerNewOutput(id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ContainerNewOutput.
Unique database ID
- Returns
The id of this ContainerNewOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.container_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_output.ContainerOutput(container_type=None)¶ Bases:
object-
property
container_type¶ Gets the container_type of this ContainerOutput.
- Returns
The container_type of this ContainerOutput.
- Return type
str
-
discriminator_value_class_map= {}¶
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
get_real_child_model(data)¶ Returns the real base class specified by the discriminator
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.container_output_with_files module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_output_with_files.ContainerOutputWithFiles(id=None, label=None, files=None, created=None, modified=None)¶ Bases:
object-
property
created¶ Gets the created of this ContainerOutputWithFiles.
Creation time (automatically set)
- Returns
The created of this ContainerOutputWithFiles.
- Return type
datetime
-
property
files¶ Gets the files of this ContainerOutputWithFiles.
- Returns
The files of this ContainerOutputWithFiles.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ContainerOutputWithFiles.
Unique database ID
- Returns
The id of this ContainerOutputWithFiles.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ContainerOutputWithFiles.
Application-specific label
- Returns
The label of this ContainerOutputWithFiles.
- Return type
str
-
property
modified¶ Gets the modified of this ContainerOutputWithFiles.
Last modification time (automatically updated)
- Returns
The modified of this ContainerOutputWithFiles.
- Return type
datetime
-
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
-
property
flywheel.models.container_parents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_parents.ContainerParents(analysis=None, acquisition=None, session=None, subject=None, project=None, group=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this ContainerParents.
Unique database ID
- Returns
The acquisition of this ContainerParents.
- Return type
str
-
property
analysis¶ Gets the analysis of this ContainerParents.
Unique database ID
- Returns
The analysis of this ContainerParents.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ContainerParents.
Unique database ID
- Returns
The group of this ContainerParents.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this ContainerParents.
Unique database ID
- Returns
The project of this ContainerParents.
- Return type
str
-
property
session¶ Gets the session of this ContainerParents.
Unique database ID
- Returns
The session of this ContainerParents.
- Return type
str
-
property
subject¶ Gets the subject of this ContainerParents.
Unique database ID
- Returns
The subject of this ContainerParents.
- Return type
str
-
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
-
property
flywheel.models.container_project_parents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_project_parents.ContainerProjectParents(group=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ContainerProjectParents.
Unique database ID
- Returns
The group of this ContainerProjectParents.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.container_reference module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_reference.ContainerReference(type=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ContainerReference.
Unique database ID
- Returns
The id of this ContainerReference.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this ContainerReference.
The type of container (e.g. session)
- Returns
The type of this ContainerReference.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.container_reference_with_label module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_reference_with_label.ContainerReferenceWithLabel(id=None, cont_type=None, label=None)¶ Bases:
object-
property
cont_type¶ Gets the cont_type of this ContainerReferenceWithLabel.
- Returns
The cont_type of this ContainerReferenceWithLabel.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ContainerReferenceWithLabel.
- Returns
The id of this ContainerReferenceWithLabel.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ContainerReferenceWithLabel.
- Returns
The label of this ContainerReferenceWithLabel.
- Return type
str
-
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
-
property
flywheel.models.container_session_parents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_session_parents.ContainerSessionParents(project=None, group=None, subject=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ContainerSessionParents.
Unique database ID
- Returns
The group of this ContainerSessionParents.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this ContainerSessionParents.
Unique database ID
- Returns
The project of this ContainerSessionParents.
- Return type
str
-
property
subject¶ Gets the subject of this ContainerSessionParents.
Unique database ID
- Returns
The subject of this ContainerSessionParents.
- Return type
str
-
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
-
flywheel.models.container_subject_parents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_subject_parents.ContainerSubjectParents(project=None, group=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ContainerSubjectParents.
Unique database ID
- Returns
The group of this ContainerSubjectParents.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this ContainerSubjectParents.
Unique database ID
- Returns
The project of this ContainerSubjectParents.
- Return type
str
-
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
-
flywheel.models.container_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_type.ContainerType¶ Bases:
str,enum.EnumAn enumeration.
-
ACQUISITION= 'acquisition'¶
-
ANALYSIS= 'analysis'¶
-
COLLECTION= 'collection'¶
-
FILE= 'file'¶
-
GROUP= 'group'¶
-
PROJECT= 'project'¶
-
READER_TASK= 'reader_task'¶
-
SESSION= 'session'¶
-
SUBJECT= 'subject'¶
-
USER= 'user'¶
-
WORKSPACE= 'workspace'¶
-
flywheel.models.container_uidcheck module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_uidcheck.ContainerUidcheck(sessions=None, acquisitions=None, project_id=None, project_ids=None)¶ Bases:
object-
property
acquisitions¶ Gets the acquisitions of this ContainerUidcheck.
A list of UIDs
- Returns
The acquisitions of this ContainerUidcheck.
- Return type
list[str]
-
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
-
property
project_id¶ Gets the project_id of this ContainerUidcheck.
Unique database ID
- Returns
The project_id of this ContainerUidcheck.
- Return type
str
-
property
project_ids¶ Gets the project_ids of this ContainerUidcheck.
A list of Project IDs
- Returns
The project_ids of this ContainerUidcheck.
- Return type
list[str]
-
property
sessions¶ Gets the sessions of this ContainerUidcheck.
A list of UIDs
- Returns
The sessions of this ContainerUidcheck.
- Return type
list[str]
-
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
-
property
flywheel.models.container_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_update.ContainerUpdate¶ Bases:
object-
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
-
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
-
flywheel.models.context_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.context_input.ContextInput(found=None, value=None, base=None)¶ Bases:
object-
property
base¶ Gets the base of this ContextInput.
- Returns
The base of this ContextInput.
- Return type
str
-
property
found¶ Gets the found of this ContextInput.
- Returns
The found of this ContextInput.
- Return type
bool
-
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
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
value¶ Gets the value of this ContextInput.
- Returns
The value of this ContextInput.
- Return type
object
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.core_models_api_key_api_key_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.core_models_api_key_api_key_input.CoreModelsApiKeyApiKeyInput(label=None)¶ Bases:
object-
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
-
property
label¶ Gets the label of this CoreModelsApiKeyApiKeyInput.
- Returns
The label of this CoreModelsApiKeyApiKeyInput.
- Return type
str
-
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
-
flywheel.models.core_models_jobs_api_key_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.core_models_jobs_api_key_input.CoreModelsJobsApiKeyInput(base=None, key=None)¶ Bases:
object-
property
base¶ Gets the base of this CoreModelsJobsApiKeyInput.
- Returns
The base of this CoreModelsJobsApiKeyInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
key¶ Gets the key of this CoreModelsJobsApiKeyInput.
- Returns
The key of this CoreModelsJobsApiKeyInput.
- Return type
str
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.create_report_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.create_report_input.CreateReportInput(project_id=None, subject_ids=None, label=None, status=None, created=None)¶ Bases:
object-
property
created¶ Gets the created of this CreateReportInput.
- Returns
The created of this CreateReportInput.
- Return type
datetime
-
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
-
property
label¶ Gets the label of this CreateReportInput.
- Returns
The label of this CreateReportInput.
- Return type
str
-
property
project_id¶ Gets the project_id of this CreateReportInput.
- Returns
The project_id of this CreateReportInput.
- Return type
str
-
property
status¶ Gets the status of this CreateReportInput.
- Returns
The status of this CreateReportInput.
- Return type
-
property
subject_ids¶ Gets the subject_ids of this CreateReportInput.
- Returns
The subject_ids of this CreateReportInput.
- Return type
list[str]
-
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
-
property
flywheel.models.creds module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.creds.Creds¶ Bases:
object-
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
-
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
-
flywheel.models.current_user_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.current_user_output.CurrentUserOutput(id=None, user_id=None, firstname=None, lastname=None, email=None, auth0sub=None, roles=None, root=False, api_key=None, api_keys=None, avatar=None, avatars=None, disabled=None, preferences=None, created=None, modified=None, multifactor=None, info=None, firstlogin=None, lastlogin=None, visited_projects=None)¶ Bases:
object-
property
api_key¶ Gets the api_key of this CurrentUserOutput.
- Returns
The api_key of this CurrentUserOutput.
- Return type
-
property
api_keys¶ Gets the api_keys of this CurrentUserOutput.
- Returns
The api_keys of this CurrentUserOutput.
- Return type
list[ApiKeyOutput]
-
property
auth0sub¶ Gets the auth0sub of this CurrentUserOutput.
- Returns
The auth0sub of this CurrentUserOutput.
- Return type
str
-
property
avatar¶ Gets the avatar of this CurrentUserOutput.
- Returns
The avatar of this CurrentUserOutput.
- Return type
str
-
property
avatars¶ Gets the avatars of this CurrentUserOutput.
- Returns
The avatars of this CurrentUserOutput.
- Return type
-
property
created¶ Gets the created of this CurrentUserOutput.
- Returns
The created of this CurrentUserOutput.
- Return type
datetime
-
property
disabled¶ Gets the disabled of this CurrentUserOutput.
- Returns
The disabled of this CurrentUserOutput.
- Return type
bool
-
property
email¶ Gets the email of this CurrentUserOutput.
- Returns
The email of this CurrentUserOutput.
- Return type
str
-
property
firstlogin¶ Gets the firstlogin of this CurrentUserOutput.
- Returns
The firstlogin of this CurrentUserOutput.
- Return type
str
-
property
firstname¶ Gets the firstname of this CurrentUserOutput.
- Returns
The firstname of this CurrentUserOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this CurrentUserOutput.
- Returns
The id of this CurrentUserOutput.
- Return type
str
-
property
info¶ Gets the info of this CurrentUserOutput.
- Returns
The info of this CurrentUserOutput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
lastlogin¶ Gets the lastlogin of this CurrentUserOutput.
- Returns
The lastlogin of this CurrentUserOutput.
- Return type
str
-
property
lastname¶ Gets the lastname of this CurrentUserOutput.
- Returns
The lastname of this CurrentUserOutput.
- Return type
str
-
property
modified¶ Gets the modified of this CurrentUserOutput.
- Returns
The modified of this CurrentUserOutput.
- Return type
datetime
-
property
multifactor¶ Gets the multifactor of this CurrentUserOutput.
- Returns
The multifactor of this CurrentUserOutput.
- Return type
-
property
preferences¶ Gets the preferences of this CurrentUserOutput.
- Returns
The preferences of this CurrentUserOutput.
- Return type
-
property
roles¶ Gets the roles of this CurrentUserOutput.
- Returns
The roles of this CurrentUserOutput.
- Return type
list[str]
-
property
root¶ Gets the root of this CurrentUserOutput.
- Returns
The root of this CurrentUserOutput.
- Return type
bool
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
user_id¶ Gets the user_id of this CurrentUserOutput.
- Returns
The user_id of this CurrentUserOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
visited_projects¶ Gets the visited_projects of this CurrentUserOutput.
- Returns
The visited_projects of this CurrentUserOutput.
- Return type
list[str]
-
property
flywheel.models.data_strategy module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.data_view module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view.DataView(parent=None, label=None, description=None, columns=None, group_by=None, filter=None, file_spec=None, include_ids=None, include_labels=None, error_column=None, missing_data_strategy=None, sort=None, id=None, origin=None)¶ Bases:
object-
property
columns¶ Gets the columns of this DataView.
- Returns
The columns of this DataView.
- Return type
list[DataViewColumnSpec]
-
property
description¶ Gets the description of this DataView.
- Returns
The description of this DataView.
- Return type
str
-
property
error_column¶ Gets the error_column of this DataView.
Whether or not to include errors column. Default is true
- Returns
The error_column of this DataView.
- Return type
bool
-
property
file_spec¶ Gets the file_spec of this DataView.
- Returns
The file_spec of this DataView.
- Return type
-
property
filter¶ Gets the filter of this DataView.
An optional row filter
- Returns
The filter of this DataView.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group_by¶ Gets the group_by of this DataView.
- Returns
The group_by of this DataView.
- Return type
-
property
id¶ Gets the id of this DataView.
Unique database ID
- Returns
The id of this DataView.
- Return type
str
-
property
include_ids¶ Gets the include_ids of this DataView.
Whether or not to include container id fields. Default is true
- Returns
The include_ids of this DataView.
- Return type
bool
-
property
include_labels¶ Gets the include_labels of this DataView.
Whether or not to include container label fields. Default is true
- Returns
The include_labels of this DataView.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this DataView.
Application-specific label
- Returns
The label of this DataView.
- Return type
str
-
property
missing_data_strategy¶ Gets the missing_data_strategy of this DataView.
The resolution strategy if rows are missing data for a column. The default is to replace the column value with None. This value can be one of: none, drop-row.
- Returns
The missing_data_strategy of this DataView.
- Return type
str
-
property
origin¶ Gets the origin of this DataView.
- Returns
The origin of this DataView.
- Return type
-
property
parent¶ Gets the parent of this DataView.
The parent container id
- Returns
The parent of this DataView.
- Return type
str
-
property
sort¶ Gets the sort of this DataView.
Opt out of sorting results by setting value to false
- Returns
The sort of this DataView.
- Return type
bool
-
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
-
property
flywheel.models.data_view_analysis_filter_spec module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view_analysis_filter_spec.DataViewAnalysisFilterSpec(label=None, gear_name=None, gear_version=None)¶ Bases:
object-
property
gear_name¶ Gets the gear_name of this DataViewAnalysisFilterSpec.
- Returns
The gear_name of this DataViewAnalysisFilterSpec.
- Return type
-
property
gear_version¶ Gets the gear_version of this DataViewAnalysisFilterSpec.
- Returns
The gear_version of this DataViewAnalysisFilterSpec.
- Return type
-
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
-
property
label¶ Gets the label of this DataViewAnalysisFilterSpec.
- Returns
The label of this DataViewAnalysisFilterSpec.
- Return type
-
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
-
property
flywheel.models.data_view_column_alias module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view_column_alias.DataViewColumnAlias(name=None, src=None, group=None, description=None, type=None)¶ Bases:
object-
property
description¶ Gets the description of this DataViewColumnAlias.
A description of this field
- Returns
The description of this DataViewColumnAlias.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this DataViewColumnAlias.
The list of columns that belong to this group
- Returns
The group of this DataViewColumnAlias.
- Return type
list[str]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
name¶ Gets the name of this DataViewColumnAlias.
The column alias name
- Returns
The name of this DataViewColumnAlias.
- Return type
str
-
property
src¶ Gets the src of this DataViewColumnAlias.
The source for this column’s data
- Returns
The src of this DataViewColumnAlias.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this DataViewColumnAlias.
The type that this value should be translated to (for typed output)
- Returns
The type of this DataViewColumnAlias.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.data_view_column_spec module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view_column_spec.DataViewColumnSpec(src=None, dst=None, type=None, expr=None, accumulator=None)¶ Bases:
object-
property
accumulator¶ Gets the accumulator of this DataViewColumnSpec.
Accumulation operator for an a group by aggregation
- Returns
The accumulator of this DataViewColumnSpec.
- Return type
str
-
property
dst¶ Gets the dst of this DataViewColumnSpec.
The optional destination property name
- Returns
The dst of this DataViewColumnSpec.
- Return type
str
-
property
expr¶ Gets the expr of this DataViewColumnSpec.
An optional expression, allowing simple calculations (add, subtract, multiply, divide). Use ‘x’ to substitute the column
- Returns
The expr of this DataViewColumnSpec.
- Return type
str
-
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
-
property
src¶ Gets the src of this DataViewColumnSpec.
The source property in the format of {container}.{field}
- Returns
The src of this DataViewColumnSpec.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this DataViewColumnSpec.
The type that this value should be translated to (for typed output)
- Returns
The type of this DataViewColumnSpec.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.data_view_execution module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view_execution.DataViewExecution(id=None, created=None, modified=None, timestamp_ran=None, user_id=None, project_id=None, state=None, data_view_id=None, storage_file_id=None, task_id=None, expires_on=None, revision=None)¶ Bases:
object-
property
created¶ Gets the created of this DataViewExecution.
Creation time (automatically set)
- Returns
The created of this DataViewExecution.
- Return type
datetime
-
property
data_view_id¶ Gets the data_view_id of this DataViewExecution.
Unique database ID
- Returns
The data_view_id of this DataViewExecution.
- Return type
str
-
property
expires_on¶ Gets the expires_on of this DataViewExecution.
- Returns
The expires_on of this DataViewExecution.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this DataViewExecution.
Unique database ID
- Returns
The id of this DataViewExecution.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
modified¶ Gets the modified of this DataViewExecution.
Last modification time (automatically updated)
- Returns
The modified of this DataViewExecution.
- Return type
datetime
-
property
project_id¶ Gets the project_id of this DataViewExecution.
Unique database ID
- Returns
The project_id of this DataViewExecution.
- Return type
str
-
property
revision¶ Gets the revision of this DataViewExecution.
An incremental document revision number
- Returns
The revision of this DataViewExecution.
- Return type
int
-
property
state¶ Gets the state of this DataViewExecution.
The expected data file format, default is auto-detect
- Returns
The state of this DataViewExecution.
- Return type
str
-
property
storage_file_id¶ Gets the storage_file_id of this DataViewExecution.
Unique database ID
- Returns
The storage_file_id of this DataViewExecution.
- Return type
str
-
property
task_id¶ Gets the task_id of this DataViewExecution.
Hyphen-separated universally unique identifier
- Returns
The task_id of this DataViewExecution.
- Return type
str
-
property
timestamp_ran¶ Gets the timestamp_ran of this DataViewExecution.
- Returns
The timestamp_ran of this DataViewExecution.
- Return type
datetime
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
user_id¶ Gets the user_id of this DataViewExecution.
Database ID of a user
- Returns
The user_id of this DataViewExecution.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.data_view_execution_state module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.data_view_file_spec module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view_file_spec.DataViewFileSpec(container=None, analysis_filter=None, filter=None, zip_member=None, match=None, format=None, format_options=None, process_files=None, columns=None)¶ Bases:
object-
property
analysis_filter¶ Gets the analysis_filter of this DataViewFileSpec.
- Returns
The analysis_filter of this DataViewFileSpec.
- Return type
-
property
columns¶ Gets the columns of this DataViewFileSpec.
- Returns
The columns of this DataViewFileSpec.
- Return type
list[DataViewColumnSpec]
-
property
container¶ Gets the container of this DataViewFileSpec.
The type of container (e.g. session)
- Returns
The container of this DataViewFileSpec.
- Return type
str
-
property
filter¶ Gets the filter of this DataViewFileSpec.
- Returns
The filter of this DataViewFileSpec.
- Return type
-
property
format¶ Gets the format of this DataViewFileSpec.
The expected data file format, default is auto-detect
- Returns
The format of this DataViewFileSpec.
- Return type
str
-
property
format_options¶ Gets the format_options of this DataViewFileSpec.
- Returns
The format_options of this DataViewFileSpec.
- Return type
object
-
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
-
property
match¶ Gets the match of this DataViewFileSpec.
If multiple file matches are encountered, which file to choose. Default is first
- Returns
The match of this DataViewFileSpec.
- Return type
str
-
property
process_files¶ Gets the process_files of this DataViewFileSpec.
Set to false to skip file reading, and return file attributes instead
- Returns
The process_files of this DataViewFileSpec.
- Return type
bool
-
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
-
property
zip_member¶ Gets the zip_member of this DataViewFileSpec.
- Returns
The zip_member of this DataViewFileSpec.
- Return type
-
property
flywheel.models.data_view_group_by module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view_group_by.DataViewGroupBy(columns=None)¶ Bases:
object-
property
columns¶ Gets the columns of this DataViewGroupBy.
- Returns
The columns of this DataViewGroupBy.
- Return type
list[DataViewGroupByColumn]
-
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
-
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
-
property
flywheel.models.data_view_group_by_column module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view_group_by_column.DataViewGroupByColumn(src=None, dst=None)¶ Bases:
object-
property
dst¶ Gets the dst of this DataViewGroupByColumn.
The optional destination property name
- Returns
The dst of this DataViewGroupByColumn.
- Return type
str
-
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
-
property
src¶ Gets the src of this DataViewGroupByColumn.
The source property in the format of {container}.{field}
- Returns
The src of this DataViewGroupByColumn.
- Return type
str
-
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
-
property
flywheel.models.data_view_name_filter_spec module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view_name_filter_spec.DataViewNameFilterSpec(value=None, regex=None)¶ Bases:
object-
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
-
property
regex¶ Gets the regex of this DataViewNameFilterSpec.
Whether or not this filter is a pattern or regular expression match
- Returns
The regex of this DataViewNameFilterSpec.
- Return type
bool
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
value¶ Gets the value of this DataViewNameFilterSpec.
The pattern or regular expression to match
- Returns
The value of this DataViewNameFilterSpec.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.data_view_save_data_view_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view_save_data_view_input.DataViewSaveDataViewInput(view=None, view_id=None, container_type=None, container_id=None, filename=None, description=None)¶ Bases:
object-
property
container_id¶ Gets the container_id of this DataViewSaveDataViewInput.
Unique database ID
- Returns
The container_id of this DataViewSaveDataViewInput.
- Return type
str
-
property
container_type¶ Gets the container_type of this DataViewSaveDataViewInput.
The type of container (e.g. session)
- Returns
The container_type of this DataViewSaveDataViewInput.
- Return type
str
-
property
description¶ Gets the description of this DataViewSaveDataViewInput.
- Returns
The description of this DataViewSaveDataViewInput.
- Return type
str
-
property
filename¶ Gets the filename of this DataViewSaveDataViewInput.
The name of the file on disk
- Returns
The filename of this DataViewSaveDataViewInput.
- Return type
str
-
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
-
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
-
property
view¶ Gets the view of this DataViewSaveDataViewInput.
- Returns
The view of this DataViewSaveDataViewInput.
- Return type
-
property
view_id¶ Gets the view_id of this DataViewSaveDataViewInput.
Unique database ID
- Returns
The view_id of this DataViewSaveDataViewInput.
- Return type
str
-
property
flywheel.models.data_view_zip_filter_spec module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view_zip_filter_spec.DataViewZipFilterSpec(value=None, regex=None, match=None)¶ Bases:
object-
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
-
property
match¶ Gets the match of this DataViewZipFilterSpec.
If multiple file matches are encountered, which file to choose. Default is first
- Returns
The match of this DataViewZipFilterSpec.
- Return type
str
-
property
regex¶ Gets the regex of this DataViewZipFilterSpec.
Whether or not this filter is a pattern or regular expression match
- Returns
The regex of this DataViewZipFilterSpec.
- Return type
bool
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
value¶ Gets the value of this DataViewZipFilterSpec.
The pattern or regular expression to match
- Returns
The value of this DataViewZipFilterSpec.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.default_flywheel_role module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.deid_log_skip_reason module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.deleted_file module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.deleted_file.DeletedFile(id=None, origin=None, parent_ref=None, name=None, provider_id=None, uuid=None, size=None, copy_of=None, created=None, deleted=None, replaced=None, hard_deleted=None)¶ Bases:
object-
property
copy_of¶ Gets the copy_of of this DeletedFile.
- Returns
The copy_of of this DeletedFile.
- Return type
-
property
created¶ Gets the created of this DeletedFile.
- Returns
The created of this DeletedFile.
- Return type
datetime
-
property
deleted¶ Gets the deleted of this DeletedFile.
- Returns
The deleted of this DeletedFile.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
hard_deleted¶ Gets the hard_deleted of this DeletedFile.
- Returns
The hard_deleted of this DeletedFile.
- Return type
datetime
-
property
id¶ Gets the id of this DeletedFile.
- Returns
The id of this DeletedFile.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
name¶ Gets the name of this DeletedFile.
- Returns
The name of this DeletedFile.
- Return type
str
-
property
origin¶ Gets the origin of this DeletedFile.
- Returns
The origin of this DeletedFile.
- Return type
-
property
parent_ref¶ Gets the parent_ref of this DeletedFile.
- Returns
The parent_ref of this DeletedFile.
- Return type
-
property
provider_id¶ Gets the provider_id of this DeletedFile.
- Returns
The provider_id of this DeletedFile.
- Return type
str
-
property
replaced¶ Gets the replaced of this DeletedFile.
- Returns
The replaced of this DeletedFile.
- Return type
datetime
-
property
size¶ Gets the size of this DeletedFile.
- Returns
The size of this DeletedFile.
- Return type
int
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uuid¶ Gets the uuid of this DeletedFile.
- Returns
The uuid of this DeletedFile.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.deleted_result module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.deleted_result.DeletedResult(deleted=None)¶ Bases:
object-
property
deleted¶ Gets the deleted of this DeletedResult.
- Returns
The deleted of this DeletedResult.
- Return type
int
-
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
-
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
-
property
flywheel.models.deprecated_action module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.device module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.device.Device(id=None, label=None, type=None, version=None, name=None, key=None, errors=None, info=None, interval=None, last_seen=None, disabled=None, storage_config=None)¶ Bases:
object-
property
disabled¶ Gets the disabled of this Device.
- Returns
The disabled of this Device.
- Return type
bool
-
property
errors¶ Gets the errors of this Device.
- Returns
The errors of this Device.
- Return type
list[str]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this Device.
Unique database ID
- Returns
The id of this Device.
- Return type
str
-
property
info¶ Gets the info of this Device.
- Returns
The info of this Device.
- Return type
-
property
interval¶ Gets the interval of this Device.
- Returns
The interval of this Device.
- Return type
int
-
items()¶ Returns the list of json property to value mapping
-
property
key¶ Gets the key of this Device.
- Returns
The key of this Device.
- Return type
str
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this Device.
- Returns
The label of this Device.
- Return type
str
-
property
last_seen¶ Gets the last_seen of this Device.
- Returns
The last_seen of this Device.
- Return type
datetime
-
property
name¶ Gets the name of this Device.
- Returns
The name of this Device.
- Return type
str
-
property
storage_config¶ Gets the storage_config of this Device.
- Returns
The storage_config of this Device.
- Return type
object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this Device.
- Returns
The type of this Device.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this Device.
- Returns
The version of this Device.
- Return type
str
-
property
flywheel.models.device_admin_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.device_admin_update.DeviceAdminUpdate(disabled=None, storage_config=None)¶ Bases:
object-
property
disabled¶ Gets the disabled of this DeviceAdminUpdate.
- Returns
The disabled of this DeviceAdminUpdate.
- Return type
bool
-
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
-
property
storage_config¶ Gets the storage_config of this DeviceAdminUpdate.
- Returns
The storage_config of this DeviceAdminUpdate.
- Return type
-
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
-
property
flywheel.models.device_create module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.device_create.DeviceCreate(label=None, type=None, storage_config=None)¶ Bases:
object-
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
-
property
label¶ Gets the label of this DeviceCreate.
- Returns
The label of this DeviceCreate.
- Return type
str
-
property
storage_config¶ Gets the storage_config of this DeviceCreate.
- Returns
The storage_config of this DeviceCreate.
- Return type
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this DeviceCreate.
- Returns
The type of this DeviceCreate.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.device_self_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.device_self_update.DeviceSelfUpdate(type=None, version=None, interval=None, errors=None, info=None)¶ Bases:
object-
property
errors¶ Gets the errors of this DeviceSelfUpdate.
- Returns
The errors of this DeviceSelfUpdate.
- Return type
list[str]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this DeviceSelfUpdate.
- Returns
The info of this DeviceSelfUpdate.
- Return type
object
-
property
interval¶ Gets the interval of this DeviceSelfUpdate.
- Returns
The interval of this DeviceSelfUpdate.
- Return type
int
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this DeviceSelfUpdate.
- Returns
The type of this DeviceSelfUpdate.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this DeviceSelfUpdate.
- Returns
The version of this DeviceSelfUpdate.
- Return type
str
-
property
flywheel.models.device_status_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.device_status_entry.DeviceStatusEntry(errors=None, last_seen=None, status=None)¶ Bases:
object-
property
errors¶ Gets the errors of this DeviceStatusEntry.
- Returns
The errors of this DeviceStatusEntry.
- Return type
list[str]
-
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
-
property
last_seen¶ Gets the last_seen of this DeviceStatusEntry.
- Returns
The last_seen of this DeviceStatusEntry.
- Return type
datetime
-
property
status¶ Gets the status of this DeviceStatusEntry.
- Returns
The status of this DeviceStatusEntry.
- Return type
-
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
-
property
flywheel.models.device_storage_strategy_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.device_storage_strategy_update.DeviceStorageStrategyUpdate(storage_strategy=None, provider=None)¶ Bases:
object-
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
-
property
provider¶ Gets the provider of this DeviceStorageStrategyUpdate.
- Returns
The provider of this DeviceStorageStrategyUpdate.
- Return type
str
-
property
storage_strategy¶ Gets the storage_strategy of this DeviceStorageStrategyUpdate.
- Returns
The storage_strategy of this DeviceStorageStrategyUpdate.
- Return type
-
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
-
flywheel.models.dimse_project_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.dimse_project_input.DimseProjectInput(aet=None, project_id=None)¶ Bases:
object-
property
aet¶ Gets the aet of this DimseProjectInput.
DICOM Application Entity Title
- Returns
The aet of this DimseProjectInput.
- Return type
str
-
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
-
property
project_id¶ Gets the project_id of this DimseProjectInput.
Unique database ID
- Returns
The project_id of this DimseProjectInput.
- Return type
str
-
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
-
property
flywheel.models.dimse_project_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.dimse_project_output.DimseProjectOutput(id=None, created=None, creator=None, aet=None, project_id=None, host=None, port=None)¶ Bases:
object-
property
aet¶ Gets the aet of this DimseProjectOutput.
DICOM Application Entity Title
- Returns
The aet of this DimseProjectOutput.
- Return type
str
-
property
created¶ Gets the created of this DimseProjectOutput.
- Returns
The created of this DimseProjectOutput.
- Return type
datetime
-
property
creator¶ Gets the creator of this DimseProjectOutput.
Database ID of a user
- Returns
The creator of this DimseProjectOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
host¶ Gets the host of this DimseProjectOutput.
DICOM service hostname or IP
- Returns
The host of this DimseProjectOutput.
- Return type
str
-
property
id¶ Gets the id of this DimseProjectOutput.
Unique database ID
- Returns
The id of this DimseProjectOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
port¶ Gets the port of this DimseProjectOutput.
DICOM service port number
- Returns
The port of this DimseProjectOutput.
- Return type
int
-
property
project_id¶ Gets the project_id of this DimseProjectOutput.
Unique database ID
- Returns
The project_id of this DimseProjectOutput.
- Return type
str
-
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
-
property
flywheel.models.dimse_service_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.dimse_service_input.DimseServiceInput(aet=None, host=None, port=None)¶ Bases:
object-
property
aet¶ Gets the aet of this DimseServiceInput.
DICOM Application Entity Title
- Returns
The aet of this DimseServiceInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
host¶ Gets the host of this DimseServiceInput.
DICOM service hostname or IP
- Returns
The host of this DimseServiceInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
port¶ Gets the port of this DimseServiceInput.
DICOM service port number
- Returns
The port of this DimseServiceInput.
- Return type
int
-
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
-
property
flywheel.models.dimse_service_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.dimse_service_output.DimseServiceOutput(id=None, created=None, creator=None, aet=None, host=None, port=None)¶ Bases:
object-
property
aet¶ Gets the aet of this DimseServiceOutput.
DICOM Application Entity Title
- Returns
The aet of this DimseServiceOutput.
- Return type
str
-
property
created¶ Gets the created of this DimseServiceOutput.
- Returns
The created of this DimseServiceOutput.
- Return type
datetime
-
property
creator¶ Gets the creator of this DimseServiceOutput.
Database ID of a user
- Returns
The creator of this DimseServiceOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
host¶ Gets the host of this DimseServiceOutput.
DICOM service hostname or IP
- Returns
The host of this DimseServiceOutput.
- Return type
str
-
property
id¶ Gets the id of this DimseServiceOutput.
Unique database ID
- Returns
The id of this DimseServiceOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
port¶ Gets the port of this DimseServiceOutput.
DICOM service port number
- Returns
The port of this DimseServiceOutput.
- Return type
int
-
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
-
property
flywheel.models.download module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.download.Download(optional=None, nodes=None, container_filters=None, filters=None)¶ Bases:
object-
property
container_filters¶ Gets the container_filters of this Download.
- Returns
The container_filters of this Download.
- Return type
list[DownloadContainerFilter]
-
property
filters¶ Gets the filters of this Download.
- Returns
The filters of this Download.
- Return type
list[DownloadFilter]
-
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
-
property
nodes¶ Gets the nodes of this Download.
- Returns
The nodes of this Download.
- Return type
list[DownloadNode]
-
property
optional¶ Gets the optional of this Download.
- Returns
The optional of this Download.
- Return type
bool
-
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
-
property
flywheel.models.download_container_filter module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.download_container_filter.DownloadContainerFilter(tags=None)¶ Bases:
object-
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
Gets the tags of this DownloadContainerFilter.
- Returns
The tags of this DownloadContainerFilter.
- Return type
-
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
-
flywheel.models.download_container_filter_definition module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.download_container_filter_definition.DownloadContainerFilterDefinition(type=None, plus=None, minus=None)¶ Bases:
object-
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
-
property
minus¶ Gets the minus of this DownloadContainerFilterDefinition.
A list of items to include or exclude from a download
- Returns
The minus of this DownloadContainerFilterDefinition.
- Return type
list[str]
-
property
plus¶ Gets the plus of this DownloadContainerFilterDefinition.
A list of items to include or exclude from a download
- Returns
The plus of this DownloadContainerFilterDefinition.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this DownloadContainerFilterDefinition.
- Returns
The type of this DownloadContainerFilterDefinition.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.download_filter module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.download_filter.DownloadFilter(tags=None, types=None, since=None)¶ Bases:
object-
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
-
property
since¶ Gets the since of this DownloadFilter.
- Returns
The since of this DownloadFilter.
- Return type
float
Gets the tags of this DownloadFilter.
- Returns
The tags of this DownloadFilter.
- Return type
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
types¶ Gets the types of this DownloadFilter.
- Returns
The types of this DownloadFilter.
- Return type
-
values()¶ Returns the list of values in the object
-
flywheel.models.download_filter_definition module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.download_filter_definition.DownloadFilterDefinition(plus=None, minus=None)¶ Bases:
object-
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
-
property
minus¶ Gets the minus of this DownloadFilterDefinition.
A list of items to include or exclude from a download
- Returns
The minus of this DownloadFilterDefinition.
- Return type
list[str]
-
property
plus¶ Gets the plus of this DownloadFilterDefinition.
A list of items to include or exclude from a download
- Returns
The plus of this DownloadFilterDefinition.
- Return type
list[str]
-
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
-
flywheel.models.download_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.download_input.DownloadInput(optional=None, nodes=None, container_filters=None, filters=None)¶ Bases:
object-
property
container_filters¶ Gets the container_filters of this DownloadInput.
- Returns
The container_filters of this DownloadInput.
- Return type
list[DownloadContainerFilter]
-
property
filters¶ Gets the filters of this DownloadInput.
- Returns
The filters of this DownloadInput.
- Return type
list[DownloadFilter]
-
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
-
property
nodes¶ Gets the nodes of this DownloadInput.
- Returns
The nodes of this DownloadInput.
- Return type
list[DownloadNode]
-
property
optional¶ Gets the optional of this DownloadInput.
- Returns
The optional of this DownloadInput.
- Return type
bool
-
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
-
property
flywheel.models.download_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.download_node.DownloadNode(level=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this DownloadNode.
- Returns
The id of this DownloadNode.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
level¶ Gets the level of this DownloadNode.
- Returns
The level of this DownloadNode.
- Return type
str
-
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
-
flywheel.models.download_ticket module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.download_ticket.DownloadTicket(ticket=None)¶ Bases:
object-
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
-
property
ticket¶ Gets the ticket of this DownloadTicket.
The ticket to use to perform the actual download
- Returns
The ticket of this DownloadTicket.
- Return type
str
-
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
-
flywheel.models.download_ticket_stub module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.download_ticket_stub.DownloadTicketStub(ticket=None, filename=None, file_cnt=None, size=None)¶ Bases:
object-
property
file_cnt¶ Gets the file_cnt of this DownloadTicketStub.
- Returns
The file_cnt of this DownloadTicketStub.
- Return type
int
-
property
filename¶ Gets the filename of this DownloadTicketStub.
- Returns
The filename of this DownloadTicketStub.
- Return type
str
-
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
-
property
size¶ Gets the size of this DownloadTicketStub.
- Returns
The size of this DownloadTicketStub.
- Return type
int
-
property
ticket¶ Gets the ticket of this DownloadTicketStub.
- Returns
The ticket of this DownloadTicketStub.
- Return type
str
-
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
-
property
flywheel.models.download_ticket_with_summary module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.download_ticket_with_summary.DownloadTicketWithSummary(ticket=None, file_cnt=None, size=None)¶ Bases:
object-
property
file_cnt¶ Gets the file_cnt of this DownloadTicketWithSummary.
The number of files that will be included in the download
- Returns
The file_cnt of this DownloadTicketWithSummary.
- Return type
int
-
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
-
property
size¶ Gets the size of this DownloadTicketWithSummary.
An estimated total number of bytes that will be downloaded
- Returns
The size of this DownloadTicketWithSummary.
- Return type
int
-
property
ticket¶ Gets the ticket of this DownloadTicketWithSummary.
The ticket to use to perform the actual download
- Returns
The ticket of this DownloadTicketWithSummary.
- Return type
str
-
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
-
property
flywheel.models.edition module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.edition.Edition(lab=False)¶ Bases:
object-
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
-
property
lab¶ Gets the lab of this Edition.
- Returns
The lab of this Edition.
- Return type
bool
-
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
-
flywheel.models.egress_device module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.egress_device.EgressDevice(id=None, label=None, name=None, method=None, api_keys=None, api_key=None, key=None, type=None, version=None, errors=None, info=None, interval=None, last_seen=None, disabled=None, deleted=None, storage_config=None, modified=None)¶ Bases:
object-
property
api_key¶ Gets the api_key of this EgressDevice.
- Returns
The api_key of this EgressDevice.
- Return type
-
property
api_keys¶ Gets the api_keys of this EgressDevice.
- Returns
The api_keys of this EgressDevice.
- Return type
list[ApiKeyOutput]
-
property
deleted¶ Gets the deleted of this EgressDevice.
- Returns
The deleted of this EgressDevice.
- Return type
datetime
-
property
disabled¶ Gets the disabled of this EgressDevice.
- Returns
The disabled of this EgressDevice.
- Return type
bool
-
property
errors¶ Gets the errors of this EgressDevice.
- Returns
The errors of this EgressDevice.
- Return type
list[str]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this EgressDevice.
- Returns
The id of this EgressDevice.
- Return type
str
-
property
info¶ Gets the info of this EgressDevice.
- Returns
The info of this EgressDevice.
- Return type
object
-
property
interval¶ Gets the interval of this EgressDevice.
- Returns
The interval of this EgressDevice.
- Return type
int
-
items()¶ Returns the list of json property to value mapping
-
property
key¶ Gets the key of this EgressDevice.
- Returns
The key of this EgressDevice.
- Return type
str
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this EgressDevice.
- Returns
The label of this EgressDevice.
- Return type
str
-
property
last_seen¶ Gets the last_seen of this EgressDevice.
- Returns
The last_seen of this EgressDevice.
- Return type
datetime
-
property
method¶ Gets the method of this EgressDevice.
- Returns
The method of this EgressDevice.
- Return type
str
-
property
modified¶ Gets the modified of this EgressDevice.
- Returns
The modified of this EgressDevice.
- Return type
datetime
-
property
name¶ Gets the name of this EgressDevice.
- Returns
The name of this EgressDevice.
- Return type
str
-
property
storage_config¶ Gets the storage_config of this EgressDevice.
- Returns
The storage_config of this EgressDevice.
- Return type
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this EgressDevice.
- Returns
The type of this EgressDevice.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this EgressDevice.
- Returns
The version of this EgressDevice.
- Return type
str
-
property
flywheel.models.egress_device_page module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.egress_device_page.EgressDevicePage(count=None, total=None, results=None)¶ Bases:
object-
property
count¶ Gets the count of this EgressDevicePage.
- Returns
The count of this EgressDevicePage.
- Return type
int
-
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
-
property
results¶ Gets the results of this EgressDevicePage.
- Returns
The results of this EgressDevicePage.
- Return type
list[EgressDevice]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
total¶ Gets the total of this EgressDevicePage.
- Returns
The total of this EgressDevicePage.
- Return type
int
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.egress_provider module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.egress_provider.EgressProvider(id=None, label=None, provider_class=None, provider_type=None, config=None, modified=None, created=None, access_type=None)¶ Bases:
object-
property
access_type¶ Gets the access_type of this EgressProvider.
- Returns
The access_type of this EgressProvider.
- Return type
-
property
config¶ Gets the config of this EgressProvider.
- Returns
The config of this EgressProvider.
- Return type
object
-
property
created¶ Gets the created of this EgressProvider.
- Returns
The created of this EgressProvider.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this EgressProvider.
- Returns
The id of this EgressProvider.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this EgressProvider.
- Returns
The label of this EgressProvider.
- Return type
str
-
property
modified¶ Gets the modified of this EgressProvider.
- Returns
The modified of this EgressProvider.
- Return type
datetime
-
property
provider_class¶ Gets the provider_class of this EgressProvider.
- Returns
The provider_class of this EgressProvider.
- Return type
-
property
provider_type¶ Gets the provider_type of this EgressProvider.
- Returns
The provider_type of this EgressProvider.
- Return type
-
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
-
property
flywheel.models.egress_provider_id module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.egress_provider_id.EgressProviderId(id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this EgressProviderId.
- Returns
The id of this EgressProviderId.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.enginemetadata_label_upload_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.enginemetadata_label_upload_input.EnginemetadataLabelUploadInput(group=None, project=None, session=None, acquisition=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this EnginemetadataLabelUploadInput.
- Returns
The acquisition of this EnginemetadataLabelUploadInput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this EnginemetadataLabelUploadInput.
- Returns
The group of this EnginemetadataLabelUploadInput.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this EnginemetadataLabelUploadInput.
- Returns
The project of this EnginemetadataLabelUploadInput.
- Return type
-
property
session¶ Gets the session of this EnginemetadataLabelUploadInput.
- Returns
The session of this EnginemetadataLabelUploadInput.
- Return type
-
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
-
property
flywheel.models.enginemetadata_uid_match_upload_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.enginemetadata_uid_match_upload_input.EnginemetadataUidMatchUploadInput(project=None, session=None, acquisition=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this EnginemetadataUidMatchUploadInput.
- Returns
The acquisition of this EnginemetadataUidMatchUploadInput.
- Return type
-
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
-
property
project¶ Gets the project of this EnginemetadataUidMatchUploadInput.
- Returns
The project of this EnginemetadataUidMatchUploadInput.
- Return type
-
property
session¶ Gets the session of this EnginemetadataUidMatchUploadInput.
- Returns
The session of this EnginemetadataUidMatchUploadInput.
- Return type
-
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
-
property
flywheel.models.enginemetadata_uid_upload_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.enginemetadata_uid_upload_input.EnginemetadataUidUploadInput(group=None, project=None, session=None, acquisition=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this EnginemetadataUidUploadInput.
- Returns
The acquisition of this EnginemetadataUidUploadInput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this EnginemetadataUidUploadInput.
- Returns
The group of this EnginemetadataUidUploadInput.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this EnginemetadataUidUploadInput.
- Returns
The project of this EnginemetadataUidUploadInput.
- Return type
-
property
session¶ Gets the session of this EnginemetadataUidUploadInput.
- Returns
The session of this EnginemetadataUidUploadInput.
- Return type
-
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
-
property
flywheel.models.enginemetadata_upload_acquisition_metadata_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.enginemetadata_upload_acquisition_metadata_input.EnginemetadataUploadAcquisitionMetadataInput(label=None, info=None, uid=None, timestamp=None, timezone=None, files=None, tags=None)¶ Bases:
object-
property
files¶ Gets the files of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The files of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The info of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The label of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
str
Gets the tags of this EnginemetadataUploadAcquisitionMetadataInput.
Array of application-specific tags
- Returns
The tags of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The timestamp of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The timezone of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The uid of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.exchange_storage module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.exchange_storage.ExchangeStorage(config_type=None, config_class=None, site_id=None, dataset_id=None)¶ Bases:
object-
property
config_class¶ Gets the config_class of this ExchangeStorage.
- Returns
The config_class of this ExchangeStorage.
- Return type
str
-
property
config_type¶ Gets the config_type of this ExchangeStorage.
- Returns
The config_type of this ExchangeStorage.
- Return type
str
-
property
dataset_id¶ Gets the dataset_id of this ExchangeStorage.
- Returns
The dataset_id of this ExchangeStorage.
- Return type
str
-
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
-
property
site_id¶ Gets the site_id of this ExchangeStorage.
- Returns
The site_id of this ExchangeStorage.
- Return type
str
-
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
-
property
flywheel.models.executor_info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.executor_info.ExecutorInfo(name=None, host=None, instance_type=None, cpu_cores=None, gpu=None, memory_bytes=None, disk_bytes=None, swap_bytes=None)¶ Bases:
object-
property
cpu_cores¶ Gets the cpu_cores of this ExecutorInfo.
- Returns
The cpu_cores of this ExecutorInfo.
- Return type
int
-
property
disk_bytes¶ Gets the disk_bytes of this ExecutorInfo.
- Returns
The disk_bytes of this ExecutorInfo.
- Return type
int
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
gpu¶ Gets the gpu of this ExecutorInfo.
- Returns
The gpu of this ExecutorInfo.
- Return type
bool
-
property
host¶ Gets the host of this ExecutorInfo.
- Returns
The host of this ExecutorInfo.
- Return type
str
-
property
instance_type¶ Gets the instance_type of this ExecutorInfo.
- Returns
The instance_type of this ExecutorInfo.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
memory_bytes¶ Gets the memory_bytes of this ExecutorInfo.
- Returns
The memory_bytes of this ExecutorInfo.
- Return type
int
-
property
name¶ Gets the name of this ExecutorInfo.
- Returns
The name of this ExecutorInfo.
- Return type
str
-
property
swap_bytes¶ Gets the swap_bytes of this ExecutorInfo.
- Returns
The swap_bytes of this ExecutorInfo.
- Return type
int
-
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
-
property
flywheel.models.features module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.features.Features(auth0=None, audit_trail=False, cold_job_logs=False, collections=False, copy_by_reference=True, core_api=True, crawler=False, default_viewer_apps=True, deid_log=False, deid_profile=False, dimse=False, elastic_search_primary=False, exchange=False, external_routing=False, gear_access=False, google_analytics=True, healthcare_api=False, job_ask=True, job_prioritization=False, job_tickets=True, jupyter_integration=False, ldap_sync=False, multifactor_auth=False, multipart_signed_url=True, multiproject=False, ohif_multi_subject_view=False, ohif_react=False, ohif_react_beta=False, ohif_slice_order=None, ohif_v3=False, ohif_v3_beta=False, open_tracing=False, project_export=False, project_locking=False, reader_tasks=False, rts_sync=False, sentry_logging=None, shared_projects=False, signed_url=False, study_task_status=False, tagging=False, tags_in_lists=True, task_manager_data_views=True, unsafe_login=False, userpilot=None, validate_classification=False, virus_scan=False, api_enabled_gear_rules=True, project_list_uses_stats=False, enhanced_api_key=True)¶ Bases:
object-
property
api_enabled_gear_rules¶ Gets the api_enabled_gear_rules of this Features.
- Returns
The api_enabled_gear_rules of this Features.
- Return type
bool
-
property
audit_trail¶ Gets the audit_trail of this Features.
- Returns
The audit_trail of this Features.
- Return type
bool
-
property
auth0¶ Gets the auth0 of this Features.
- Returns
The auth0 of this Features.
- Return type
bool
-
property
cold_job_logs¶ Gets the cold_job_logs of this Features.
- Returns
The cold_job_logs of this Features.
- Return type
bool
-
property
collections¶ Gets the collections of this Features.
- Returns
The collections of this Features.
- Return type
bool
-
property
copy_by_reference¶ Gets the copy_by_reference of this Features.
- Returns
The copy_by_reference of this Features.
- Return type
bool
-
property
core_api¶ Gets the core_api of this Features.
- Returns
The core_api of this Features.
- Return type
bool
-
property
crawler¶ Gets the crawler of this Features.
- Returns
The crawler of this Features.
- Return type
bool
-
property
default_viewer_apps¶ Gets the default_viewer_apps of this Features.
- Returns
The default_viewer_apps of this Features.
- Return type
bool
-
property
deid_log¶ Gets the deid_log of this Features.
- Returns
The deid_log of this Features.
- Return type
bool
-
property
deid_profile¶ Gets the deid_profile of this Features.
- Returns
The deid_profile of this Features.
- Return type
bool
-
property
dimse¶ Gets the dimse of this Features.
- Returns
The dimse of this Features.
- Return type
bool
-
property
elastic_search_primary¶ Gets the elastic_search_primary of this Features.
- Returns
The elastic_search_primary of this Features.
- Return type
bool
-
property
enhanced_api_key¶ Gets the enhanced_api_key of this Features.
- Returns
The enhanced_api_key of this Features.
- Return type
bool
-
property
exchange¶ Gets the exchange of this Features.
- Returns
The exchange of this Features.
- Return type
bool
-
property
external_routing¶ Gets the external_routing of this Features.
- Returns
The external_routing of this Features.
- Return type
bool
-
property
gear_access¶ Gets the gear_access of this Features.
- Returns
The gear_access of this Features.
- Return type
bool
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
google_analytics¶ Gets the google_analytics of this Features.
- Returns
The google_analytics of this Features.
- Return type
bool
-
property
healthcare_api¶ Gets the healthcare_api of this Features.
- Returns
The healthcare_api of this Features.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
property
job_ask¶ Gets the job_ask of this Features.
- Returns
The job_ask of this Features.
- Return type
bool
-
property
job_prioritization¶ Gets the job_prioritization of this Features.
- Returns
The job_prioritization of this Features.
- Return type
bool
-
property
job_tickets¶ Gets the job_tickets of this Features.
- Returns
The job_tickets of this Features.
- Return type
bool
-
property
jupyter_integration¶ Gets the jupyter_integration of this Features.
- Returns
The jupyter_integration of this Features.
- Return type
bool
-
keys()¶ Returns the list of json properties in the object
-
property
ldap_sync¶ Gets the ldap_sync of this Features.
- Returns
The ldap_sync of this Features.
- Return type
bool
-
property
multifactor_auth¶ Gets the multifactor_auth of this Features.
- Returns
The multifactor_auth of this Features.
- Return type
bool
-
property
multipart_signed_url¶ Gets the multipart_signed_url of this Features.
- Returns
The multipart_signed_url of this Features.
- Return type
bool
-
property
multiproject¶ Gets the multiproject of this Features.
- Returns
The multiproject of this Features.
- Return type
bool
-
property
ohif_multi_subject_view¶ Gets the ohif_multi_subject_view of this Features.
- Returns
The ohif_multi_subject_view of this Features.
- Return type
bool
-
property
ohif_react¶ Gets the ohif_react of this Features.
- Returns
The ohif_react of this Features.
- Return type
bool
-
property
ohif_react_beta¶ Gets the ohif_react_beta of this Features.
- Returns
The ohif_react_beta of this Features.
- Return type
bool
-
property
ohif_slice_order¶ Gets the ohif_slice_order of this Features.
- Returns
The ohif_slice_order of this Features.
- Return type
str
-
property
ohif_v3¶ Gets the ohif_v3 of this Features.
- Returns
The ohif_v3 of this Features.
- Return type
bool
-
property
ohif_v3_beta¶ Gets the ohif_v3_beta of this Features.
- Returns
The ohif_v3_beta of this Features.
- Return type
bool
-
property
open_tracing¶ Gets the open_tracing of this Features.
- Returns
The open_tracing of this Features.
- Return type
bool
-
property
project_export¶ Gets the project_export of this Features.
- Returns
The project_export of this Features.
- Return type
bool
-
property
project_list_uses_stats¶ Gets the project_list_uses_stats of this Features.
- Returns
The project_list_uses_stats of this Features.
- Return type
bool
-
property
project_locking¶ Gets the project_locking of this Features.
- Returns
The project_locking of this Features.
- Return type
bool
-
property
reader_tasks¶ Gets the reader_tasks of this Features.
- Returns
The reader_tasks of this Features.
- Return type
bool
-
property
rts_sync¶ Gets the rts_sync of this Features.
- Returns
The rts_sync of this Features.
- Return type
bool
-
property
sentry_logging¶ Gets the sentry_logging of this Features.
- Returns
The sentry_logging of this Features.
- Return type
bool
Gets the shared_projects of this Features.
- Returns
The shared_projects of this Features.
- Return type
bool
-
property
signed_url¶ Gets the signed_url of this Features.
- Returns
The signed_url of this Features.
- Return type
bool
-
property
study_task_status¶ Gets the study_task_status of this Features.
- Returns
The study_task_status of this Features.
- Return type
bool
-
property
tagging¶ Gets the tagging of this Features.
- Returns
The tagging of this Features.
- Return type
bool
Gets the tags_in_lists of this Features.
- Returns
The tags_in_lists of this Features.
- Return type
bool
-
property
task_manager_data_views¶ Gets the task_manager_data_views of this Features.
- Returns
The task_manager_data_views of this Features.
- Return type
bool
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
unsafe_login¶ Gets the unsafe_login of this Features.
- Returns
The unsafe_login of this Features.
- Return type
bool
-
property
userpilot¶ Gets the userpilot of this Features.
- Returns
The userpilot of this Features.
- Return type
bool
-
property
validate_classification¶ Gets the validate_classification of this Features.
- Returns
The validate_classification of this Features.
- Return type
bool
-
values()¶ Returns the list of values in the object
-
property
virus_scan¶ Gets the virus_scan of this Features.
- Returns
The virus_scan of this Features.
- Return type
bool
-
property
flywheel.models.file_classification_delta module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_classification_delta.FileClassificationDelta(modality=None, add=None, delete=None, replace=None)¶ Bases:
object-
property
add¶ Gets the add of this FileClassificationDelta.
- Returns
The add of this FileClassificationDelta.
- Return type
dict(str, list[str])
-
property
delete¶ Gets the delete of this FileClassificationDelta.
- Returns
The delete of this FileClassificationDelta.
- Return type
dict(str, list[str])
-
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
-
property
modality¶ Gets the modality of this FileClassificationDelta.
- Returns
The modality of this FileClassificationDelta.
- Return type
str
-
property
replace¶ Gets the replace of this FileClassificationDelta.
- Returns
The replace of this FileClassificationDelta.
- Return type
dict(str, list[str])
-
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
-
property
flywheel.models.file_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_entry.FileEntry(id=None, file_id=None, version=None, name=None, type=None, mimetype=None, modality=None, deid_log_id=None, classification=None, tags=None, info=None, origin=None, hash=None, parents=None, parent_ref=None, created=None, modified=None, replaced=None, size=None, info_exists=None, zip_member_count=None)¶ Bases:
flywheel.models.mixins.FileMixin-
property
classification¶ Gets the classification of this FileEntry.
- Returns
The classification of this FileEntry.
- Return type
-
property
created¶ Gets the created of this FileEntry.
Creation time (automatically set)
- Returns
The created of this FileEntry.
- Return type
datetime
-
property
deid_log_id¶ Gets the deid_log_id of this FileEntry.
The UUID of the de-id log
- Returns
The deid_log_id of this FileEntry.
- Return type
str
-
property
file_id¶ Gets the file_id of this FileEntry.
Unique database ID
- Returns
The file_id of this FileEntry.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
hash¶ Gets the hash of this FileEntry.
Cryptographic hash of the file
- Returns
The hash of this FileEntry.
- Return type
str
-
property
id¶ Gets the id of this FileEntry.
- Returns
The id of this FileEntry.
- Return type
str
-
property
info¶ Gets the info of this FileEntry.
- Returns
The info of this FileEntry.
- Return type
-
property
info_exists¶ Gets the info_exists of this FileEntry.
- Returns
The info_exists of this FileEntry.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
mimetype¶ Gets the mimetype of this FileEntry.
A MIME Content-Type of the file
- Returns
The mimetype of this FileEntry.
- Return type
str
-
property
modality¶ Gets the modality of this FileEntry.
The type of instrument that originated the file (e.g. MR, CT, …)
- Returns
The modality of this FileEntry.
- Return type
str
-
property
modified¶ Gets the modified of this FileEntry.
Last modification time (automatically updated)
- Returns
The modified of this FileEntry.
- Return type
datetime
-
property
name¶ Gets the name of this FileEntry.
The name of the file on disk
- Returns
The name of this FileEntry.
- Return type
str
-
property
origin¶ Gets the origin of this FileEntry.
- Returns
The origin of this FileEntry.
- Return type
-
property
parent_ref¶ Gets the parent_ref of this FileEntry.
- Returns
The parent_ref of this FileEntry.
- Return type
-
property
parents¶ Gets the parents of this FileEntry.
- Returns
The parents of this FileEntry.
- Return type
-
property
replaced¶ Gets the replaced of this FileEntry.
Last replaced time (automatically updated)
- Returns
The replaced of this FileEntry.
- Return type
datetime
-
property
size¶ Gets the size of this FileEntry.
Size of the file, in bytes
- Returns
The size of this FileEntry.
- Return type
int
Gets the tags of this FileEntry.
Array of application-specific tags
- Returns
The tags of this FileEntry.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this FileEntry.
A descriptive file type (e.g. dicom, image, document, …)
- Returns
The type of this FileEntry.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this FileEntry.
Version of the file
- Returns
The version of this FileEntry.
- Return type
int
-
property
zip_member_count¶ Gets the zip_member_count of this FileEntry.
Number of entries in the zip archive
- Returns
The zip_member_count of this FileEntry.
- Return type
int
-
property
flywheel.models.file_gear_info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_gear_info.FileGearInfo(name=None, version=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this FileGearInfo.
- Returns
The id of this FileGearInfo.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
name¶ Gets the name of this FileGearInfo.
- Returns
The name of this FileGearInfo.
- Return type
str
-
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
-
property
version¶ Gets the version of this FileGearInfo.
- Returns
The version of this FileGearInfo.
- Return type
str
-
flywheel.models.file_list_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_list_output.FileListOutput(id=None, name=None, type=None, mimetype=None, file_id=None, version=None, modality=None, deid_log_id=None, deid_log_skip_reason=None, classification=None, tags=None, provider_id=None, path=None, reference=None, restored_from=None, restored_by=None, parent_ref=None, parents=None, origin=None, virus_scan=None, created=None, modified=None, replaced=None, deleted=None, size=None, hash=None, info=None, info_exists=False, zip_member_count=None, gear_info=None, copy_of=None, original_copy_of=None, client_hash=None)¶ Bases:
flywheel.models.mixins.FileMixin-
property
classification¶ Gets the classification of this FileListOutput.
- Returns
The classification of this FileListOutput.
- Return type
dict(str, list[str])
-
property
client_hash¶ Gets the client_hash of this FileListOutput.
- Returns
The client_hash of this FileListOutput.
- Return type
str
-
property
copy_of¶ Gets the copy_of of this FileListOutput.
- Returns
The copy_of of this FileListOutput.
- Return type
-
property
created¶ Gets the created of this FileListOutput.
- Returns
The created of this FileListOutput.
- Return type
datetime
-
property
deid_log_id¶ Gets the deid_log_id of this FileListOutput.
- Returns
The deid_log_id of this FileListOutput.
- Return type
str
-
property
deid_log_skip_reason¶ Gets the deid_log_skip_reason of this FileListOutput.
- Returns
The deid_log_skip_reason of this FileListOutput.
- Return type
-
property
deleted¶ Gets the deleted of this FileListOutput.
- Returns
The deleted of this FileListOutput.
- Return type
datetime
-
property
file_id¶ Gets the file_id of this FileListOutput.
- Returns
The file_id of this FileListOutput.
- Return type
str
-
property
gear_info¶ Gets the gear_info of this FileListOutput.
- Returns
The gear_info of this FileListOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
hash¶ Gets the hash of this FileListOutput.
- Returns
The hash of this FileListOutput.
- Return type
str
-
property
id¶ Gets the id of this FileListOutput.
- Returns
The id of this FileListOutput.
- Return type
str
-
property
info¶ Gets the info of this FileListOutput.
- Returns
The info of this FileListOutput.
- Return type
object
-
property
info_exists¶ Gets the info_exists of this FileListOutput.
- Returns
The info_exists of this FileListOutput.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
mimetype¶ Gets the mimetype of this FileListOutput.
- Returns
The mimetype of this FileListOutput.
- Return type
str
-
property
modality¶ Gets the modality of this FileListOutput.
- Returns
The modality of this FileListOutput.
- Return type
str
-
property
modified¶ Gets the modified of this FileListOutput.
- Returns
The modified of this FileListOutput.
- Return type
datetime
-
property
name¶ Gets the name of this FileListOutput.
- Returns
The name of this FileListOutput.
- Return type
str
-
property
origin¶ Gets the origin of this FileListOutput.
- Returns
The origin of this FileListOutput.
- Return type
-
property
original_copy_of¶ Gets the original_copy_of of this FileListOutput.
- Returns
The original_copy_of of this FileListOutput.
- Return type
-
property
parent_ref¶ Gets the parent_ref of this FileListOutput.
- Returns
The parent_ref of this FileListOutput.
- Return type
-
property
parents¶ Gets the parents of this FileListOutput.
- Returns
The parents of this FileListOutput.
- Return type
-
property
path¶ Gets the path of this FileListOutput.
- Returns
The path of this FileListOutput.
- Return type
str
-
property
provider_id¶ Gets the provider_id of this FileListOutput.
- Returns
The provider_id of this FileListOutput.
- Return type
str
-
property
reference¶ Gets the reference of this FileListOutput.
- Returns
The reference of this FileListOutput.
- Return type
bool
-
property
replaced¶ Gets the replaced of this FileListOutput.
- Returns
The replaced of this FileListOutput.
- Return type
datetime
-
property
restored_by¶ Gets the restored_by of this FileListOutput.
- Returns
The restored_by of this FileListOutput.
- Return type
-
property
restored_from¶ Gets the restored_from of this FileListOutput.
- Returns
The restored_from of this FileListOutput.
- Return type
int
-
property
size¶ Gets the size of this FileListOutput.
- Returns
The size of this FileListOutput.
- Return type
int
Gets the tags of this FileListOutput.
- Returns
The tags of this FileListOutput.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this FileListOutput.
- Returns
The type of this FileListOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this FileListOutput.
- Returns
The version of this FileListOutput.
- Return type
int
-
property
virus_scan¶ Gets the virus_scan of this FileListOutput.
- Returns
The virus_scan of this FileListOutput.
- Return type
-
property
zip_member_count¶ Gets the zip_member_count of this FileListOutput.
- Returns
The zip_member_count of this FileListOutput.
- Return type
int
-
property
flywheel.models.file_modify_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_modify_input.FileModifyInput(type=None, modality=None)¶ Bases:
object-
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
-
property
modality¶ Gets the modality of this FileModifyInput.
- Returns
The modality of this FileModifyInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this FileModifyInput.
- Returns
The type of this FileModifyInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.file_move_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_move_input.FileMoveInput(container_reference=None, name=None, run_gear_rules=None)¶ Bases:
object-
property
container_reference¶ Gets the container_reference of this FileMoveInput.
- Returns
The container_reference of this FileMoveInput.
- Return type
-
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
-
property
name¶ Gets the name of this FileMoveInput.
The name of the file on disk
- Returns
The name of this FileMoveInput.
- Return type
str
-
property
run_gear_rules¶ Gets the run_gear_rules of this FileMoveInput.
- Returns
The run_gear_rules of this FileMoveInput.
- Return type
bool
-
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
-
property
flywheel.models.file_origin module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_origin.FileOrigin(id=None, method=None, type=None, name=None, via=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this FileOrigin.
Database ID of joined name and method
- Returns
The id of this FileOrigin.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
method¶ Gets the method of this FileOrigin.
Method of file origin
- Returns
The method of this FileOrigin.
- Return type
str
-
property
name¶ Gets the name of this FileOrigin.
Name of device, user or job that originated the file
- Returns
The name of this FileOrigin.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this FileOrigin.
Type of file origin (e.g. device, user, job)
- Returns
The type of this FileOrigin.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.file_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_output.FileOutput(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, zip_member_count=None, gear_info=None, copy_of=None, original_copy_of=None)¶ Bases:
flywheel.models.mixins.FileMixin-
property
classification¶ Gets the classification of this FileOutput.
- Returns
The classification of this FileOutput.
- Return type
dict(str, list[str])
-
property
client_hash¶ Gets the client_hash of this FileOutput.
- Returns
The client_hash of this FileOutput.
- Return type
str
-
property
copy_of¶ Gets the copy_of of this FileOutput.
- Returns
The copy_of of this FileOutput.
- Return type
-
property
created¶ Gets the created of this FileOutput.
- Returns
The created of this FileOutput.
- Return type
datetime
-
property
deid_log_id¶ Gets the deid_log_id of this FileOutput.
- Returns
The deid_log_id of this FileOutput.
- Return type
str
-
property
deid_log_skip_reason¶ Gets the deid_log_skip_reason of this FileOutput.
- Returns
The deid_log_skip_reason of this FileOutput.
- Return type
-
property
deleted¶ Gets the deleted of this FileOutput.
- Returns
The deleted of this FileOutput.
- Return type
datetime
-
property
file_id¶ Gets the file_id of this FileOutput.
- Returns
The file_id of this FileOutput.
- Return type
str
-
property
gear_info¶ Gets the gear_info of this FileOutput.
- Returns
The gear_info of this FileOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
hash¶ Gets the hash of this FileOutput.
- Returns
The hash of this FileOutput.
- Return type
str
-
property
id¶ Gets the id of this FileOutput.
- Returns
The id of this FileOutput.
- Return type
str
-
property
info¶ Gets the info of this FileOutput.
- Returns
The info of this FileOutput.
- Return type
object
-
property
info_exists¶ Gets the info_exists of this FileOutput.
- Returns
The info_exists of this FileOutput.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
mimetype¶ Gets the mimetype of this FileOutput.
- Returns
The mimetype of this FileOutput.
- Return type
str
-
property
modality¶ Gets the modality of this FileOutput.
- Returns
The modality of this FileOutput.
- Return type
str
-
property
modified¶ Gets the modified of this FileOutput.
- Returns
The modified of this FileOutput.
- Return type
datetime
-
property
name¶ Gets the name of this FileOutput.
- Returns
The name of this FileOutput.
- Return type
str
-
property
origin¶ Gets the origin of this FileOutput.
- Returns
The origin of this FileOutput.
- Return type
-
property
original_copy_of¶ Gets the original_copy_of of this FileOutput.
- Returns
The original_copy_of of this FileOutput.
- Return type
-
property
parent_ref¶ Gets the parent_ref of this FileOutput.
- Returns
The parent_ref of this FileOutput.
- Return type
-
property
parents¶ Gets the parents of this FileOutput.
- Returns
The parents of this FileOutput.
- Return type
-
property
path¶ Gets the path of this FileOutput.
- Returns
The path of this FileOutput.
- Return type
str
-
property
provider_id¶ Gets the provider_id of this FileOutput.
- Returns
The provider_id of this FileOutput.
- Return type
str
-
property
reference¶ Gets the reference of this FileOutput.
- Returns
The reference of this FileOutput.
- Return type
bool
-
property
replaced¶ Gets the replaced of this FileOutput.
- Returns
The replaced of this FileOutput.
- Return type
datetime
-
property
restored_by¶ Gets the restored_by of this FileOutput.
- Returns
The restored_by of this FileOutput.
- Return type
-
property
restored_from¶ Gets the restored_from of this FileOutput.
- Returns
The restored_from of this FileOutput.
- Return type
int
-
property
size¶ Gets the size of this FileOutput.
- Returns
The size of this FileOutput.
- Return type
int
Gets the tags of this FileOutput.
- Returns
The tags of this FileOutput.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this FileOutput.
- Returns
The type of this FileOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this FileOutput.
- Returns
The version of this FileOutput.
- Return type
int
-
property
virus_scan¶ Gets the virus_scan of this FileOutput.
- Returns
The virus_scan of this FileOutput.
- Return type
-
property
zip_member_count¶ Gets the zip_member_count of this FileOutput.
- Returns
The zip_member_count of this FileOutput.
- Return type
int
-
property
flywheel.models.file_parents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_parents.FileParents(group=None, project=None, subject=None, session=None, acquisition=None, analysis=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this FileParents.
- Returns
The acquisition of this FileParents.
- Return type
str
-
property
analysis¶ Gets the analysis of this FileParents.
- Returns
The analysis of this FileParents.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this FileParents.
- Returns
The group of this FileParents.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this FileParents.
- Returns
The project of this FileParents.
- Return type
str
-
property
session¶ Gets the session of this FileParents.
- Returns
The session of this FileParents.
- Return type
str
-
property
subject¶ Gets the subject of this FileParents.
- Returns
The subject of this FileParents.
- Return type
str
-
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
-
property
flywheel.models.file_reference module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_reference.FileReference(type=None, id=None, name=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this FileReference.
Unique database ID
- Returns
The id of this FileReference.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
name¶ Gets the name of this FileReference.
The name of the file on disk
- Returns
The name of this FileReference.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this FileReference.
The type of container (e.g. session)
- Returns
The type of this FileReference.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.file_suggestion module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_suggestion.FileSuggestion(name=None, suggested=None)¶ Bases:
object-
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
-
property
name¶ Gets the name of this FileSuggestion.
- Returns
The name of this FileSuggestion.
- Return type
str
-
property
suggested¶ Gets the suggested of this FileSuggestion.
- Returns
The suggested of this FileSuggestion.
- Return type
dict(str, bool)
-
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
-
flywheel.models.file_template_options module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_template_options.FileTemplateOptions(minimum=None, maximum=None, mimetype=None, modality=None, tags=None, classification=None)¶ Bases:
object-
property
classification¶ Gets the classification of this FileTemplateOptions.
- Returns
The classification of this FileTemplateOptions.
- Return type
str
-
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
-
property
maximum¶ Gets the maximum of this FileTemplateOptions.
- Returns
The maximum of this FileTemplateOptions.
- Return type
int
-
property
mimetype¶ Gets the mimetype of this FileTemplateOptions.
- Returns
The mimetype of this FileTemplateOptions.
- Return type
str
-
property
minimum¶ Gets the minimum of this FileTemplateOptions.
- Returns
The minimum of this FileTemplateOptions.
- Return type
int
-
property
modality¶ Gets the modality of this FileTemplateOptions.
- Returns
The modality of this FileTemplateOptions.
- Return type
str
Gets the tags of this FileTemplateOptions.
- Returns
The tags of this FileTemplateOptions.
- Return type
str
-
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
-
property
flywheel.models.file_upsert_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_upsert_input.FileUpsertInput(parent_ref=None, provider_id=None, uuid=None, path=None, reference=None, client_hash=None, origin=None, name=None, type=None, mimetype=None, modality=None, classification=None, info=None, zip_member_count=None, deid_log_id=None, deid_log_skip_reason=None)¶ Bases:
object-
property
classification¶ Gets the classification of this FileUpsertInput.
- Returns
The classification of this FileUpsertInput.
- Return type
-
property
client_hash¶ Gets the client_hash of this FileUpsertInput.
- Returns
The client_hash of this FileUpsertInput.
- Return type
str
-
property
deid_log_id¶ Gets the deid_log_id of this FileUpsertInput.
The UUID of the de-id log
- Returns
The deid_log_id of this FileUpsertInput.
- Return type
str
-
property
deid_log_skip_reason¶ Gets the deid_log_skip_reason of this FileUpsertInput.
- Returns
The deid_log_skip_reason of this FileUpsertInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this FileUpsertInput.
- Returns
The info of this FileUpsertInput.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
mimetype¶ Gets the mimetype of this FileUpsertInput.
A MIME Content-Type of the file
- Returns
The mimetype of this FileUpsertInput.
- Return type
str
-
property
modality¶ Gets the modality of this FileUpsertInput.
The type of instrument that originated the file (e.g. MR, CT, …)
- Returns
The modality of this FileUpsertInput.
- Return type
str
-
property
name¶ Gets the name of this FileUpsertInput.
The name of the file on disk
- Returns
The name of this FileUpsertInput.
- Return type
str
-
property
origin¶ Gets the origin of this FileUpsertInput.
- Returns
The origin of this FileUpsertInput.
- Return type
-
property
parent_ref¶ Gets the parent_ref of this FileUpsertInput.
- Returns
The parent_ref of this FileUpsertInput.
- Return type
-
property
path¶ Gets the path of this FileUpsertInput.
- Returns
The path of this FileUpsertInput.
- Return type
str
-
property
provider_id¶ Gets the provider_id of this FileUpsertInput.
Unique database ID
- Returns
The provider_id of this FileUpsertInput.
- Return type
str
-
property
reference¶ Gets the reference of this FileUpsertInput.
- Returns
The reference of this FileUpsertInput.
- Return type
bool
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this FileUpsertInput.
A descriptive file type (e.g. dicom, image, document, …)
- Returns
The type of this FileUpsertInput.
- Return type
str
-
property
uuid¶ Gets the uuid of this FileUpsertInput.
Hyphen-separated universally unique identifier
- Returns
The uuid of this FileUpsertInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
zip_member_count¶ Gets the zip_member_count of this FileUpsertInput.
Number of entries in the zip archive
- Returns
The zip_member_count of this FileUpsertInput.
- Return type
int
-
property
flywheel.models.file_upsert_origin module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_upsert_origin.FileUpsertOrigin(type=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this FileUpsertOrigin.
- Returns
The id of this FileUpsertOrigin.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this FileUpsertOrigin.
- Returns
The type of this FileUpsertOrigin.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.file_upsert_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_upsert_output.FileUpsertOutput(parent_ref=None, provider_id=None, uuid=None, path=None, reference=None, client_hash=None, origin=None, name=None, type=None, mimetype=None, modality=None, classification=None, info=None, zip_member_count=None, deid_log_id=None, deid_log_skip_reason=None)¶ Bases:
object-
property
classification¶ Gets the classification of this FileUpsertOutput.
- Returns
The classification of this FileUpsertOutput.
- Return type
-
property
client_hash¶ Gets the client_hash of this FileUpsertOutput.
- Returns
The client_hash of this FileUpsertOutput.
- Return type
str
-
property
deid_log_id¶ Gets the deid_log_id of this FileUpsertOutput.
The UUID of the de-id log
- Returns
The deid_log_id of this FileUpsertOutput.
- Return type
str
-
property
deid_log_skip_reason¶ Gets the deid_log_skip_reason of this FileUpsertOutput.
- Returns
The deid_log_skip_reason of this FileUpsertOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this FileUpsertOutput.
- Returns
The info of this FileUpsertOutput.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
mimetype¶ Gets the mimetype of this FileUpsertOutput.
A MIME Content-Type of the file
- Returns
The mimetype of this FileUpsertOutput.
- Return type
str
-
property
modality¶ Gets the modality of this FileUpsertOutput.
The type of instrument that originated the file (e.g. MR, CT, …)
- Returns
The modality of this FileUpsertOutput.
- Return type
str
-
property
name¶ Gets the name of this FileUpsertOutput.
The name of the file on disk
- Returns
The name of this FileUpsertOutput.
- Return type
str
-
property
origin¶ Gets the origin of this FileUpsertOutput.
- Returns
The origin of this FileUpsertOutput.
- Return type
-
property
parent_ref¶ Gets the parent_ref of this FileUpsertOutput.
- Returns
The parent_ref of this FileUpsertOutput.
- Return type
-
property
path¶ Gets the path of this FileUpsertOutput.
- Returns
The path of this FileUpsertOutput.
- Return type
str
-
property
provider_id¶ Gets the provider_id of this FileUpsertOutput.
Unique database ID
- Returns
The provider_id of this FileUpsertOutput.
- Return type
str
-
property
reference¶ Gets the reference of this FileUpsertOutput.
- Returns
The reference of this FileUpsertOutput.
- Return type
bool
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this FileUpsertOutput.
A descriptive file type (e.g. dicom, image, document, …)
- Returns
The type of this FileUpsertOutput.
- Return type
str
-
property
uuid¶ Gets the uuid of this FileUpsertOutput.
Hyphen-separated universally unique identifier
- Returns
The uuid of this FileUpsertOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
zip_member_count¶ Gets the zip_member_count of this FileUpsertOutput.
Number of entries in the zip archive
- Returns
The zip_member_count of this FileUpsertOutput.
- Return type
int
-
property
flywheel.models.file_version module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_version.FileVersion(file_id=None, version=1)¶ Bases:
object-
property
file_id¶ Gets the file_id of this FileVersion.
- Returns
The file_id of this FileVersion.
- Return type
str
-
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
-
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
-
property
version¶ Gets the version of this FileVersion.
- Returns
The version of this FileVersion.
- Return type
int
-
property
flywheel.models.file_version_copy_of module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_version_copy_of.FileVersionCopyOf(file_id=None, version=None, parents=None, project_label=None, group_label=None)¶ Bases:
object-
property
file_id¶ Gets the file_id of this FileVersionCopyOf.
- Returns
The file_id of this FileVersionCopyOf.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group_label¶ Gets the group_label of this FileVersionCopyOf.
- Returns
The group_label of this FileVersionCopyOf.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
parents¶ Gets the parents of this FileVersionCopyOf.
- Returns
The parents of this FileVersionCopyOf.
- Return type
-
property
project_label¶ Gets the project_label of this FileVersionCopyOf.
- Returns
The project_label of this FileVersionCopyOf.
- Return type
str
-
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
-
property
version¶ Gets the version of this FileVersionCopyOf.
- Returns
The version of this FileVersionCopyOf.
- Return type
int
-
property
flywheel.models.file_version_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_version_output.FileVersionOutput(created=None, deleted=None, file_id=None, origin=None, version=None)¶ Bases:
object-
property
created¶ Gets the created of this FileVersionOutput.
Creation time (automatically set)
- Returns
The created of this FileVersionOutput.
- Return type
datetime
-
property
deleted¶ Gets the deleted of this FileVersionOutput.
Deleted time (automatically set on delete)
- Returns
The deleted of this FileVersionOutput.
- Return type
datetime
-
property
file_id¶ Gets the file_id of this FileVersionOutput.
Unique database ID
- Returns
The file_id of this FileVersionOutput.
- Return type
str
-
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
-
property
origin¶ Gets the origin of this FileVersionOutput.
- Returns
The origin of this FileVersionOutput.
- Return type
-
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
-
property
version¶ Gets the version of this FileVersionOutput.
- Returns
The version of this FileVersionOutput.
- Return type
int
-
property
flywheel.models.file_via module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_via.FileVia(id=None, method=None, type=None, name=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this FileVia.
- Returns
The id of this FileVia.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
method¶ Gets the method of this FileVia.
- Returns
The method of this FileVia.
- Return type
str
-
property
name¶ Gets the name of this FileVia.
- Returns
The name of this FileVia.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this FileVia.
- Returns
The type of this FileVia.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.file_zip_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_zip_entry.FileZipEntry(comment=None, path=None, timestamp=None, size=None)¶ Bases:
object-
property
comment¶ Gets the comment of this FileZipEntry.
- Returns
The comment of this FileZipEntry.
- Return type
str
-
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
-
property
path¶ Gets the path of this FileZipEntry.
- Returns
The path of this FileZipEntry.
- Return type
str
-
property
size¶ Gets the size of this FileZipEntry.
Size of the file, in bytes
- Returns
The size of this FileZipEntry.
- Return type
int
-
property
timestamp¶ Gets the timestamp of this FileZipEntry.
- Returns
The timestamp of this FileZipEntry.
- Return type
datetime
-
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
-
property
flywheel.models.file_zip_info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.file_zip_info.FileZipInfo(comment=None, members=None)¶ Bases:
object-
property
comment¶ Gets the comment of this FileZipInfo.
- Returns
The comment of this FileZipInfo.
- Return type
str
-
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
-
property
members¶ Gets the members of this FileZipInfo.
- Returns
The members of this FileZipInfo.
- Return type
list[FileZipEntry]
-
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
-
property
flywheel.models.fixed_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.fixed_input.FixedInput(type=None, id=None, name=None, version=None, input=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this FixedInput.
- Returns
The id of this FixedInput.
- Return type
str
-
property
input¶ Gets the input of this FixedInput.
- Returns
The input of this FixedInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
name¶ Gets the name of this FixedInput.
- Returns
The name of this FixedInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this FixedInput.
- Returns
The type of this FixedInput.
- Return type
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this FixedInput.
- Returns
The version of this FixedInput.
- Return type
int
-
flywheel.models.form_definition module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.form_definition.FormDefinition(components=None)¶ Bases:
object-
property
components¶ Gets the components of this FormDefinition.
- Returns
The components of this FormDefinition.
- Return type
list[object]
-
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
-
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
-
property
flywheel.models.gcp_creds module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gcp_creds.GcpCreds(client_email=None, client_id=None, private_key_id=None, private_key=None, client_x509_cert_url=None, project_id=None, auth_uri=None, token_uri=None, auth_provider_x509_cert_url=None, type=None)¶ Bases:
object-
property
auth_provider_x509_cert_url¶ Gets the auth_provider_x509_cert_url of this GcpCreds.
- Returns
The auth_provider_x509_cert_url of this GcpCreds.
- Return type
str
-
property
auth_uri¶ Gets the auth_uri of this GcpCreds.
- Returns
The auth_uri of this GcpCreds.
- Return type
str
-
property
client_email¶ Gets the client_email of this GcpCreds.
- Returns
The client_email of this GcpCreds.
- Return type
str
-
property
client_id¶ Gets the client_id of this GcpCreds.
- Returns
The client_id of this GcpCreds.
- Return type
str
-
property
client_x509_cert_url¶ Gets the client_x509_cert_url of this GcpCreds.
- Returns
The client_x509_cert_url of this GcpCreds.
- Return type
str
-
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
-
property
private_key¶ Gets the private_key of this GcpCreds.
- Returns
The private_key of this GcpCreds.
- Return type
str
-
property
private_key_id¶ Gets the private_key_id of this GcpCreds.
- Returns
The private_key_id of this GcpCreds.
- Return type
str
-
property
project_id¶ Gets the project_id of this GcpCreds.
- Returns
The project_id of this GcpCreds.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
token_uri¶ Gets the token_uri of this GcpCreds.
- Returns
The token_uri of this GcpCreds.
- Return type
str
-
property
type¶ Gets the type of this GcpCreds.
- Returns
The type of this GcpCreds.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.gcp_storage module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gcp_storage.GcpStorage(region='us-central1', bucket=None, path='', zone=None, config_type=None, config_class=None)¶ Bases:
object-
property
bucket¶ Gets the bucket of this GcpStorage.
- Returns
The bucket of this GcpStorage.
- Return type
str
-
property
config_class¶ Gets the config_class of this GcpStorage.
- Returns
The config_class of this GcpStorage.
- Return type
str
-
property
config_type¶ Gets the config_type of this GcpStorage.
- Returns
The config_type of this GcpStorage.
- Return type
str
-
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
-
property
path¶ Gets the path of this GcpStorage.
- Returns
The path of this GcpStorage.
- Return type
str
-
property
region¶ Gets the region of this GcpStorage.
- Returns
The region of this GcpStorage.
- Return type
str
-
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
-
property
zone¶ Gets the zone of this GcpStorage.
- Returns
The zone of this GcpStorage.
- Return type
str
-
property
flywheel.models.gear module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear.Gear(author=None, capabilities=None, maintainer=None, cite=None, config=None, custom=None, description=None, environment=None, flywheel=None, command=None, inputs=None, label=None, license=None, name=None, source=None, url=None, version=None)¶ Bases:
objectGets the author of this Gear.
The author of this gear.
- Returns
The author of this Gear.
- Return type
str
-
property
capabilities¶ Gets the capabilities of this Gear.
- Returns
The capabilities of this Gear.
- Return type
list[str]
-
property
cite¶ Gets the cite of this Gear.
(optional) Any citations relevant to the algorithm(s) or work present in the gear.
- Returns
The cite of this Gear.
- Return type
str
-
property
command¶ Gets the command of this Gear.
If provided, the starting command for the gear, rather than /flywheel/v0/run. Will be templated according to the spec.
- Returns
The command of this Gear.
- Return type
str
-
property
config¶ Gets the config of this Gear.
- Returns
The config of this Gear.
- Return type
-
property
custom¶ Gets the custom of this Gear.
- Returns
The custom of this Gear.
- Return type
-
property
description¶ Gets the description of this Gear.
A brief description of the gear’s purpose. Ideally 1-4 sentences.
- Returns
The description of this Gear.
- Return type
str
-
property
environment¶ Gets the environment of this Gear.
- Returns
The environment of this Gear.
- Return type
-
property
flywheel¶ Gets the flywheel of this Gear.
- Returns
The flywheel of this Gear.
- Return type
object
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
inputs¶ Gets the inputs of this Gear.
- Returns
The inputs of this Gear.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this Gear.
The human-friendly name of this gear.
- Returns
The label of this Gear.
- Return type
str
-
property
license¶ Gets the license of this Gear.
Software license of the gear
- Returns
The license of this Gear.
- Return type
str
-
property
maintainer¶ Gets the maintainer of this Gear.
(optional) The maintainer of this gear. Can be used to distinguish the algorithm author from the gear maintainer.
- Returns
The maintainer of this Gear.
- Return type
str
-
property
name¶ Gets the name of this Gear.
The identification of this gear.
- Returns
The name of this Gear.
- Return type
str
-
property
source¶ Gets the source of this Gear.
A valid URI, or empty string.
- Returns
The source of this Gear.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
url¶ Gets the url of this Gear.
A valid URI, or empty string.
- Returns
The url of this Gear.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this Gear.
A human-friendly string explaining the release version of this gear. Example: 3.2.1
- Returns
The version of this Gear.
- Return type
str
flywheel.models.gear_category module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.gear_config module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_config.GearConfig¶ Bases:
object-
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
-
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
-
flywheel.models.gear_context_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_context_input.GearContextInput(base=None)¶ Bases:
object-
property
base¶ Gets the base of this GearContextInput.
- Returns
The base of this GearContextInput.
- Return type
str
-
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
-
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
-
property
flywheel.models.gear_context_lookup module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_context_lookup.GearContextLookup¶ Bases:
object-
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
-
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
-
flywheel.models.gear_context_lookup_item module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_context_lookup_item.GearContextLookupItem(found=None, container_type=None, id=None, label=None, value=None)¶ Bases:
object-
property
container_type¶ Gets the container_type of this GearContextLookupItem.
The type of container (e.g. session)
- Returns
The container_type of this GearContextLookupItem.
- Return type
str
-
property
found¶ Gets the found of this GearContextLookupItem.
Was the context value found?
- Returns
The found of this GearContextLookupItem.
- Return type
bool
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GearContextLookupItem.
Id of the container where the context value was found, if any.
- Returns
The id of this GearContextLookupItem.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this GearContextLookupItem.
Label of the container where the context value was found, if any.
- Returns
The label of this GearContextLookupItem.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
value¶ Gets the value of this GearContextLookupItem.
The value if found. Valid IFF found is true. Can be null.
- Returns
The value of this GearContextLookupItem.
- Return type
object
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.gear_context_value_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_context_value_output.GearContextValueOutput(container_type=None, label=None, id=None, value=None, found=False)¶ Bases:
object-
property
container_type¶ Gets the container_type of this GearContextValueOutput.
- Returns
The container_type of this GearContextValueOutput.
- Return type
-
property
found¶ Gets the found of this GearContextValueOutput.
- Returns
The found of this GearContextValueOutput.
- Return type
bool
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GearContextValueOutput.
- Returns
The id of this GearContextValueOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this GearContextValueOutput.
- Returns
The label of this GearContextValueOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
value¶ Gets the value of this GearContextValueOutput.
- Returns
The value of this GearContextValueOutput.
- Return type
object
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.gear_context_value_output_unfound module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_context_value_output_unfound.GearContextValueOutputUnfound(found=None)¶ Bases:
object-
property
found¶ Gets the found of this GearContextValueOutputUnfound.
- Returns
The found of this GearContextValueOutputUnfound.
- Return type
bool
-
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
-
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
-
property
flywheel.models.gear_custom module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_custom.GearCustom¶ Bases:
object-
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
-
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
-
flywheel.models.gear_directive module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_directive.GearDirective¶ Bases:
object-
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
-
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
-
flywheel.models.gear_doc module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_doc.GearDoc(id=None, category=None, gear=None, exchange=None, created=None, modified=None, disabled=None)¶ Bases:
flywheel.models.gear_mixin.GearMixin-
property
category¶ Gets the category of this GearDoc.
The gear category
- Returns
The category of this GearDoc.
- Return type
str
-
property
created¶ Gets the created of this GearDoc.
Creation time (automatically set)
- Returns
The created of this GearDoc.
- Return type
datetime
-
property
disabled¶ Gets the disabled of this GearDoc.
The time the gear was disabled (automatically set)
- Returns
The disabled of this GearDoc.
- Return type
datetime
-
property
exchange¶ Gets the exchange of this GearDoc.
- Returns
The exchange of this GearDoc.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GearDoc.
Unique database ID
- Returns
The id of this GearDoc.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
modified¶ Gets the modified of this GearDoc.
Last modification time (automatically updated)
- Returns
The modified of this GearDoc.
- Return type
datetime
-
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
-
property
flywheel.models.gear_document module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_document.GearDocument(category=None, gear=None, exchange=None, created=None, modified=None, disabled=None, id=None)¶ Bases:
flywheel.models.gear_mixin.GearMixin-
property
category¶ Gets the category of this GearDocument.
- Returns
The category of this GearDocument.
- Return type
-
property
created¶ Gets the created of this GearDocument.
- Returns
The created of this GearDocument.
- Return type
datetime
-
property
disabled¶ Gets the disabled of this GearDocument.
- Returns
The disabled of this GearDocument.
- Return type
datetime
-
property
exchange¶ Gets the exchange of this GearDocument.
- Returns
The exchange of this GearDocument.
- Return type
-
property
gear¶ Gets the gear of this GearDocument.
- Returns
The gear of this GearDocument.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GearDocument.
- Returns
The id of this GearDocument.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
modified¶ Gets the modified of this GearDocument.
- Returns
The modified of this GearDocument.
- Return type
datetime
-
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
-
property
flywheel.models.gear_document_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_document_input.GearDocumentInput(category=None, gear=None, exchange=None, created=None, modified=None, disabled=None)¶ Bases:
object-
property
category¶ Gets the category of this GearDocumentInput.
- Returns
The category of this GearDocumentInput.
- Return type
-
property
created¶ Gets the created of this GearDocumentInput.
- Returns
The created of this GearDocumentInput.
- Return type
datetime
-
property
disabled¶ Gets the disabled of this GearDocumentInput.
- Returns
The disabled of this GearDocumentInput.
- Return type
datetime
-
property
exchange¶ Gets the exchange of this GearDocumentInput.
- Returns
The exchange of this GearDocumentInput.
- Return type
-
property
gear¶ Gets the gear of this GearDocumentInput.
- Returns
The gear of this GearDocumentInput.
- Return type
-
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
-
property
modified¶ Gets the modified of this GearDocumentInput.
- Returns
The modified of this GearDocumentInput.
- Return type
datetime
-
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
-
property
flywheel.models.gear_document_legacy_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_document_legacy_input.GearDocumentLegacyInput(category=None, gear=None, exchange=None, created=None, modified=None, disabled=None)¶ Bases:
object-
property
category¶ Gets the category of this GearDocumentLegacyInput.
- Returns
The category of this GearDocumentLegacyInput.
- Return type
-
property
created¶ Gets the created of this GearDocumentLegacyInput.
- Returns
The created of this GearDocumentLegacyInput.
- Return type
datetime
-
property
disabled¶ Gets the disabled of this GearDocumentLegacyInput.
- Returns
The disabled of this GearDocumentLegacyInput.
- Return type
datetime
-
property
exchange¶ Gets the exchange of this GearDocumentLegacyInput.
- Returns
The exchange of this GearDocumentLegacyInput.
- Return type
-
property
gear¶ Gets the gear of this GearDocumentLegacyInput.
- Returns
The gear of this GearDocumentLegacyInput.
- Return type
-
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
-
property
modified¶ Gets the modified of this GearDocumentLegacyInput.
- Returns
The modified of this GearDocumentLegacyInput.
- Return type
datetime
-
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
-
property
flywheel.models.gear_environment module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_environment.GearEnvironment¶ Bases:
object-
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
-
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
-
flywheel.models.gear_exchange module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_exchange.GearExchange(git_commit=None, rootfs_hash=None, rootfs_url=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
git_commit¶ Gets the git_commit of this GearExchange.
The SHA-1 hash referring to the git commit
- Returns
The git_commit of this GearExchange.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
rootfs_hash¶ Gets the rootfs_hash of this GearExchange.
The cryptographic hash of the root filesystem in the form of “algorithm:<base16 hash>”
- Returns
The rootfs_hash of this GearExchange.
- Return type
str
-
property
rootfs_url¶ Gets the rootfs_url of this GearExchange.
The absolute URL of the gear’s root file system
- Returns
The rootfs_url of this GearExchange.
- Return type
str
-
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
-
flywheel.models.gear_file_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_file_input.GearFileInput(base=None, optional=False)¶ Bases:
flywheel.models.gear_mixin.GearMixin-
property
base¶ Gets the base of this GearFileInput.
- Returns
The base of this GearFileInput.
- Return type
str
-
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
-
property
optional¶ Gets the optional of this GearFileInput.
- Returns
The optional of this GearFileInput.
- Return type
bool
-
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
-
property
flywheel.models.gear_id_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_id_output.GearIdOutput(id=None)¶ Bases:
flywheel.models.gear_mixin.GearMixin-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GearIdOutput.
- Returns
The id of this GearIdOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.gear_info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_info.GearInfo(id=None, category=None, name=None, version=None)¶ Bases:
object-
property
category¶ Gets the category of this GearInfo.
The gear category
- Returns
The category of this GearInfo.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GearInfo.
- Returns
The id of this GearInfo.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
name¶ Gets the name of this GearInfo.
The identification of this gear.
- Returns
The name of this GearInfo.
- Return type
str
-
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
-
property
version¶ Gets the version of this GearInfo.
A human-friendly string explaining the release version of this gear. Example: 3.2.1
- Returns
The version of this GearInfo.
- Return type
str
-
property
flywheel.models.gear_input_item module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_input_item.GearInputItem(base=None, description=None, optional=None)¶ Bases:
object-
property
base¶ Gets the base of this GearInputItem.
The type of gear input.
- Returns
The base of this GearInputItem.
- Return type
str
-
property
description¶ Gets the description of this GearInputItem.
Hackaround for description not technically being a schema directive
- Returns
The description of this GearInputItem.
- Return type
str
-
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
-
property
optional¶ Gets the optional of this GearInputItem.
Allow the gear to mark an input file as optional.
- Returns
The optional of this GearInputItem.
- Return type
bool
-
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
-
property
flywheel.models.gear_inputs module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_inputs.GearInputs¶ Bases:
object-
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
-
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
-
flywheel.models.gear_invocation module¶
Provides gear invocation support
-
class
flywheel.models.gear_invocation.GearInvocation(gear)¶ Bases:
objectRepresents the details necessary to execute a gear as a job
-
add_tag(tag)¶ Add a tag to the job
Add multiple tags to the job
-
propose_batch(containers, optional_input_policy='ignored')¶ Create a batch run proposal for the given containers
- Parameters
containers (list) – The list of containers to run the job on
optional_input_policy (str) – The optional input policy (default is ignored)
-
run()¶ Run the invocation as a single job (or analysis).
Requires that required inputs and the destination have been set.
Returns the job id, or the analysis id in the case of an analysis gear.
-
set_analysis_label(label)¶ Set the analysis label, if executing an analysis gear
-
set_destination(dest)¶ Set the destination container
-
set_input(key, input)¶ Add an input
-
set_priority(priority)¶ Set the priority of gear job
-
update_config(*args, **kwargs)¶ Update configuration values
-
flywheel.models.gear_key_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_key_input.GearKeyInput(base=None, read_only=False)¶ Bases:
object-
property
base¶ Gets the base of this GearKeyInput.
- Returns
The base of this GearKeyInput.
- Return type
str
-
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
-
property
read_only¶ Gets the read_only of this GearKeyInput.
- Returns
The read_only of this GearKeyInput.
- Return type
bool
-
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
-
property
flywheel.models.gear_manifest module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_manifest.GearManifest(name=None, inputs=None, config=None, custom=None, author=None, maintainer='', cite='', capabilities=None, description=None, environment=None, command='bash -c ./run', license=None, label=None, url=None, source=None, version=None, flywheel=None)¶ Bases:
objectGets the author of this GearManifest.
- Returns
The author of this GearManifest.
- Return type
str
-
property
capabilities¶ Gets the capabilities of this GearManifest.
- Returns
The capabilities of this GearManifest.
- Return type
list[str]
-
property
cite¶ Gets the cite of this GearManifest.
- Returns
The cite of this GearManifest.
- Return type
str
-
property
command¶ Gets the command of this GearManifest.
- Returns
The command of this GearManifest.
- Return type
str
-
property
config¶ Gets the config of this GearManifest.
- Returns
The config of this GearManifest.
- Return type
object
-
property
custom¶ Gets the custom of this GearManifest.
- Returns
The custom of this GearManifest.
- Return type
object
-
property
description¶ Gets the description of this GearManifest.
- Returns
The description of this GearManifest.
- Return type
str
-
property
environment¶ Gets the environment of this GearManifest.
- Returns
The environment of this GearManifest.
- Return type
dict(str, str)
-
property
flywheel¶ Gets the flywheel of this GearManifest.
- Returns
The flywheel of this GearManifest.
- Return type
object
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
inputs¶ Gets the inputs of this GearManifest.
- Returns
The inputs of this GearManifest.
- Return type
dict(str, union[GearFileInput,GearContextInput,GearKeyInput])
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this GearManifest.
- Returns
The label of this GearManifest.
- Return type
str
-
property
license¶ Gets the license of this GearManifest.
- Returns
The license of this GearManifest.
- Return type
str
-
property
maintainer¶ Gets the maintainer of this GearManifest.
- Returns
The maintainer of this GearManifest.
- Return type
str
-
property
name¶ Gets the name of this GearManifest.
- Returns
The name of this GearManifest.
- Return type
str
-
property
source¶ Gets the source of this GearManifest.
- Returns
The source of this GearManifest.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
url¶ Gets the url of this GearManifest.
- Returns
The url of this GearManifest.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this GearManifest.
- Returns
The version of this GearManifest.
- Return type
str
flywheel.models.gear_mixin module¶
Provides gear mixin
-
class
flywheel.models.gear_mixin.GearMixin¶ Bases:
objectGear mixin that provides additional functionality
-
add_permission(permission_type, permission_id)¶ Add individual permission to gear.
-
create_invocation()¶ Create a job invocation object
-
delete_all_permissions()¶ - Delete gear all permissions. Also sets is_restricted on the gear
series to False.
-
delete_permission(permission_type, permission_id)¶ Delete individual permission by type and id
-
get_default_config()¶ Get the default configuration for gear
-
get_series()¶ Get gear series by gear name.
-
is_analysis_gear()¶ Check if this is an analysis gear
-
modify_gear_series(gear_series_update)¶ Modify the gear series attributes such as is_restricted
- Parameters
gear_series_update (GearSeriesUpdate) – the dictionary specifying the updates to make to the gear series
- Example::
update_dict = {“is_restricted”: True} gear.modify_gear_series(update_dict)
-
print_details(width=90)¶ Print details about a gear to stdout
- Parameters
width (int) – The maximum line width for printing
-
propose_batch(containers, config=None, analysis_label=None, tags=None, priority=None, optional_input_policy='ignored')¶ Propose a batch run of the gear.
- Parameters
containers (list) – The list of targets.
config (dict) – The configuration to use, if overriding defaults.
analysis_label (str) – The label of the analysis, if running an analysis gear.
tags (list) – The list of tags to set for the job.
priority (str) – The priority of the job.
optional_input_policy (str) – The optional input policy, default is ‘ignored’
- Returns
The batch proposal, which can be started with proposal.run()
-
replace_permissions(permissions)¶ Replace gear permissions.
-
run(config=None, analysis_label=None, tags=None, destination=None, inputs=None, priority=None, **kwargs)¶ Run the gear.
- Parameters
config (dict) – The configuration to use, if overriding defaults.
analysis_label (str) – The label of the analysis, if running an analysis gear.
tags (list) – The list of tags to set for the job.
destination (object) – The destination container.
inputs (dict) – The list of input containers or files.
- Returns
The id of the job that was created (utility gear) or of the analysis container created (analysis gear).
-
flywheel.models.gear_permissions module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_permissions.GearPermissions(users=None, projects=None)¶ Bases:
object-
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
-
property
projects¶ Gets the projects of this GearPermissions.
- Returns
The projects of this GearPermissions.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
users¶ Gets the users of this GearPermissions.
- Returns
The users of this GearPermissions.
- Return type
list[str]
-
values()¶ Returns the list of values in the object
-
flywheel.models.gear_permissions_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_permissions_input.GearPermissionsInput(id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GearPermissionsInput.
- Returns
The id of this GearPermissionsInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.gear_permissions_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.gear_return_ticket module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_return_ticket.GearReturnTicket(ticket=None)¶ Bases:
object-
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
-
property
ticket¶ Gets the ticket of this GearReturnTicket.
Gear ticket
- Returns
The ticket of this GearReturnTicket.
- Return type
str
-
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
-
flywheel.models.gear_rule module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_rule.GearRule(id=None, project_id=None, gear_id=None, role_id=None, name=None, config=None, fixed_inputs=None, priority=None, auto_update=False, revision=1, any=None, all=None, _not=None, created=None, modified=None, disabled=False, compute_provider_id=None, last_modified_by=None, triggering_input=None)¶ Bases:
object-
property
all¶ Gets the all of this GearRule.
- Returns
The all of this GearRule.
- Return type
list[GearRuleCondition]
-
property
any¶ Gets the any of this GearRule.
- Returns
The any of this GearRule.
- Return type
list[GearRuleCondition]
-
property
auto_update¶ Gets the auto_update of this GearRule.
- Returns
The auto_update of this GearRule.
- Return type
bool
-
property
compute_provider_id¶ Gets the compute_provider_id of this GearRule.
- Returns
The compute_provider_id of this GearRule.
- Return type
str
-
property
config¶ Gets the config of this GearRule.
- Returns
The config of this GearRule.
- Return type
object
-
property
created¶ Gets the created of this GearRule.
- Returns
The created of this GearRule.
- Return type
datetime
-
property
disabled¶ Gets the disabled of this GearRule.
- Returns
The disabled of this GearRule.
- Return type
bool
-
property
fixed_inputs¶ Gets the fixed_inputs of this GearRule.
- Returns
The fixed_inputs of this GearRule.
- Return type
list[FixedInput]
-
property
gear_id¶ Gets the gear_id of this GearRule.
- Returns
The gear_id of this GearRule.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GearRule.
- Returns
The id of this GearRule.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
last_modified_by¶ Gets the last_modified_by of this GearRule.
- Returns
The last_modified_by of this GearRule.
- Return type
-
property
modified¶ Gets the modified of this GearRule.
- Returns
The modified of this GearRule.
- Return type
datetime
-
property
name¶ Gets the name of this GearRule.
- Returns
The name of this GearRule.
- Return type
str
-
property
priority¶ Gets the priority of this GearRule.
- Returns
The priority of this GearRule.
- Return type
-
property
project_id¶ Gets the project_id of this GearRule.
- Returns
The project_id of this GearRule.
- Return type
str
-
property
revision¶ Gets the revision of this GearRule.
- Returns
The revision of this GearRule.
- Return type
int
-
property
role_id¶ Gets the role_id of this GearRule.
- Returns
The role_id of this GearRule.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
triggering_input¶ Gets the triggering_input of this GearRule.
- Returns
The triggering_input of this GearRule.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.gear_rule_condition module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_rule_condition.GearRuleCondition(type=None, value=None, regex=None)¶ Bases:
object-
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
-
property
regex¶ Gets the regex of this GearRuleCondition.
- Returns
The regex of this GearRuleCondition.
- Return type
bool
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this GearRuleCondition.
- Returns
The type of this GearRuleCondition.
- Return type
-
property
value¶ Gets the value of this GearRuleCondition.
- Returns
The value of this GearRuleCondition.
- Return type
object
-
values()¶ Returns the list of values in the object
-
flywheel.models.gear_rule_condition_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_rule_condition_type.GearRuleConditionType¶ Bases:
str,enum.EnumAn enumeration.
-
CONTAINER_HAS_CLASSIFICATION= 'container.has-classification'¶
-
CONTAINER_HAS_TYPE= 'container.has-type'¶
-
FILE_CLASSIFICATION= 'file.classification'¶
-
FILE_MODALITY= 'file.modality'¶
-
FILE_NAME= 'file.name'¶
-
FILE_PARENT_REF_TYPE= 'file.parent_ref.type'¶
-
FILE_TAGS= 'file.tags'¶
-
FILE_TYPE= 'file.type'¶
-
GEAR_NAME= 'gear.name'¶
-
GEAR_VERSION= 'gear.version'¶
-
flywheel.models.gear_rule_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_rule_input.GearRuleInput(project_id=None, gear_id=None, role_id=None, name=None, config=None, fixed_inputs=None, priority=None, auto_update=False, any=None, all=None, _not=None, disabled=False, compute_provider_id=None, triggering_input=None)¶ Bases:
object-
property
all¶ Gets the all of this GearRuleInput.
- Returns
The all of this GearRuleInput.
- Return type
list[GearRuleCondition]
-
property
any¶ Gets the any of this GearRuleInput.
- Returns
The any of this GearRuleInput.
- Return type
list[GearRuleCondition]
-
property
auto_update¶ Gets the auto_update of this GearRuleInput.
- Returns
The auto_update of this GearRuleInput.
- Return type
bool
-
property
compute_provider_id¶ Gets the compute_provider_id of this GearRuleInput.
- Returns
The compute_provider_id of this GearRuleInput.
- Return type
str
-
property
config¶ Gets the config of this GearRuleInput.
- Returns
The config of this GearRuleInput.
- Return type
object
-
property
disabled¶ Gets the disabled of this GearRuleInput.
- Returns
The disabled of this GearRuleInput.
- Return type
bool
-
property
fixed_inputs¶ Gets the fixed_inputs of this GearRuleInput.
- Returns
The fixed_inputs of this GearRuleInput.
- Return type
list[FixedInput]
-
property
gear_id¶ Gets the gear_id of this GearRuleInput.
- Returns
The gear_id of this GearRuleInput.
- Return type
str
-
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
-
property
name¶ Gets the name of this GearRuleInput.
- Returns
The name of this GearRuleInput.
- Return type
str
-
property
priority¶ Gets the priority of this GearRuleInput.
- Returns
The priority of this GearRuleInput.
- Return type
-
property
project_id¶ Gets the project_id of this GearRuleInput.
- Returns
The project_id of this GearRuleInput.
- Return type
str
-
property
role_id¶ Gets the role_id of this GearRuleInput.
- Returns
The role_id of this GearRuleInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
triggering_input¶ Gets the triggering_input of this GearRuleInput.
- Returns
The triggering_input of this GearRuleInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.gear_save_submission module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_save_submission.GearSaveSubmission(ticket=None, repo=None, pointer=None)¶ Bases:
object-
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
-
property
pointer¶ Gets the pointer of this GearSaveSubmission.
Checksum of the docker image
- Returns
The pointer of this GearSaveSubmission.
- Return type
str
-
property
repo¶ Gets the repo of this GearSaveSubmission.
The identification of this gear.
- Returns
The repo of this GearSaveSubmission.
- Return type
str
-
property
ticket¶ Gets the ticket of this GearSaveSubmission.
Ticket id returned from prepare-add
- Returns
The ticket of this GearSaveSubmission.
- Return type
str
-
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
-
flywheel.models.gear_series module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_series.GearSeries(id=None, name=None, is_restricted=None, permissions=None, created=None, modified=None)¶ Bases:
object-
property
created¶ Gets the created of this GearSeries.
Creation time (automatically set)
- Returns
The created of this GearSeries.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GearSeries.
Unique database ID
- Returns
The id of this GearSeries.
- Return type
str
-
property
is_restricted¶ Gets the is_restricted of this GearSeries.
- Returns
The is_restricted of this GearSeries.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
modified¶ Gets the modified of this GearSeries.
Last modification time (automatically updated)
- Returns
The modified of this GearSeries.
- Return type
datetime
-
property
name¶ Gets the name of this GearSeries.
- Returns
The name of this GearSeries.
- Return type
str
-
property
permissions¶ Gets the permissions of this GearSeries.
- Returns
The permissions of this GearSeries.
- Return type
-
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
-
property
flywheel.models.gear_series_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_series_update.GearSeriesUpdate(is_restricted=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
is_restricted¶ Gets the is_restricted of this GearSeriesUpdate.
- Returns
The is_restricted of this GearSeriesUpdate.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.gear_suggestion_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_suggestion_output.GearSuggestionOutput(id=None, cont_type=None, label=None, parents=None, children=None, files=None)¶ Bases:
object-
property
children¶ Gets the children of this GearSuggestionOutput.
- Returns
The children of this GearSuggestionOutput.
- Return type
dict(str, list[ContainerReferenceWithLabel])
-
property
cont_type¶ Gets the cont_type of this GearSuggestionOutput.
- Returns
The cont_type of this GearSuggestionOutput.
- Return type
-
property
files¶ Gets the files of this GearSuggestionOutput.
- Returns
The files of this GearSuggestionOutput.
- Return type
list[FileSuggestion]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GearSuggestionOutput.
- Returns
The id of this GearSuggestionOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this GearSuggestionOutput.
- Returns
The label of this GearSuggestionOutput.
- Return type
str
-
property
parents¶ Gets the parents of this GearSuggestionOutput.
- Returns
The parents of this GearSuggestionOutput.
- Return type
-
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
-
property
flywheel.models.gear_ticket module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_ticket.GearTicket(id=None, origin=None, geardoc=None, timestamp=None)¶ Bases:
object-
property
geardoc¶ Gets the geardoc of this GearTicket.
- Returns
The geardoc of this GearTicket.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GearTicket.
- Returns
The id of this GearTicket.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
origin¶ Gets the origin of this GearTicket.
- Returns
The origin of this GearTicket.
- Return type
-
property
timestamp¶ Gets the timestamp of this GearTicket.
- Returns
The timestamp of this GearTicket.
- Return type
datetime
-
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
-
property
flywheel.models.gear_ticket_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear_ticket_output.GearTicketOutput(ticket=None)¶ Bases:
object-
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
-
property
ticket¶ Gets the ticket of this GearTicketOutput.
- Returns
The ticket of this GearTicketOutput.
- Return type
str
-
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
-
flywheel.models.google_auth_out module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.google_auth_out.GoogleAuthOut(id_endpoint='https://www.googleapis.com/oauth2/v3/userinfo', client_id='979703271380-q85tbsupddmb7996q30244368r7e54lr.apps.googleusercontent.com', token_endpoint='https://accounts.google.com/o/oauth2/token', verify_endpoint='https://www.googleapis.com/oauth2/v1/tokeninfo', refresh_endpoint='https://www.googleapis.com/oauth2/v4/token', auth_endpoint='https://accounts.google.com/o/oauth2/auth')¶ Bases:
object-
property
auth_endpoint¶ Gets the auth_endpoint of this GoogleAuthOut.
- Returns
The auth_endpoint of this GoogleAuthOut.
- Return type
str
-
property
client_id¶ Gets the client_id of this GoogleAuthOut.
- Returns
The client_id of this GoogleAuthOut.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id_endpoint¶ Gets the id_endpoint of this GoogleAuthOut.
- Returns
The id_endpoint of this GoogleAuthOut.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
refresh_endpoint¶ Gets the refresh_endpoint of this GoogleAuthOut.
- Returns
The refresh_endpoint of this GoogleAuthOut.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
token_endpoint¶ Gets the token_endpoint of this GoogleAuthOut.
- Returns
The token_endpoint of this GoogleAuthOut.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
verify_endpoint¶ Gets the verify_endpoint of this GoogleAuthOut.
- Returns
The verify_endpoint of this GoogleAuthOut.
- Return type
str
-
property
flywheel.models.group module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.group_by module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.group_by.GroupBy(columns=None)¶ Bases:
object-
property
columns¶ Gets the columns of this GroupBy.
- Returns
The columns of this GroupBy.
- Return type
list[GroupByColumn]
-
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
-
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
-
property
flywheel.models.group_by_column module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.group_by_column.GroupByColumn(src=None, dst=None)¶ Bases:
object-
property
dst¶ Gets the dst of this GroupByColumn.
- Returns
The dst of this GroupByColumn.
- Return type
str
-
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
-
property
src¶ Gets the src of this GroupByColumn.
- Returns
The src of this GroupByColumn.
- Return type
str
-
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
-
property
flywheel.models.group_container_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.group_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.group_input.GroupInput(id=None, label=None, providers=None, editions=None)¶ Bases:
flywheel.models.mixins.GroupMixin-
property
editions¶ Gets the editions of this GroupInput.
- Returns
The editions of this GroupInput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GroupInput.
- Returns
The id of this GroupInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this GroupInput.
- Returns
The label of this GroupInput.
- Return type
str
-
property
providers¶ Gets the providers of this GroupInput.
- Returns
The providers of this GroupInput.
- Return type
-
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
-
property
flywheel.models.group_metadata_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.group_metadata_input.GroupMetadataInput(id=None, label=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GroupMetadataInput.
- Returns
The id of this GroupMetadataInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this GroupMetadataInput.
- Returns
The label of this GroupMetadataInput.
- Return type
str
-
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
-
flywheel.models.group_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.group_output.GroupOutput(id=None, label=None, permissions=None, permissions_template=None, created=None, modified=None, revision=None, tags=None, providers=None, roles=None, editions=None, settings=None)¶ Bases:
flywheel.models.mixins.GroupMixin-
property
created¶ Gets the created of this GroupOutput.
- Returns
The created of this GroupOutput.
- Return type
datetime
-
property
editions¶ Gets the editions of this GroupOutput.
- Returns
The editions of this GroupOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GroupOutput.
- Returns
The id of this GroupOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this GroupOutput.
- Returns
The label of this GroupOutput.
- Return type
str
-
property
modified¶ Gets the modified of this GroupOutput.
- Returns
The modified of this GroupOutput.
- Return type
datetime
-
property
permissions¶ Gets the permissions of this GroupOutput.
- Returns
The permissions of this GroupOutput.
- Return type
list[AccessPermission]
-
property
permissions_template¶ Gets the permissions_template of this GroupOutput.
- Returns
The permissions_template of this GroupOutput.
- Return type
list[RolePermission]
-
property
providers¶ Gets the providers of this GroupOutput.
- Returns
The providers of this GroupOutput.
- Return type
-
property
revision¶ Gets the revision of this GroupOutput.
- Returns
The revision of this GroupOutput.
- Return type
int
-
property
roles¶ Gets the roles of this GroupOutput.
- Returns
The roles of this GroupOutput.
- Return type
list[str]
-
property
settings¶ Gets the settings of this GroupOutput.
- Returns
The settings of this GroupOutput.
- Return type
Gets the tags of this GroupOutput.
- Returns
The tags of this GroupOutput.
- Return type
list[str]
-
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
-
property
flywheel.models.group_role module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.group_role.GroupRole(id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this GroupRole.
- Returns
The id of this GroupRole.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.group_settings_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.group_settings_output.GroupSettingsOutput(viewer_apps=None, deid_profile=None, forms=None, external_routing_id=None)¶ Bases:
object-
property
deid_profile¶ Gets the deid_profile of this GroupSettingsOutput.
- Returns
The deid_profile of this GroupSettingsOutput.
- Return type
object
-
property
external_routing_id¶ Gets the external_routing_id of this GroupSettingsOutput.
- Returns
The external_routing_id of this GroupSettingsOutput.
- Return type
str
-
property
forms¶ Gets the forms of this GroupSettingsOutput.
- Returns
The forms of this GroupSettingsOutput.
- Return type
dict(str, list[FormDefinition])
-
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
-
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
-
property
flywheel.models.group_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.group_update.GroupUpdate(label=None, providers=None, editions=None, modified=None)¶ Bases:
object-
property
editions¶ Gets the editions of this GroupUpdate.
- Returns
The editions of this GroupUpdate.
- Return type
-
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
-
property
label¶ Gets the label of this GroupUpdate.
- Returns
The label of this GroupUpdate.
- Return type
str
-
property
modified¶ Gets the modified of this GroupUpdate.
- Returns
The modified of this GroupUpdate.
- Return type
datetime
-
property
providers¶ Gets the providers of this GroupUpdate.
- Returns
The providers of this GroupUpdate.
- Return type
-
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
-
property
flywheel.models.header_feature module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.header_feature.HeaderFeature¶ Bases:
str,enum.EnumAn enumeration.
-
BETA= 'beta'¶
-
EXCLUDE_FILES= 'exclude-files'¶
-
JOIN_FILES= 'join_files'¶
-
MULTIPART_SIGNED_URL= 'multipart_signed_url'¶
-
PAGINATION= 'pagination'¶
-
SAFE_REDIRECT= 'safe-redirect'¶
-
SLIM_CONTAINERS= 'slim-containers'¶
-
SUBJECT_CONTAINER= 'subject-container'¶
-
flywheel.models.http_validation_error module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.http_validation_error.HTTPValidationError(detail=None)¶ Bases:
object-
property
detail¶ Gets the detail of this HTTPValidationError.
- Returns
The detail of this HTTPValidationError.
- Return type
list[ValidationError]
-
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
-
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
-
property
flywheel.models.info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.info.Info(set=None, delete=None, replace=None)¶ Bases:
object-
property
delete¶ Gets the delete of this Info.
- Returns
The delete of this Info.
- Return type
list[str]
-
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
-
property
replace¶ Gets the replace of this Info.
- Returns
The replace of this Info.
- Return type
object
-
property
set¶ Gets the set of this Info.
- Returns
The set of this Info.
- Return type
object
-
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
-
property
flywheel.models.info_add_remove module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.info_add_remove.InfoAddRemove(set=None, delete=None)¶ Bases:
object-
property
delete¶ Gets the delete of this InfoAddRemove.
A list of properties to remove
- Returns
The delete of this InfoAddRemove.
- Return type
list[str]
-
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
-
property
set¶ Gets the set of this InfoAddRemove.
Key/value pairs of properties to set
- Returns
The set of this InfoAddRemove.
- Return type
object
-
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
-
property
flywheel.models.info_replace module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.info_replace.InfoReplace(replace=None)¶ Bases:
object-
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
-
property
replace¶ Gets the replace of this InfoReplace.
The new set of properties for the info
- Returns
The replace of this InfoReplace.
- Return type
object
-
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
-
flywheel.models.info_update_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.info_update_input.InfoUpdateInput(set=None, delete=None, replace=None)¶ Bases:
object-
property
delete¶ Gets the delete of this InfoUpdateInput.
A list of properties to remove
- Returns
The delete of this InfoUpdateInput.
- Return type
list[str]
-
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
-
property
replace¶ Gets the replace of this InfoUpdateInput.
The new set of properties for the info
- Returns
The replace of this InfoUpdateInput.
- Return type
object
-
property
set¶ Gets the set of this InfoUpdateInput.
Key/value pairs of properties to set
- Returns
The set of this InfoUpdateInput.
- Return type
object
-
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
-
property
flywheel.models.ingress_provider module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.ingress_provider.IngressProvider(label=None, provider_class=None, provider_type=None, creds=None, config=None, access_type=None)¶ Bases:
object-
property
access_type¶ Gets the access_type of this IngressProvider.
- Returns
The access_type of this IngressProvider.
- Return type
-
property
config¶ Gets the config of this IngressProvider.
- Returns
The config of this IngressProvider.
- Return type
object
-
property
creds¶ Gets the creds of this IngressProvider.
- Returns
The creds of this IngressProvider.
- Return type
object
-
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
-
property
label¶ Gets the label of this IngressProvider.
- Returns
The label of this IngressProvider.
- Return type
str
-
property
provider_class¶ Gets the provider_class of this IngressProvider.
- Returns
The provider_class of this IngressProvider.
- Return type
-
property
provider_type¶ Gets the provider_type of this IngressProvider.
- Returns
The provider_type of this IngressProvider.
- Return type
-
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
-
property
flywheel.models.ingress_update_provider module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.ingress_update_provider.IngressUpdateProvider(label=None, creds=None, config=None)¶ Bases:
object-
property
config¶ Gets the config of this IngressUpdateProvider.
- Returns
The config of this IngressUpdateProvider.
- Return type
object
-
property
creds¶ Gets the creds of this IngressUpdateProvider.
- Returns
The creds of this IngressUpdateProvider.
- Return type
object
-
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
-
property
label¶ Gets the label of this IngressUpdateProvider.
- Returns
The label of this IngressUpdateProvider.
- Return type
str
-
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
-
property
flywheel.models.inline_response200 module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.inline_response200.InlineResponse200(modified=None)¶ Bases:
object-
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
-
property
modified¶ Gets the modified of this InlineResponse200.
- Returns
The modified of this InlineResponse200.
- Return type
int
-
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
-
flywheel.models.inline_response2001 module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.inline_response2001.InlineResponse2001(key=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
key¶ Gets the key of this InlineResponse2001.
- Returns
The key of this InlineResponse2001.
- Return type
str
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.inline_response2002 module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.inline_response2002.InlineResponse2002(deleted=None)¶ Bases:
object-
property
deleted¶ Gets the deleted of this InlineResponse2002.
- Returns
The deleted of this InlineResponse2002.
- Return type
int
-
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
-
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
-
property
flywheel.models.inline_response2003 module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.inline_response2003.InlineResponse2003(id=None, role_ids=None, access=None)¶ Bases:
object-
property
access¶ Gets the access of this InlineResponse2003.
- Returns
The access of this InlineResponse2003.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this InlineResponse2003.
Database ID of a user
- Returns
The id of this InlineResponse2003.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
role_ids¶ Gets the role_ids of this InlineResponse2003.
- Returns
The role_ids of this InlineResponse2003.
- Return type
list[str]
-
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
-
property
flywheel.models.inline_response2005 module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.inline_response2005.InlineResponse2005(modified=None, jobs_spawned=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
jobs_spawned¶ Gets the jobs_spawned of this InlineResponse2005.
- Returns
The jobs_spawned of this InlineResponse2005.
- Return type
int
-
keys()¶ Returns the list of json properties in the object
-
property
modified¶ Gets the modified of this InlineResponse2005.
- Returns
The modified of this InlineResponse2005.
- Return type
int
-
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
-
flywheel.models.input_job module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.input_job.InputJob(attempt=1, priority=None, batch=None, origin=None, compute_provider_id=None, destination=None, gear_id=None, role_id=None, inputs=None, parents=None, label='', previous_job_id=None, tags=None, config=None)¶ Bases:
flywheel.models.mixins.JobMixin-
property
attempt¶ Gets the attempt of this InputJob.
- Returns
The attempt of this InputJob.
- Return type
int
-
property
batch¶ Gets the batch of this InputJob.
- Returns
The batch of this InputJob.
- Return type
str
-
property
compute_provider_id¶ Gets the compute_provider_id of this InputJob.
- Returns
The compute_provider_id of this InputJob.
- Return type
str
-
property
config¶ Gets the config of this InputJob.
- Returns
The config of this InputJob.
- Return type
object
-
property
destination¶ Gets the destination of this InputJob.
- Returns
The destination of this InputJob.
- Return type
-
property
gear_id¶ Gets the gear_id of this InputJob.
- Returns
The gear_id of this InputJob.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
inputs¶ Gets the inputs of this InputJob.
- Returns
The inputs of this InputJob.
- Return type
dict(str, union[FileReference,FileVersion])
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this InputJob.
- Returns
The label of this InputJob.
- Return type
str
-
property
origin¶ Gets the origin of this InputJob.
- Returns
The origin of this InputJob.
- Return type
-
property
parents¶ Gets the parents of this InputJob.
- Returns
The parents of this InputJob.
- Return type
-
property
previous_job_id¶ Gets the previous_job_id of this InputJob.
- Returns
The previous_job_id of this InputJob.
- Return type
str
-
property
priority¶ Gets the priority of this InputJob.
- Returns
The priority of this InputJob.
- Return type
-
property
role_id¶ Gets the role_id of this InputJob.
- Returns
The role_id of this InputJob.
- Return type
str
Gets the tags of this InputJob.
- Returns
The tags of this InputJob.
- Return type
list[str]
-
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
-
property
flywheel.models.input_job_profile module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.input_job_profile.InputJobProfile(elapsed_time_ms=None, executor=None, preparation_time_ms=None, upload_time_ms=None, versions=None)¶ Bases:
object-
property
elapsed_time_ms¶ Gets the elapsed_time_ms of this InputJobProfile.
- Returns
The elapsed_time_ms of this InputJobProfile.
- Return type
int
-
property
executor¶ Gets the executor of this InputJobProfile.
- Returns
The executor of this InputJobProfile.
- Return type
-
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
-
property
preparation_time_ms¶ Gets the preparation_time_ms of this InputJobProfile.
- Returns
The preparation_time_ms of this InputJobProfile.
- Return type
int
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
upload_time_ms¶ Gets the upload_time_ms of this InputJobProfile.
- Returns
The upload_time_ms of this InputJobProfile.
- Return type
int
-
values()¶ Returns the list of values in the object
-
property
versions¶ Gets the versions of this InputJobProfile.
- Returns
The versions of this InputJobProfile.
- Return type
dict(str, str)
-
property
flywheel.models.inserted_id module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.inserted_id.InsertedId(id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this InsertedId.
- Returns
The id of this InsertedId.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.job module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job.Job(id=None, origin=None, gear_id=None, gear_info=None, previous_job_id=None, inputs=None, destination=None, compute_provider_id=None, group=None, project=None, tags=None, priority=None, state=None, failure_reason=None, attempt=None, created=None, modified=None, retried=None, config=None, transitions=None, request=None, saved_files=None, profile=None, related_container_ids=None, label=None)¶ Bases:
flywheel.models.mixins.JobMixin-
property
attempt¶ Gets the attempt of this Job.
- Returns
The attempt of this Job.
- Return type
int
-
property
compute_provider_id¶ Gets the compute_provider_id of this Job.
Unique database ID
- Returns
The compute_provider_id of this Job.
- Return type
str
-
property
created¶ Gets the created of this Job.
Creation time (automatically set)
- Returns
The created of this Job.
- Return type
datetime
-
property
destination¶ Gets the destination of this Job.
- Returns
The destination of this Job.
- Return type
-
property
failure_reason¶ Gets the failure_reason of this Job.
An optional suspected reason for job failure
- Returns
The failure_reason of this Job.
- Return type
str
-
property
gear_id¶ Gets the gear_id of this Job.
- Returns
The gear_id of this Job.
- Return type
str
-
property
gear_info¶ Gets the gear_info of this Job.
- Returns
The gear_info of this Job.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this Job.
- Returns
The group of this Job.
- Return type
str
-
property
id¶ Gets the id of this Job.
Unique database ID
- Returns
The id of this Job.
- Return type
str
-
property
inputs¶ Gets the inputs of this Job.
- Returns
The inputs of this Job.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this Job.
Application-specific label
- Returns
The label of this Job.
- Return type
str
-
property
modified¶ Gets the modified of this Job.
Last modification time (automatically updated)
- Returns
The modified of this Job.
- Return type
datetime
-
property
previous_job_id¶ Gets the previous_job_id of this Job.
- Returns
The previous_job_id of this Job.
- Return type
str
-
property
priority¶ Gets the priority of this Job.
- Returns
The priority of this Job.
- Return type
str
-
property
profile¶ Gets the profile of this Job.
- Returns
The profile of this Job.
- Return type
-
property
project¶ Gets the project of this Job.
Unique database ID
- Returns
The project of this Job.
- Return type
str
Gets the related_container_ids of this Job.
The set of all related container ids
- Returns
The related_container_ids of this Job.
- Return type
list[str]
-
property
request¶ Gets the request of this Job.
- Returns
The request of this Job.
- Return type
-
property
retried¶ Gets the retried of this Job.
Retried time (automatically set)
- Returns
The retried of this Job.
- Return type
datetime
-
property
saved_files¶ Gets the saved_files of this Job.
- Returns
The saved_files of this Job.
- Return type
list[str]
-
property
state¶ Gets the state of this Job.
- Returns
The state of this Job.
- Return type
str
Gets the tags of this Job.
- Returns
The tags of this Job.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
transitions¶ Gets the transitions of this Job.
- Returns
The transitions of this Job.
- Return type
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.job_analysis_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_analysis_input.JobAnalysisInput(job=None, label=None, description='', compute_provider_id=None, info=None)¶ Bases:
object-
property
compute_provider_id¶ Gets the compute_provider_id of this JobAnalysisInput.
- Returns
The compute_provider_id of this JobAnalysisInput.
- Return type
str
-
property
description¶ Gets the description of this JobAnalysisInput.
- Returns
The description of this JobAnalysisInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this JobAnalysisInput.
- Returns
The info of this JobAnalysisInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this JobAnalysisInput.
- Returns
The job of this JobAnalysisInput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this JobAnalysisInput.
- Returns
The label of this JobAnalysisInput.
- Return type
str
-
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
-
property
flywheel.models.job_ask module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_ask.JobAsk(whitelist=None, blacklist=None, capabilities=None, _return=None, job_states=None)¶ Bases:
object-
property
blacklist¶ Gets the blacklist of this JobAsk.
- Returns
The blacklist of this JobAsk.
- Return type
-
property
capabilities¶ Gets the capabilities of this JobAsk.
A set of capabilities that must be a superset of matched jobs
- Returns
The capabilities of this JobAsk.
- Return type
list[str]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
job_states¶ Gets the job_states of this JobAsk.
List of job states to filter to when peeking and getting counts by state
- Returns
The job_states of this JobAsk.
- Return type
list[str]
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
whitelist¶ Gets the whitelist of this JobAsk.
- Returns
The whitelist of this JobAsk.
- Return type
-
property
flywheel.models.job_ask_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_ask_response.JobAskResponse(jobs=None, states=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
jobs¶ Gets the jobs of this JobAskResponse.
- Returns
The jobs of this JobAskResponse.
- Return type
list[Job]
-
keys()¶ Returns the list of json properties in the object
-
property
states¶ Gets the states of this JobAskResponse.
- Returns
The states of this JobAskResponse.
- Return type
-
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
-
flywheel.models.job_ask_response_job module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_ask_response_job.JobAskResponseJob(compute_provider_id=None, failure_reason=None, label=None, priority=None, modified=None, parents=None, produced_metadata=None, related_container_ids=None, request=None, retried=None, saved_files=None, state=None, profile=None, transitions=None, gear_id=None, gear_info=None, rule_id=None, role_id=None, inputs=None, legacy_inputs=None, destination=None, tags=None, attempt=None, previous_job_id=None, created=None, id=None, config=None, origin=None, batch=None, failed_output_accepted=None, parent_info=None)¶ Bases:
flywheel.models.mixins.JobMixin-
property
attempt¶ Gets the attempt of this JobAskResponseJob.
- Returns
The attempt of this JobAskResponseJob.
- Return type
int
-
property
batch¶ Gets the batch of this JobAskResponseJob.
- Returns
The batch of this JobAskResponseJob.
- Return type
str
-
property
compute_provider_id¶ Gets the compute_provider_id of this JobAskResponseJob.
- Returns
The compute_provider_id of this JobAskResponseJob.
- Return type
str
-
property
config¶ Gets the config of this JobAskResponseJob.
- Returns
The config of this JobAskResponseJob.
- Return type
object
-
property
created¶ Gets the created of this JobAskResponseJob.
- Returns
The created of this JobAskResponseJob.
- Return type
datetime
-
property
destination¶ Gets the destination of this JobAskResponseJob.
- Returns
The destination of this JobAskResponseJob.
- Return type
-
property
failed_output_accepted¶ Gets the failed_output_accepted of this JobAskResponseJob.
- Returns
The failed_output_accepted of this JobAskResponseJob.
- Return type
bool
-
property
failure_reason¶ Gets the failure_reason of this JobAskResponseJob.
- Returns
The failure_reason of this JobAskResponseJob.
- Return type
str
-
property
gear_id¶ Gets the gear_id of this JobAskResponseJob.
- Returns
The gear_id of this JobAskResponseJob.
- Return type
str
-
property
gear_info¶ Gets the gear_info of this JobAskResponseJob.
- Returns
The gear_info of this JobAskResponseJob.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this JobAskResponseJob.
- Returns
The id of this JobAskResponseJob.
- Return type
str
-
property
inputs¶ Gets the inputs of this JobAskResponseJob.
- Returns
The inputs of this JobAskResponseJob.
- Return type
dict(str, union[JobFileInput,ContextInput,core__models__jobs__ApiKeyInput])
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this JobAskResponseJob.
- Returns
The label of this JobAskResponseJob.
- Return type
str
-
property
legacy_inputs¶ Gets the legacy_inputs of this JobAskResponseJob.
- Returns
The legacy_inputs of this JobAskResponseJob.
- Return type
list[LegacyInput]
-
property
modified¶ Gets the modified of this JobAskResponseJob.
- Returns
The modified of this JobAskResponseJob.
- Return type
datetime
-
property
origin¶ Gets the origin of this JobAskResponseJob.
- Returns
The origin of this JobAskResponseJob.
- Return type
-
property
parent_info¶ Gets the parent_info of this JobAskResponseJob.
- Returns
The parent_info of this JobAskResponseJob.
- Return type
-
property
parents¶ Gets the parents of this JobAskResponseJob.
- Returns
The parents of this JobAskResponseJob.
- Return type
-
property
previous_job_id¶ Gets the previous_job_id of this JobAskResponseJob.
- Returns
The previous_job_id of this JobAskResponseJob.
- Return type
str
-
property
priority¶ Gets the priority of this JobAskResponseJob.
- Returns
The priority of this JobAskResponseJob.
- Return type
-
property
produced_metadata¶ Gets the produced_metadata of this JobAskResponseJob.
- Returns
The produced_metadata of this JobAskResponseJob.
- Return type
object
-
property
profile¶ Gets the profile of this JobAskResponseJob.
- Returns
The profile of this JobAskResponseJob.
- Return type
Gets the related_container_ids of this JobAskResponseJob.
- Returns
The related_container_ids of this JobAskResponseJob.
- Return type
list[str]
-
property
request¶ Gets the request of this JobAskResponseJob.
- Returns
The request of this JobAskResponseJob.
- Return type
-
property
retried¶ Gets the retried of this JobAskResponseJob.
- Returns
The retried of this JobAskResponseJob.
- Return type
datetime
-
property
role_id¶ Gets the role_id of this JobAskResponseJob.
- Returns
The role_id of this JobAskResponseJob.
- Return type
str
-
property
rule_id¶ Gets the rule_id of this JobAskResponseJob.
- Returns
The rule_id of this JobAskResponseJob.
- Return type
str
-
property
saved_files¶ Gets the saved_files of this JobAskResponseJob.
- Returns
The saved_files of this JobAskResponseJob.
- Return type
list[str]
-
property
state¶ Gets the state of this JobAskResponseJob.
- Returns
The state of this JobAskResponseJob.
- Return type
Gets the tags of this JobAskResponseJob.
- Returns
The tags of this JobAskResponseJob.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
transitions¶ Gets the transitions of this JobAskResponseJob.
- Returns
The transitions of this JobAskResponseJob.
- Return type
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.job_ask_return module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_ask_return.JobAskReturn(jobs=None, peek=None, states=None, encoded=None)¶ Bases:
object-
property
encoded¶ Gets the encoded of this JobAskReturn.
- Returns
The encoded of this JobAskReturn.
- Return type
bool
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
jobs¶ Gets the jobs of this JobAskReturn.
- Returns
The jobs of this JobAskReturn.
- Return type
int
-
keys()¶ Returns the list of json properties in the object
-
property
peek¶ Gets the peek of this JobAskReturn.
- Returns
The peek of this JobAskReturn.
- Return type
bool
-
property
states¶ Gets the states of this JobAskReturn.
- Returns
The states of this JobAskReturn.
- Return type
bool
-
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
-
property
flywheel.models.job_ask_return_criteria module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_ask_return_criteria.JobAskReturnCriteria(jobs=0, peek=False, states=False, encoded=False)¶ Bases:
object-
property
encoded¶ Gets the encoded of this JobAskReturnCriteria.
- Returns
The encoded of this JobAskReturnCriteria.
- Return type
bool
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
jobs¶ Gets the jobs of this JobAskReturnCriteria.
- Returns
The jobs of this JobAskReturnCriteria.
- Return type
int
-
keys()¶ Returns the list of json properties in the object
-
property
peek¶ Gets the peek of this JobAskReturnCriteria.
- Returns
The peek of this JobAskReturnCriteria.
- Return type
bool
-
property
states¶ Gets the states of this JobAskReturnCriteria.
- Returns
The states of this JobAskReturnCriteria.
- Return type
bool
-
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
-
property
flywheel.models.job_ask_state module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_ask_state.JobAskState(whitelist=None, blacklist=None, capabilities=None, limit=None)¶ Bases:
object-
property
blacklist¶ Gets the blacklist of this JobAskState.
- Returns
The blacklist of this JobAskState.
- Return type
-
property
capabilities¶ Gets the capabilities of this JobAskState.
A set of capabilities that must be a superset of matched jobs
- Returns
The capabilities of this JobAskState.
- Return type
list[str]
-
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
-
property
limit¶ Gets the limit of this JobAskState.
- Returns
The limit of this JobAskState.
- Return type
int
-
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
-
property
whitelist¶ Gets the whitelist of this JobAskState.
- Returns
The whitelist of this JobAskState.
- Return type
-
property
flywheel.models.job_ask_state_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_ask_state_response.JobAskStateResponse(count=None)¶ Bases:
object-
property
count¶ Gets the count of this JobAskStateResponse.
- Returns
The count of this JobAskStateResponse.
- Return type
int
-
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
-
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
-
property
flywheel.models.job_complete module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_complete.JobComplete(success=None, failure_reason=None, profile=None)¶ Bases:
object-
property
failure_reason¶ Gets the failure_reason of this JobComplete.
- Returns
The failure_reason of this JobComplete.
- Return type
str
-
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
-
property
profile¶ Gets the profile of this JobComplete.
- Returns
The profile of this JobComplete.
- Return type
-
property
success¶ Gets the success of this JobComplete.
- Returns
The success of this JobComplete.
- Return type
bool
-
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
-
property
flywheel.models.job_completion_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_completion_input.JobCompletionInput(success=None, elapsed=None, failure_reason=None, profile=None)¶ Bases:
object-
property
elapsed¶ Gets the elapsed of this JobCompletionInput.
The elapsed time of the job, in seconds
- Returns
The elapsed of this JobCompletionInput.
- Return type
int
-
property
failure_reason¶ Gets the failure_reason of this JobCompletionInput.
An optional suspected reason for job failure
- Returns
The failure_reason of this JobCompletionInput.
- Return type
str
-
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
-
property
profile¶ Gets the profile of this JobCompletionInput.
- Returns
The profile of this JobCompletionInput.
- Return type
-
property
success¶ Gets the success of this JobCompletionInput.
Whether or not the job succeeded
- Returns
The success of this JobCompletionInput.
- Return type
bool
-
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
-
property
flywheel.models.job_completion_ticket module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_completion_ticket.JobCompletionTicket(ticket=None)¶ Bases:
object-
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
-
property
ticket¶ Gets the ticket of this JobCompletionTicket.
The ticket to use to perform file uploads to a job
- Returns
The ticket of this JobCompletionTicket.
- Return type
str
-
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
-
flywheel.models.job_config module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_config.JobConfig¶ Bases:
object-
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
-
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
-
flywheel.models.job_config_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_config_input.JobConfigInput(group=None, gear_name=None, tag=None, compute_provider=None, created_by=None)¶ Bases:
object-
property
compute_provider¶ Gets the compute_provider of this JobConfigInput.
- Returns
The compute_provider of this JobConfigInput.
- Return type
list[str]
-
property
created_by¶ Gets the created_by of this JobConfigInput.
- Returns
The created_by of this JobConfigInput.
- Return type
list[str]
-
property
gear_name¶ Gets the gear_name of this JobConfigInput.
- Returns
The gear_name of this JobConfigInput.
- Return type
list[str]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this JobConfigInput.
- Returns
The group of this JobConfigInput.
- Return type
list[str]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
tag¶ Gets the tag of this JobConfigInput.
- Returns
The tag of this JobConfigInput.
- Return type
list[str]
-
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
-
property
flywheel.models.job_config_inputs module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_config_inputs.JobConfigInputs(group=None, gear_name=None, tag=None)¶ Bases:
object-
property
gear_name¶ Gets the gear_name of this JobConfigInputs.
- Returns
The gear_name of this JobConfigInputs.
- Return type
list[str]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this JobConfigInputs.
- Returns
The group of this JobConfigInputs.
- Return type
list[str]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
tag¶ Gets the tag of this JobConfigInputs.
- Returns
The tag of this JobConfigInputs.
- Return type
list[str]
-
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
-
property
flywheel.models.job_config_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_config_output.JobConfigOutput(config=None, destination=None, inputs=None)¶ Bases:
object-
property
config¶ Gets the config of this JobConfigOutput.
- Returns
The config of this JobConfigOutput.
- Return type
-
property
destination¶ Gets the destination of this JobConfigOutput.
- Returns
The destination of this JobConfigOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
inputs¶ Gets the inputs of this JobConfigOutput.
- Returns
The inputs of this JobConfigOutput.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.job_container_detail module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_container_detail.JobContainerDetail(id=None, label=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this JobContainerDetail.
- Returns
The id of this JobContainerDetail.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this JobContainerDetail.
Application-specific label
- Returns
The label of this JobContainerDetail.
- Return type
str
-
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
-
flywheel.models.job_destination module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_destination.JobDestination(type=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this JobDestination.
- Returns
The id of this JobDestination.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this JobDestination.
- Returns
The type of this JobDestination.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.job_detail module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_detail.JobDetail(id=None, origin=None, gear_id=None, gear_info=None, parent_info=None, previous_job_id=None, inputs=None, outputs=None, destination=None, tags=None, priority=None, state=None, attempt=None, created=None, modified=None, retried=None, config=None, request=None)¶ Bases:
object-
property
attempt¶ Gets the attempt of this JobDetail.
- Returns
The attempt of this JobDetail.
- Return type
int
-
property
config¶ Gets the config of this JobDetail.
- Returns
The config of this JobDetail.
- Return type
-
property
created¶ Gets the created of this JobDetail.
Creation time (automatically set)
- Returns
The created of this JobDetail.
- Return type
datetime
-
property
destination¶ Gets the destination of this JobDetail.
- Returns
The destination of this JobDetail.
- Return type
-
property
gear_id¶ Gets the gear_id of this JobDetail.
- Returns
The gear_id of this JobDetail.
- Return type
str
-
property
gear_info¶ Gets the gear_info of this JobDetail.
- Returns
The gear_info of this JobDetail.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this JobDetail.
Unique database ID
- Returns
The id of this JobDetail.
- Return type
str
-
property
inputs¶ Gets the inputs of this JobDetail.
- Returns
The inputs of this JobDetail.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
modified¶ Gets the modified of this JobDetail.
Last modification time (automatically updated)
- Returns
The modified of this JobDetail.
- Return type
datetime
-
property
origin¶ Gets the origin of this JobDetail.
- Returns
The origin of this JobDetail.
- Return type
-
property
outputs¶ Gets the outputs of this JobDetail.
- Returns
The outputs of this JobDetail.
- Return type
list[JobDetailFileEntry]
-
property
parent_info¶ Gets the parent_info of this JobDetail.
- Returns
The parent_info of this JobDetail.
- Return type
-
property
previous_job_id¶ Gets the previous_job_id of this JobDetail.
- Returns
The previous_job_id of this JobDetail.
- Return type
str
-
property
priority¶ Gets the priority of this JobDetail.
- Returns
The priority of this JobDetail.
- Return type
str
-
property
request¶ Gets the request of this JobDetail.
- Returns
The request of this JobDetail.
- Return type
-
property
retried¶ Gets the retried of this JobDetail.
Retried time (automatically set)
- Returns
The retried of this JobDetail.
- Return type
datetime
-
property
state¶ Gets the state of this JobDetail.
- Returns
The state of this JobDetail.
- Return type
str
Gets the tags of this JobDetail.
- Returns
The tags of this JobDetail.
- Return type
list[str]
-
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
-
property
flywheel.models.job_detail_container module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_detail_container.JobDetailContainer(id=None, label=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this JobDetailContainer.
- Returns
The id of this JobDetailContainer.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this JobDetailContainer.
- Returns
The label of this JobDetailContainer.
- Return type
str
-
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
-
flywheel.models.job_detail_file_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_detail_file_entry.JobDetailFileEntry(ref=None, object=None)¶ Bases:
object-
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
-
property
object¶ Gets the object of this JobDetailFileEntry.
- Returns
The object of this JobDetailFileEntry.
- Return type
-
property
ref¶ Gets the ref of this JobDetailFileEntry.
- Returns
The ref of this JobDetailFileEntry.
- Return type
-
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
-
flywheel.models.job_detail_inputs_object module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_detail_inputs_object.JobDetailInputsObject¶ Bases:
object-
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
-
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
-
flywheel.models.job_detail_parent_info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_detail_parent_info.JobDetailParentInfo(group=None, project=None, subject=None, session=None, acquisition=None, analysis=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this JobDetailParentInfo.
- Returns
The acquisition of this JobDetailParentInfo.
- Return type
-
property
analysis¶ Gets the analysis of this JobDetailParentInfo.
- Returns
The analysis of this JobDetailParentInfo.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this JobDetailParentInfo.
- Returns
The group of this JobDetailParentInfo.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this JobDetailParentInfo.
- Returns
The project of this JobDetailParentInfo.
- Return type
-
property
session¶ Gets the session of this JobDetailParentInfo.
- Returns
The session of this JobDetailParentInfo.
- Return type
-
property
subject¶ Gets the subject of this JobDetailParentInfo.
- Returns
The subject of this JobDetailParentInfo.
- Return type
-
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
-
property
flywheel.models.job_executor_info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_executor_info.JobExecutorInfo(name=None, host=None, instance_type=None, cpu_cores=None, gpu=None, memory_bytes=None, disk_bytes=None, swap_bytes=None)¶ Bases:
object-
property
cpu_cores¶ Gets the cpu_cores of this JobExecutorInfo.
The number of CPU cores
- Returns
The cpu_cores of this JobExecutorInfo.
- Return type
int
-
property
disk_bytes¶ Gets the disk_bytes of this JobExecutorInfo.
The size of the hard disk on the system, in bytes
- Returns
The disk_bytes of this JobExecutorInfo.
- Return type
int
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
gpu¶ Gets the gpu of this JobExecutorInfo.
Whether or not a GPU is available
- Returns
The gpu of this JobExecutorInfo.
- Return type
bool
-
property
host¶ Gets the host of this JobExecutorInfo.
The hostname or (more likely) IP address of the engine instance
- Returns
The host of this JobExecutorInfo.
- Return type
str
-
property
instance_type¶ Gets the instance_type of this JobExecutorInfo.
A free form string describing the instance type
- Returns
The instance_type of this JobExecutorInfo.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
memory_bytes¶ Gets the memory_bytes of this JobExecutorInfo.
The amount of memory on the system, in bytes
- Returns
The memory_bytes of this JobExecutorInfo.
- Return type
int
-
property
name¶ Gets the name of this JobExecutorInfo.
A machine or instance name, possibly a FQDN
- Returns
The name of this JobExecutorInfo.
- Return type
str
-
property
swap_bytes¶ Gets the swap_bytes of this JobExecutorInfo.
The available swap space, in bytes
- Returns
The swap_bytes of this JobExecutorInfo.
- Return type
int
-
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
-
property
flywheel.models.job_file_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_file_input.JobFileInput(hierarchy=None, object=None, location=None, base=None)¶ Bases:
object-
property
base¶ Gets the base of this JobFileInput.
- Returns
The base of this JobFileInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
hierarchy¶ Gets the hierarchy of this JobFileInput.
- Returns
The hierarchy of this JobFileInput.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
location¶ Gets the location of this JobFileInput.
- Returns
The location of this JobFileInput.
- Return type
-
property
object¶ Gets the object of this JobFileInput.
- Returns
The object of this JobFileInput.
- Return type
-
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
-
property
flywheel.models.job_file_input_list_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_file_input_list_output.JobFileInputListOutput(hierarchy=None, object=None, location=None, base=None)¶ Bases:
object-
property
base¶ Gets the base of this JobFileInputListOutput.
- Returns
The base of this JobFileInputListOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
hierarchy¶ Gets the hierarchy of this JobFileInputListOutput.
- Returns
The hierarchy of this JobFileInputListOutput.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
location¶ Gets the location of this JobFileInputListOutput.
- Returns
The location of this JobFileInputListOutput.
- Return type
-
property
object¶ Gets the object of this JobFileInputListOutput.
- Returns
The object of this JobFileInputListOutput.
- Return type
-
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
-
property
flywheel.models.job_file_object module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_file_object.JobFileObject(type=None, mimetype=None, modality=None, classification=None, tags=None, info=None, size=None, zip_member_count=None, version=None, file_id=None, origin=None)¶ Bases:
object-
property
classification¶ Gets the classification of this JobFileObject.
- Returns
The classification of this JobFileObject.
- Return type
object
-
property
file_id¶ Gets the file_id of this JobFileObject.
- Returns
The file_id of this JobFileObject.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this JobFileObject.
- Returns
The info of this JobFileObject.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
mimetype¶ Gets the mimetype of this JobFileObject.
- Returns
The mimetype of this JobFileObject.
- Return type
str
-
property
modality¶ Gets the modality of this JobFileObject.
- Returns
The modality of this JobFileObject.
- Return type
str
-
property
origin¶ Gets the origin of this JobFileObject.
- Returns
The origin of this JobFileObject.
- Return type
-
property
size¶ Gets the size of this JobFileObject.
- Returns
The size of this JobFileObject.
- Return type
int
Gets the tags of this JobFileObject.
- Returns
The tags of this JobFileObject.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this JobFileObject.
- Returns
The type of this JobFileObject.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this JobFileObject.
- Returns
The version of this JobFileObject.
- Return type
int
-
property
zip_member_count¶ Gets the zip_member_count of this JobFileObject.
- Returns
The zip_member_count of this JobFileObject.
- Return type
int
-
property
flywheel.models.job_file_object_list_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_file_object_list_output.JobFileObjectListOutput(type=None, mimetype=None, modality=None, classification=None, tags=None, size=None, zip_member_count=None, origin=None, version=None, file_id=None)¶ Bases:
object-
property
classification¶ Gets the classification of this JobFileObjectListOutput.
- Returns
The classification of this JobFileObjectListOutput.
- Return type
object
-
property
file_id¶ Gets the file_id of this JobFileObjectListOutput.
- Returns
The file_id of this JobFileObjectListOutput.
- Return type
str
-
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
-
property
mimetype¶ Gets the mimetype of this JobFileObjectListOutput.
- Returns
The mimetype of this JobFileObjectListOutput.
- Return type
str
-
property
modality¶ Gets the modality of this JobFileObjectListOutput.
- Returns
The modality of this JobFileObjectListOutput.
- Return type
str
-
property
origin¶ Gets the origin of this JobFileObjectListOutput.
- Returns
The origin of this JobFileObjectListOutput.
- Return type
-
property
size¶ Gets the size of this JobFileObjectListOutput.
- Returns
The size of this JobFileObjectListOutput.
- Return type
int
Gets the tags of this JobFileObjectListOutput.
- Returns
The tags of this JobFileObjectListOutput.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this JobFileObjectListOutput.
- Returns
The type of this JobFileObjectListOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this JobFileObjectListOutput.
- Returns
The version of this JobFileObjectListOutput.
- Return type
int
-
property
zip_member_count¶ Gets the zip_member_count of this JobFileObjectListOutput.
- Returns
The zip_member_count of this JobFileObjectListOutput.
- Return type
int
-
property
flywheel.models.job_gear_match module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_gear_match.JobGearMatch(group=None, gear_name=None, tag=None, compute_provider=None)¶ Bases:
object-
property
compute_provider¶ Gets the compute_provider of this JobGearMatch.
A set of compute providers to match
- Returns
The compute_provider of this JobGearMatch.
- Return type
list[str]
-
property
gear_name¶ Gets the gear_name of this JobGearMatch.
A set of gear.name matches
- Returns
The gear_name of this JobGearMatch.
- Return type
list[str]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this JobGearMatch.
A set of groups that are in the hierarchy of an input or destination
- Returns
The group of this JobGearMatch.
- Return type
list[str]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
tag¶ Gets the tag of this JobGearMatch.
A set of job.tags matches
- Returns
The tag of this JobGearMatch.
- Return type
list[str]
-
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
-
property
flywheel.models.job_inputs_array_item module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_inputs_array_item.JobInputsArrayItem(type=None, id=None, name=None, input=None, base=None, found=None)¶ Bases:
object-
property
base¶ Gets the base of this JobInputsArrayItem.
- Returns
The base of this JobInputsArrayItem.
- Return type
str
-
property
found¶ Gets the found of this JobInputsArrayItem.
- Returns
The found of this JobInputsArrayItem.
- Return type
bool
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this JobInputsArrayItem.
Unique database ID
- Returns
The id of this JobInputsArrayItem.
- Return type
str
-
property
input¶ Gets the input of this JobInputsArrayItem.
- Returns
The input of this JobInputsArrayItem.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
name¶ Gets the name of this JobInputsArrayItem.
The name of the file on disk
- Returns
The name of this JobInputsArrayItem.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this JobInputsArrayItem.
The type of container (e.g. session)
- Returns
The type of this JobInputsArrayItem.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.job_inputs_item module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_inputs_item.JobInputsItem(type=None, uri=None, location=None, vu=None)¶ Bases:
object-
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
-
property
location¶ Gets the location of this JobInputsItem.
- Returns
The location of this JobInputsItem.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this JobInputsItem.
- Returns
The type of this JobInputsItem.
- Return type
str
-
property
uri¶ Gets the uri of this JobInputsItem.
- Returns
The uri of this JobInputsItem.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
vu¶ Gets the vu of this JobInputsItem.
- Returns
The vu of this JobInputsItem.
- Return type
str
-
flywheel.models.job_inputs_object module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_inputs_object.JobInputsObject¶ Bases:
object-
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
-
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
-
flywheel.models.job_list_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_list_entry.JobListEntry(id=None, origin=None, gear_id=None, gear_info=None, previous_job_id=None, inputs=None, destination=None, tags=None, state=None, attempt=None, created=None, modified=None, retried=None, config=None, request=None, saved_files=None)¶ Bases:
flywheel.models.mixins.JobMixin-
property
attempt¶ Gets the attempt of this JobListEntry.
- Returns
The attempt of this JobListEntry.
- Return type
int
-
property
config¶ Gets the config of this JobListEntry.
- Returns
The config of this JobListEntry.
- Return type
-
property
created¶ Gets the created of this JobListEntry.
Creation time (automatically set)
- Returns
The created of this JobListEntry.
- Return type
datetime
-
property
destination¶ Gets the destination of this JobListEntry.
- Returns
The destination of this JobListEntry.
- Return type
-
property
gear_id¶ Gets the gear_id of this JobListEntry.
- Returns
The gear_id of this JobListEntry.
- Return type
str
-
property
gear_info¶ Gets the gear_info of this JobListEntry.
- Returns
The gear_info of this JobListEntry.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this JobListEntry.
Unique database ID
- Returns
The id of this JobListEntry.
- Return type
str
-
property
inputs¶ Gets the inputs of this JobListEntry.
- Returns
The inputs of this JobListEntry.
- Return type
list[JobInputsArrayItem]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
modified¶ Gets the modified of this JobListEntry.
Last modification time (automatically updated)
- Returns
The modified of this JobListEntry.
- Return type
datetime
-
property
origin¶ Gets the origin of this JobListEntry.
- Returns
The origin of this JobListEntry.
- Return type
-
property
previous_job_id¶ Gets the previous_job_id of this JobListEntry.
- Returns
The previous_job_id of this JobListEntry.
- Return type
str
-
property
request¶ Gets the request of this JobListEntry.
- Returns
The request of this JobListEntry.
- Return type
-
property
retried¶ Gets the retried of this JobListEntry.
Retried time (automatically set)
- Returns
The retried of this JobListEntry.
- Return type
datetime
-
property
saved_files¶ Gets the saved_files of this JobListEntry.
- Returns
The saved_files of this JobListEntry.
- Return type
list[str]
-
property
state¶ Gets the state of this JobListEntry.
- Returns
The state of this JobListEntry.
- Return type
str
Gets the tags of this JobListEntry.
- Returns
The tags of this JobListEntry.
- Return type
list[str]
-
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
-
property
flywheel.models.job_list_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_list_output.JobListOutput(gear_id=None, gear_info=None, rule_id=None, role_id=None, inputs=None, destination=None, tags=None, priority=None, attempt=None, previous_job_id=None, created=None, modified=None, retried=None, state=None, request=None, id=None, config=None, origin=None, saved_files=None, outputs=None, deleted_outputs=None, batch=None, failed_output_accepted=None, profile=None, failure_reason=None, related_container_ids=None, label=None, compute_provider_id=None, parents=None, parent_info=None, transitions=None)¶ Bases:
object-
property
attempt¶ Gets the attempt of this JobListOutput.
- Returns
The attempt of this JobListOutput.
- Return type
int
-
property
batch¶ Gets the batch of this JobListOutput.
- Returns
The batch of this JobListOutput.
- Return type
str
-
property
compute_provider_id¶ Gets the compute_provider_id of this JobListOutput.
- Returns
The compute_provider_id of this JobListOutput.
- Return type
str
-
property
config¶ Gets the config of this JobListOutput.
- Returns
The config of this JobListOutput.
- Return type
-
property
created¶ Gets the created of this JobListOutput.
- Returns
The created of this JobListOutput.
- Return type
datetime
-
property
deleted_outputs¶ Gets the deleted_outputs of this JobListOutput.
- Returns
The deleted_outputs of this JobListOutput.
- Return type
list[DeletedFile]
-
property
destination¶ Gets the destination of this JobListOutput.
- Returns
The destination of this JobListOutput.
- Return type
-
property
failed_output_accepted¶ Gets the failed_output_accepted of this JobListOutput.
- Returns
The failed_output_accepted of this JobListOutput.
- Return type
bool
-
property
failure_reason¶ Gets the failure_reason of this JobListOutput.
- Returns
The failure_reason of this JobListOutput.
- Return type
str
-
property
gear_id¶ Gets the gear_id of this JobListOutput.
- Returns
The gear_id of this JobListOutput.
- Return type
str
-
property
gear_info¶ Gets the gear_info of this JobListOutput.
- Returns
The gear_info of this JobListOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this JobListOutput.
- Returns
The id of this JobListOutput.
- Return type
str
-
property
inputs¶ Gets the inputs of this JobListOutput.
- Returns
The inputs of this JobListOutput.
- Return type
list[LegacyInput]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this JobListOutput.
- Returns
The label of this JobListOutput.
- Return type
str
-
property
modified¶ Gets the modified of this JobListOutput.
- Returns
The modified of this JobListOutput.
- Return type
datetime
-
property
origin¶ Gets the origin of this JobListOutput.
- Returns
The origin of this JobListOutput.
- Return type
-
property
outputs¶ Gets the outputs of this JobListOutput.
- Returns
The outputs of this JobListOutput.
- Return type
list[FileListOutput]
-
property
parent_info¶ Gets the parent_info of this JobListOutput.
- Returns
The parent_info of this JobListOutput.
- Return type
-
property
parents¶ Gets the parents of this JobListOutput.
- Returns
The parents of this JobListOutput.
- Return type
-
property
previous_job_id¶ Gets the previous_job_id of this JobListOutput.
- Returns
The previous_job_id of this JobListOutput.
- Return type
str
-
property
priority¶ Gets the priority of this JobListOutput.
- Returns
The priority of this JobListOutput.
- Return type
-
property
profile¶ Gets the profile of this JobListOutput.
- Returns
The profile of this JobListOutput.
- Return type
Gets the related_container_ids of this JobListOutput.
- Returns
The related_container_ids of this JobListOutput.
- Return type
list[str]
-
property
request¶ Gets the request of this JobListOutput.
- Returns
The request of this JobListOutput.
- Return type
-
property
retried¶ Gets the retried of this JobListOutput.
- Returns
The retried of this JobListOutput.
- Return type
datetime
-
property
role_id¶ Gets the role_id of this JobListOutput.
- Returns
The role_id of this JobListOutput.
- Return type
str
-
property
rule_id¶ Gets the rule_id of this JobListOutput.
- Returns
The rule_id of this JobListOutput.
- Return type
str
-
property
saved_files¶ Gets the saved_files of this JobListOutput.
- Returns
The saved_files of this JobListOutput.
- Return type
list[str]
-
property
state¶ Gets the state of this JobListOutput.
- Returns
The state of this JobListOutput.
- Return type
Gets the tags of this JobListOutput.
- Returns
The tags of this JobListOutput.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
transitions¶ Gets the transitions of this JobListOutput.
- Returns
The transitions of this JobListOutput.
- Return type
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.job_list_output_config module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_list_output_config.JobListOutputConfig(destination=None, inputs=None, config=None)¶ Bases:
object-
property
config¶ Gets the config of this JobListOutputConfig.
- Returns
The config of this JobListOutputConfig.
- Return type
object
-
property
destination¶ Gets the destination of this JobListOutputConfig.
- Returns
The destination of this JobListOutputConfig.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
inputs¶ Gets the inputs of this JobListOutputConfig.
- Returns
The inputs of this JobListOutputConfig.
- Return type
dict(str, union[JobFileInputListOutput,ContextInput,core__models__jobs__ApiKeyInput])
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.job_log module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_log.JobLog(fd=None, msg=None)¶ Bases:
object-
property
fd¶ Gets the fd of this JobLog.
- Returns
The fd of this JobLog.
- Return type
int
-
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
-
property
msg¶ Gets the msg of this JobLog.
- Returns
The msg of this JobLog.
- Return type
str
-
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
-
property
flywheel.models.job_log_column module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_log_column.JobLogColumn¶ Bases:
str,enum.EnumAn enumeration.
-
COMPLETED= 'completed'¶
-
CREATED= 'created'¶
-
GEAR_NAME= 'gear_name'¶
-
GEAR_ROLE= 'gear_role'¶
-
GEAR_RULE= 'gear_rule'¶
-
GROUP= 'group'¶
-
PRIORITY= 'priority'¶
-
PROJECT= 'project'¶
-
SESSION= 'session'¶
-
STATE= 'state'¶
-
SUBJECT= 'subject'¶
-
TAG= 'tag'¶
-
USER= 'user'¶
-
flywheel.models.job_log_record module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_log_record.JobLogRecord(id=None, logs=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this JobLogRecord.
- Returns
The id of this JobLogRecord.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
logs¶ Gets the logs of this JobLogRecord.
- Returns
The logs of this JobLogRecord.
- Return type
list[JobLog]
-
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
-
flywheel.models.job_modify module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_modify.JobModify(state=None, failure_reason=None)¶ Bases:
object-
property
failure_reason¶ Gets the failure_reason of this JobModify.
- Returns
The failure_reason of this JobModify.
- Return type
str
-
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
-
property
state¶ Gets the state of this JobModify.
- Returns
The state of this JobModify.
- Return type
-
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
-
property
flywheel.models.job_origin module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_origin.JobOrigin(type=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this JobOrigin.
- Returns
The id of this JobOrigin.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this JobOrigin.
- Returns
The type of this JobOrigin.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.job_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_output.JobOutput(gear_id=None, gear_info=None, rule_id=None, role_id=None, inputs=None, destination=None, tags=None, priority=None, attempt=None, previous_job_id=None, created=None, modified=None, retried=None, state=None, request=None, id=None, config=None, origin=None, saved_files=None, outputs=None, deleted_outputs=None, produced_metadata=None, batch=None, failed_output_accepted=None, profile=None, failure_reason=None, related_container_ids=None, label=None, compute_provider_id=None, parents=None, transitions=None, parent_info=None)¶ Bases:
flywheel.models.mixins.JobMixin-
property
attempt¶ Gets the attempt of this JobOutput.
- Returns
The attempt of this JobOutput.
- Return type
int
-
property
batch¶ Gets the batch of this JobOutput.
- Returns
The batch of this JobOutput.
- Return type
str
-
property
compute_provider_id¶ Gets the compute_provider_id of this JobOutput.
- Returns
The compute_provider_id of this JobOutput.
- Return type
str
-
property
config¶ Gets the config of this JobOutput.
- Returns
The config of this JobOutput.
- Return type
-
property
created¶ Gets the created of this JobOutput.
- Returns
The created of this JobOutput.
- Return type
datetime
-
property
deleted_outputs¶ Gets the deleted_outputs of this JobOutput.
- Returns
The deleted_outputs of this JobOutput.
- Return type
list[DeletedFile]
-
property
destination¶ Gets the destination of this JobOutput.
- Returns
The destination of this JobOutput.
- Return type
-
property
failed_output_accepted¶ Gets the failed_output_accepted of this JobOutput.
- Returns
The failed_output_accepted of this JobOutput.
- Return type
bool
-
property
failure_reason¶ Gets the failure_reason of this JobOutput.
- Returns
The failure_reason of this JobOutput.
- Return type
str
-
property
gear_id¶ Gets the gear_id of this JobOutput.
- Returns
The gear_id of this JobOutput.
- Return type
str
-
property
gear_info¶ Gets the gear_info of this JobOutput.
- Returns
The gear_info of this JobOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this JobOutput.
- Returns
The id of this JobOutput.
- Return type
str
-
property
inputs¶ Gets the inputs of this JobOutput.
- Returns
The inputs of this JobOutput.
- Return type
dict(str, FileReference)
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this JobOutput.
- Returns
The label of this JobOutput.
- Return type
str
-
property
modified¶ Gets the modified of this JobOutput.
- Returns
The modified of this JobOutput.
- Return type
datetime
-
property
origin¶ Gets the origin of this JobOutput.
- Returns
The origin of this JobOutput.
- Return type
-
property
outputs¶ Gets the outputs of this JobOutput.
- Returns
The outputs of this JobOutput.
- Return type
list[FileOutput]
-
property
parent_info¶ Gets the parent_info of this JobOutput.
- Returns
The parent_info of this JobOutput.
- Return type
-
property
parents¶ Gets the parents of this JobOutput.
- Returns
The parents of this JobOutput.
- Return type
-
property
previous_job_id¶ Gets the previous_job_id of this JobOutput.
- Returns
The previous_job_id of this JobOutput.
- Return type
str
-
property
priority¶ Gets the priority of this JobOutput.
- Returns
The priority of this JobOutput.
- Return type
-
property
produced_metadata¶ Gets the produced_metadata of this JobOutput.
- Returns
The produced_metadata of this JobOutput.
- Return type
object
-
property
profile¶ Gets the profile of this JobOutput.
- Returns
The profile of this JobOutput.
- Return type
Gets the related_container_ids of this JobOutput.
- Returns
The related_container_ids of this JobOutput.
- Return type
list[str]
-
property
request¶ Gets the request of this JobOutput.
- Returns
The request of this JobOutput.
- Return type
-
property
retried¶ Gets the retried of this JobOutput.
- Returns
The retried of this JobOutput.
- Return type
datetime
-
property
role_id¶ Gets the role_id of this JobOutput.
- Returns
The role_id of this JobOutput.
- Return type
str
-
property
rule_id¶ Gets the rule_id of this JobOutput.
- Returns
The rule_id of this JobOutput.
- Return type
str
-
property
saved_files¶ Gets the saved_files of this JobOutput.
- Returns
The saved_files of this JobOutput.
- Return type
list[str]
-
property
state¶ Gets the state of this JobOutput.
- Returns
The state of this JobOutput.
- Return type
Gets the tags of this JobOutput.
- Returns
The tags of this JobOutput.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
transitions¶ Gets the transitions of this JobOutput.
- Returns
The transitions of this JobOutput.
- Return type
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.job_output_config module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_output_config.JobOutputConfig(destination=None, inputs=None, config=None)¶ Bases:
object-
property
config¶ Gets the config of this JobOutputConfig.
- Returns
The config of this JobOutputConfig.
- Return type
object
-
property
destination¶ Gets the destination of this JobOutputConfig.
- Returns
The destination of this JobOutputConfig.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
inputs¶ Gets the inputs of this JobOutputConfig.
- Returns
The inputs of this JobOutputConfig.
- Return type
dict(str, union[JobFileInput,ContextInput,core__models__jobs__ApiKeyInput])
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.job_parents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_parents.JobParents(group=None, project=None, subject=None, session=None, acquisition=None, analysis=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this JobParents.
- Returns
The acquisition of this JobParents.
- Return type
str
-
property
analysis¶ Gets the analysis of this JobParents.
- Returns
The analysis of this JobParents.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this JobParents.
- Returns
The group of this JobParents.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this JobParents.
- Returns
The project of this JobParents.
- Return type
str
-
property
session¶ Gets the session of this JobParents.
- Returns
The session of this JobParents.
- Return type
str
-
property
subject¶ Gets the subject of this JobParents.
- Returns
The subject of this JobParents.
- Return type
str
-
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
-
property
flywheel.models.job_priority module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.job_priority_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_priority_update.JobPriorityUpdate(job_ids=None, priority=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
job_ids¶ Gets the job_ids of this JobPriorityUpdate.
- Returns
The job_ids of this JobPriorityUpdate.
- Return type
list[str]
-
keys()¶ Returns the list of json properties in the object
-
property
priority¶ Gets the priority of this JobPriorityUpdate.
- Returns
The priority of this JobPriorityUpdate.
- Return type
str
-
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
-
flywheel.models.job_profile module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_profile.JobProfile(total_input_files=None, total_input_size_bytes=None, total_output_files=None, total_output_size_bytes=None, preparation_time_ms=None, elapsed_time_ms=None, upload_time_ms=None, total_time_ms=None, versions=None, executor=None)¶ Bases:
object-
property
elapsed_time_ms¶ Gets the elapsed_time_ms of this JobProfile.
The runtime of the job, in milliseconds
- Returns
The elapsed_time_ms of this JobProfile.
- Return type
int
-
property
executor¶ Gets the executor of this JobProfile.
- Returns
The executor of this JobProfile.
- Return type
-
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
-
property
preparation_time_ms¶ Gets the preparation_time_ms of this JobProfile.
The length of time taken to download gear container and inputs, in milliseconds
- Returns
The preparation_time_ms of this JobProfile.
- Return type
int
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
total_input_files¶ Gets the total_input_files of this JobProfile.
The number of input files
- Returns
The total_input_files of this JobProfile.
- Return type
int
-
property
total_input_size_bytes¶ Gets the total_input_size_bytes of this JobProfile.
The combined size of all input files, in bytes
- Returns
The total_input_size_bytes of this JobProfile.
- Return type
int
-
property
total_output_files¶ Gets the total_output_files of this JobProfile.
The number of output files
- Returns
The total_output_files of this JobProfile.
- Return type
int
-
property
total_output_size_bytes¶ Gets the total_output_size_bytes of this JobProfile.
The combined size of all output files, in bytes
- Returns
The total_output_size_bytes of this JobProfile.
- Return type
int
-
property
total_time_ms¶ Gets the total_time_ms of this JobProfile.
The total length of time from start to finish, in milliseconds
- Returns
The total_time_ms of this JobProfile.
- Return type
int
-
property
upload_time_ms¶ Gets the upload_time_ms of this JobProfile.
The length of time taken to upload the job’s outputs, in milliseconds
- Returns
The upload_time_ms of this JobProfile.
- Return type
int
-
values()¶ Returns the list of values in the object
-
property
versions¶ Gets the versions of this JobProfile.
- Returns
The versions of this JobProfile.
- Return type
-
property
flywheel.models.job_profile_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_profile_input.JobProfileInput(preparation_time_ms=None, elapsed_time_ms=None, upload_time_ms=None, versions=None, executor=None)¶ Bases:
object-
property
elapsed_time_ms¶ Gets the elapsed_time_ms of this JobProfileInput.
The runtime of the job, in milliseconds
- Returns
The elapsed_time_ms of this JobProfileInput.
- Return type
int
-
property
executor¶ Gets the executor of this JobProfileInput.
- Returns
The executor of this JobProfileInput.
- Return type
-
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
-
property
preparation_time_ms¶ Gets the preparation_time_ms of this JobProfileInput.
The length of time taken to download gear container and inputs, in milliseconds
- Returns
The preparation_time_ms of this JobProfileInput.
- Return type
int
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
upload_time_ms¶ Gets the upload_time_ms of this JobProfileInput.
The length of time taken to upload the job’s outputs, in milliseconds
- Returns
The upload_time_ms of this JobProfileInput.
- Return type
int
-
values()¶ Returns the list of values in the object
-
property
versions¶ Gets the versions of this JobProfileInput.
- Returns
The versions of this JobProfileInput.
- Return type
-
property
flywheel.models.job_request module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_request.JobRequest(inputs=None, target=None, outputs=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
inputs¶ Gets the inputs of this JobRequest.
- Returns
The inputs of this JobRequest.
- Return type
list[JobInputsItem]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
outputs¶ Gets the outputs of this JobRequest.
- Returns
The outputs of this JobRequest.
- Return type
list[object]
-
property
target¶ Gets the target of this JobRequest.
- Returns
The target of this JobRequest.
- Return type
object
-
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
-
flywheel.models.job_request_item module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_request_item.JobRequestItem(type=None, uri=None, location=None, vu=None)¶ Bases:
object-
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
-
property
location¶ Gets the location of this JobRequestItem.
- Returns
The location of this JobRequestItem.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this JobRequestItem.
- Returns
The type of this JobRequestItem.
- Return type
-
property
uri¶ Gets the uri of this JobRequestItem.
- Returns
The uri of this JobRequestItem.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
vu¶ Gets the vu of this JobRequestItem.
- Returns
The vu of this JobRequestItem.
- Return type
str
-
flywheel.models.job_request_item_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.job_request_target module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_request_target.JobRequestTarget(command=None, env=None, uid=None, gid=None, dir='/flywheel/v0')¶ Bases:
object-
property
command¶ Gets the command of this JobRequestTarget.
- Returns
The command of this JobRequestTarget.
- Return type
list[str]
-
property
dir¶ Gets the dir of this JobRequestTarget.
- Returns
The dir of this JobRequestTarget.
- Return type
str
-
property
env¶ Gets the env of this JobRequestTarget.
- Returns
The env of this JobRequestTarget.
- Return type
dict(str, str)
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
gid¶ Gets the gid of this JobRequestTarget.
- Returns
The gid of this JobRequestTarget.
- Return type
int
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this JobRequestTarget.
- Returns
The uid of this JobRequestTarget.
- Return type
int
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.job_state module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.job_state_counts module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_state_counts.JobStateCounts(pending=None, running=None, failed=None, complete=None, cancelled=None)¶ Bases:
object-
property
cancelled¶ Gets the cancelled of this JobStateCounts.
- Returns
The cancelled of this JobStateCounts.
- Return type
int
-
property
complete¶ Gets the complete of this JobStateCounts.
- Returns
The complete of this JobStateCounts.
- Return type
int
-
property
failed¶ Gets the failed of this JobStateCounts.
- Returns
The failed of this JobStateCounts.
- Return type
int
-
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
-
property
pending¶ Gets the pending of this JobStateCounts.
- Returns
The pending of this JobStateCounts.
- Return type
int
-
property
running¶ Gets the running of this JobStateCounts.
- Returns
The running of this JobStateCounts.
- Return type
int
-
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
-
property
flywheel.models.job_stats_by_state module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_stats_by_state.JobStatsByState(pending=None, running=None, failed=None, complete=None, cancelled=None)¶ Bases:
object-
property
cancelled¶ Gets the cancelled of this JobStatsByState.
- Returns
The cancelled of this JobStatsByState.
- Return type
int
-
property
complete¶ Gets the complete of this JobStatsByState.
- Returns
The complete of this JobStatsByState.
- Return type
int
-
property
failed¶ Gets the failed of this JobStatsByState.
- Returns
The failed of this JobStatsByState.
- Return type
int
-
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
-
property
pending¶ Gets the pending of this JobStatsByState.
- Returns
The pending of this JobStatsByState.
- Return type
int
-
property
running¶ Gets the running of this JobStatsByState.
- Returns
The running of this JobStatsByState.
- Return type
int
-
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
-
property
flywheel.models.job_ticket_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_ticket_output.JobTicketOutput(ticket=None)¶ Bases:
object-
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
-
property
ticket¶ Gets the ticket of this JobTicketOutput.
The ticket to use to perform file uploads to a job
- Returns
The ticket of this JobTicketOutput.
- Return type
str
-
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
-
flywheel.models.job_transition_times module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_transition_times.JobTransitionTimes(running=None, failed=None, complete=None, cancelled=None)¶ Bases:
object-
property
cancelled¶ Gets the cancelled of this JobTransitionTimes.
The timestamp when the job transitioned into the cancelled state
- Returns
The cancelled of this JobTransitionTimes.
- Return type
datetime
-
property
complete¶ Gets the complete of this JobTransitionTimes.
The timestamp when the job transitioned into the complete state
- Returns
The complete of this JobTransitionTimes.
- Return type
datetime
-
property
failed¶ Gets the failed of this JobTransitionTimes.
The timestamp when the job transitioned into the failed state
- Returns
The failed of this JobTransitionTimes.
- Return type
datetime
-
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
-
property
running¶ Gets the running of this JobTransitionTimes.
The timestamp when the job transitioned into the running state
- Returns
The running of this JobTransitionTimes.
- Return type
datetime
-
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
-
property
flywheel.models.job_version_info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_version_info.JobVersionInfo¶ Bases:
object-
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
-
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
-
flywheel.models.jobs_by_state module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.jobs_by_state.JobsByState(pending=0, running=0, failed=0, complete=0, cancelled=0)¶ Bases:
object-
property
cancelled¶ Gets the cancelled of this JobsByState.
- Returns
The cancelled of this JobsByState.
- Return type
int
-
property
complete¶ Gets the complete of this JobsByState.
- Returns
The complete of this JobsByState.
- Return type
int
-
property
failed¶ Gets the failed of this JobsByState.
- Returns
The failed of this JobsByState.
- Return type
int
-
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
-
property
pending¶ Gets the pending of this JobsByState.
- Returns
The pending of this JobsByState.
- Return type
int
-
property
running¶ Gets the running of this JobsByState.
- Returns
The running of this JobsByState.
- Return type
int
-
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
-
property
flywheel.models.jobs_list module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.jobs_list.JobsList(jobs=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
jobs¶ Gets the jobs of this JobsList.
- Returns
The jobs of this JobsList.
- Return type
list[JobListOutput]
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.join_origin_device module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.join_origin_device.JoinOriginDevice(name=None)¶ Bases:
object-
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
-
property
name¶ Gets the name of this JoinOriginDevice.
- Returns
The name of this JoinOriginDevice.
- Return type
str
-
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
-
flywheel.models.join_origin_job module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.join_origin_job.JoinOriginJob(created=None, modified=None, gear_info=None)¶ Bases:
object-
property
created¶ Gets the created of this JoinOriginJob.
- Returns
The created of this JoinOriginJob.
- Return type
datetime
-
property
gear_info¶ Gets the gear_info of this JoinOriginJob.
- Returns
The gear_info of this JoinOriginJob.
- Return type
-
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
-
property
modified¶ Gets the modified of this JoinOriginJob.
- Returns
The modified of this JoinOriginJob.
- Return type
datetime
-
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
-
property
flywheel.models.join_origin_user module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.join_origin_user.JoinOriginUser(firstname=None, lastname=None)¶ Bases:
object-
property
firstname¶ Gets the firstname of this JoinOriginUser.
- Returns
The firstname of this JoinOriginUser.
- Return type
str
-
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
-
property
lastname¶ Gets the lastname of this JoinOriginUser.
- Returns
The lastname of this JoinOriginUser.
- Return type
str
-
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
-
property
flywheel.models.join_origins module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.join_origins.JoinOrigins(device=None, job=None, user=None)¶ Bases:
object-
property
device¶ Gets the device of this JoinOrigins.
- Returns
The device of this JoinOrigins.
- Return type
dict(str, JoinOriginDevice)
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this JoinOrigins.
- Returns
The job of this JoinOrigins.
- Return type
dict(str, JoinOriginJob)
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
user¶ Gets the user of this JoinOrigins.
- Returns
The user of this JoinOrigins.
- Return type
dict(str, JoinOriginUser)
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.join_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.ldap_sync module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.ldap_sync.LdapSync(group_dn=None, sync_error=None, last_attempt=None, last_success=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group_dn¶ Gets the group_dn of this LdapSync.
- Returns
The group_dn of this LdapSync.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
last_attempt¶ Gets the last_attempt of this LdapSync.
- Returns
The last_attempt of this LdapSync.
- Return type
str
-
property
last_success¶ Gets the last_success of this LdapSync.
- Returns
The last_success of this LdapSync.
- Return type
str
-
property
sync_error¶ Gets the sync_error of this LdapSync.
- Returns
The sync_error of this LdapSync.
- Return type
str
-
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
-
flywheel.models.ldap_sync_config module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.ldap_sync_config.LdapSyncConfig(group_dn=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group_dn¶ Gets the group_dn of this LdapSyncConfig.
- Returns
The group_dn of this LdapSyncConfig.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.ldap_sync_data module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.ldap_sync_data.LdapSyncData(users=None, error=None)¶ Bases:
object-
property
error¶ Gets the error of this LdapSyncData.
- Returns
The error of this LdapSyncData.
- Return type
str
-
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
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
users¶ Gets the users of this LdapSyncData.
- Returns
The users of this LdapSyncData.
- Return type
list[LdapSyncLdapUser]
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.ldap_sync_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.ldap_sync_input.LdapSyncInput(group_dn=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group_dn¶ Gets the group_dn of this LdapSyncInput.
- Returns
The group_dn of this LdapSyncInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.ldap_sync_ldap_user module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.ldap_sync_ldap_user.LdapSyncLdapUser(uid=None, firstname=None, lastname=None)¶ Bases:
object-
property
firstname¶ Gets the firstname of this LdapSyncLdapUser.
- Returns
The firstname of this LdapSyncLdapUser.
- Return type
str
-
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
-
property
lastname¶ Gets the lastname of this LdapSyncLdapUser.
- Returns
The lastname of this LdapSyncLdapUser.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this LdapSyncLdapUser.
- Returns
The uid of this LdapSyncLdapUser.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.ldap_sync_status module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.ldap_sync_status.LdapSyncStatus(group_dn=None, last_attempt=None, last_success=None, sync_error=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group_dn¶ Gets the group_dn of this LdapSyncStatus.
- Returns
The group_dn of this LdapSyncStatus.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
last_attempt¶ Gets the last_attempt of this LdapSyncStatus.
- Returns
The last_attempt of this LdapSyncStatus.
- Return type
datetime
-
property
last_success¶ Gets the last_success of this LdapSyncStatus.
- Returns
The last_success of this LdapSyncStatus.
- Return type
datetime
-
property
sync_error¶ Gets the sync_error of this LdapSyncStatus.
- Returns
The sync_error of this LdapSyncStatus.
- Return type
str
-
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
-
flywheel.models.legacy_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.legacy_input.LegacyInput(input=None, type=None, id=None, name=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this LegacyInput.
- Returns
The id of this LegacyInput.
- Return type
str
-
property
input¶ Gets the input of this LegacyInput.
- Returns
The input of this LegacyInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
name¶ Gets the name of this LegacyInput.
- Returns
The name of this LegacyInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this LegacyInput.
- Returns
The type of this LegacyInput.
- Return type
-
values()¶ Returns the list of values in the object
-
flywheel.models.local_storage module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.local_storage.LocalStorage(path=None, config_type=None, config_class=None)¶ Bases:
object-
property
config_class¶ Gets the config_class of this LocalStorage.
- Returns
The config_class of this LocalStorage.
- Return type
str
-
property
config_type¶ Gets the config_type of this LocalStorage.
- Returns
The config_type of this LocalStorage.
- Return type
str
-
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
-
property
path¶ Gets the path of this LocalStorage.
- Returns
The path of this LocalStorage.
- Return type
str
-
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
-
property
flywheel.models.location module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.location.Location(path=None, name=None)¶ Bases:
object-
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
-
property
name¶ Gets the name of this Location.
- Returns
The name of this Location.
- Return type
str
-
property
path¶ Gets the path of this Location.
- Returns
The path of this Location.
- Return type
str
-
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
-
flywheel.models.locked module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.locked.Locked(reason=None, timestamp=None, origin=None)¶ Bases:
object-
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
-
property
origin¶ Gets the origin of this Locked.
- Returns
The origin of this Locked.
- Return type
-
property
reason¶ Gets the reason of this Locked.
- Returns
The reason of this Locked.
- Return type
-
property
timestamp¶ Gets the timestamp of this Locked.
- Returns
The timestamp of this Locked.
- Return type
datetime
-
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
-
flywheel.models.master_subject_code_code_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.master_subject_code_code_output.MasterSubjectCodeCodeOutput(code=None)¶ Bases:
object-
property
code¶ Gets the code of this MasterSubjectCodeCodeOutput.
Master subject code
- Returns
The code of this MasterSubjectCodeCodeOutput.
- Return type
str
-
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
-
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
-
property
flywheel.models.master_subject_code_dob_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.master_subject_code_dob_input.MasterSubjectCodeDobInput(first_name=None, last_name=None, date_of_birth=None, patient_id=None, use_patient_id=None)¶ Bases:
object-
property
date_of_birth¶ Gets the date_of_birth of this MasterSubjectCodeDobInput.
Date of birth in YYYY-MM-DD format
- Returns
The date_of_birth of this MasterSubjectCodeDobInput.
- Return type
str
-
property
first_name¶ Gets the first_name of this MasterSubjectCodeDobInput.
First name
- Returns
The first_name of this MasterSubjectCodeDobInput.
- Return type
str
-
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
-
property
last_name¶ Gets the last_name of this MasterSubjectCodeDobInput.
Last name
- Returns
The last_name of this MasterSubjectCodeDobInput.
- Return type
str
-
property
patient_id¶ Gets the patient_id of this MasterSubjectCodeDobInput.
Patient id
- Returns
The patient_id of this MasterSubjectCodeDobInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
use_patient_id¶ Gets the use_patient_id of this MasterSubjectCodeDobInput.
Use patient ID for identification or first name, last name, DOB
- Returns
The use_patient_id of this MasterSubjectCodeDobInput.
- Return type
bool
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.master_subject_code_id_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.master_subject_code_id_input.MasterSubjectCodeIdInput(first_name=None, last_name=None, date_of_birth=None, patient_id=None, use_patient_id=None)¶ Bases:
object-
property
date_of_birth¶ Gets the date_of_birth of this MasterSubjectCodeIdInput.
Date of birth in YYYY-MM-DD format
- Returns
The date_of_birth of this MasterSubjectCodeIdInput.
- Return type
str
-
property
first_name¶ Gets the first_name of this MasterSubjectCodeIdInput.
First name
- Returns
The first_name of this MasterSubjectCodeIdInput.
- Return type
str
-
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
-
property
last_name¶ Gets the last_name of this MasterSubjectCodeIdInput.
Last name
- Returns
The last_name of this MasterSubjectCodeIdInput.
- Return type
str
-
property
patient_id¶ Gets the patient_id of this MasterSubjectCodeIdInput.
Patient id
- Returns
The patient_id of this MasterSubjectCodeIdInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
use_patient_id¶ Gets the use_patient_id of this MasterSubjectCodeIdInput.
Use patient ID for identification or first name, last name, DOB
- Returns
The use_patient_id of this MasterSubjectCodeIdInput.
- Return type
bool
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.mixins module¶
-
class
flywheel.models.mixins.AcquisitionMixin¶ Bases:
flywheel.models.mixins.ContainerBase,flywheel.models.mixins.NoteMethods,flywheel.models.mixins.TagMethods,flywheel.models.mixins.FileMethods,flywheel.models.mixins.InfoMethods,flywheel.models.mixins.TimestampMethods,flywheel.models.mixins.DownloadMethods,flywheel.models.mixins.AnalysisMethods-
child_types= ['analyses', 'files']¶
-
container_type= 'acquisition'¶
-
-
class
flywheel.models.mixins.AnalysisMethods¶ Bases:
object-
add_analysis(*args, **kwargs)¶ Add an analysis to this container
-
-
class
flywheel.models.mixins.AnalysisMixin¶ Bases:
flywheel.models.mixins.ContainerBase,flywheel.models.mixins.NoteMethods,flywheel.models.mixins.TagMethods,flywheel.models.mixins.FileMethods,flywheel.models.mixins.InfoMethods,flywheel.models.mixins.DownloadMethods-
child_types= ['files']¶
-
container_type= 'analysis'¶
-
upload_file(file)¶ Upload an output file to analysis
-
upload_output(file)¶ Upload an output file to analysis
-
-
class
flywheel.models.mixins.BatchMixin¶ Bases:
flywheel.models.mixins.ContextBaseBatch mixin that provides cancel shorthand
-
cancel()¶ Cancel the batch proposal and any associated jobs
-
-
class
flywheel.models.mixins.BatchProposalMixin¶ Bases:
flywheel.models.mixins.ContextBaseBatch mixin that provides run/cancel shorthand
-
run()¶ Execute the batch proposal
-
-
class
flywheel.models.mixins.CollectionMixin¶ Bases:
flywheel.models.mixins.ContainerBase,flywheel.models.mixins.NoteMethods,flywheel.models.mixins.TagMethods,flywheel.models.mixins.FileMethods,flywheel.models.mixins.InfoMethods-
add_acquisitions(*args, **kwargs)¶
-
add_sessions(*args, **kwargs)¶
-
child_types= ['sessions', 'acquisitions', 'analyses', 'files']¶
-
container_type= 'collection'¶
-
-
class
flywheel.models.mixins.ContainerBase¶ Bases:
object-
property
local_created¶ Get the creation time in the local timezone
-
property
local_modified¶ Get the modification time in the local timezone
-
ref()¶ Make a container reference
-
reload()¶ Reload the object from the server, and return the result
-
update(*args, **kwargs)¶ Update container using dictionary or kwargs
-
property
-
class
flywheel.models.mixins.ContextBase¶ Bases:
object
-
class
flywheel.models.mixins.DownloadMethods¶ Bases:
object-
download_tar(dest_file, include_types=None, exclude_types=None)¶ Download the container as a tarball to dest_file.
- Parameters
dest_file (str) – (required) The destination file on disk
include_types (list) – The optional list of types to include in the download (e.g. [‘nifti’])
exclude_types (list) – The optional list of types to exclude from the download (e.g. [‘dicom’])
- Returns
A summary of the download
-
download_zip(dest_file, include_types=None, exclude_types=None)¶ Download the container as a zip archive to dest_file.
- Parameters
dest_file (str) – (required) The destination file on disk
include_types (list) – The optional list of types to include in the download (e.g. [‘nifti’])
exclude_types (list) – The optional list of types to exclude from the download (e.g. [‘dicom’])
- Returns
A summary of the download
-
-
class
flywheel.models.mixins.FileMethods¶ Bases:
object-
delete_file(file_name)¶ Delete file from the container
-
delete_file_classification(file_name, classification)¶ Delete a file’s classification fields
-
delete_file_info(file_name, *args)¶ Delete the file info fields listed in args
-
download_file(file_name, dest_file)¶ Download file to the given path
-
download_file_zip_member(file_name, member_path, dest_file)¶ Download file’s zip member to the given path
-
file_ref(name)¶ Get a reference to the given file
-
get_file(name)¶ Get the first file entry with the given name, retrieving the container if necessary
-
get_file_download_url(file_name)¶ Get a ticketed download url for the file
-
get_file_zip_info(file_name)¶ Get zip member information for this file
-
get_files()¶ Get the files collection, retrieving the container if necessary
-
read_file(file_name)¶ Read the contents of the file
-
read_file_zip_member(file_name, member_path)¶ Read contents of file’s zip member
-
replace_file_classification(file_name, classification, modality=None)¶ Fully replace a file’s modality and classification
-
replace_file_info(file_name, info)¶ Fully replace this file’s info with the provided value
-
update_file(file_name, *args, **kwargs)¶ Update a file’s type and/or modality
-
update_file_classification(file_name, classification)¶ Update a file’s classification
-
update_file_info(file_name, *args, **kwargs)¶ Update the file’s info with the passed in arguments
-
upload_file(file)¶ Upload a file to a container
-
-
class
flywheel.models.mixins.FileMixin¶ Bases:
flywheel.models.mixins.ContainerBase-
add_tag(tag)¶ Add the given tag to the file
Add the tags to the tags list on the file
-
child_types= []¶
-
container_type= 'file'¶
-
delete_classification(classification)¶ Delete a file’s classification fields
-
delete_info(*args)¶ Delete the file info fields listed in args
-
delete_tag(tag)¶ Delete tag from file
-
download(dest_file)¶ Download file to the given path
-
download_zip_member(member_path, dest_file)¶ Download file’s zip member to the given path
-
get_zip_info()¶ Get zip member information for this file
-
property
local_replaced¶ Get the replaced timestamp in local time
-
property
parent¶
-
read()¶ Read the contents of the file
-
read_zip_member(member_path)¶ Read contents of file’s zip member
-
ref()¶ Make a file reference
-
reload()¶ Reload the file.
-
rename_tag(tag, new_tag)¶ Rename tag on file
-
replace_classification(classification, modality=None)¶ Fully replace a file’s modality and classification
-
replace_info(info)¶ Fully replace this file’s info with the provided value
Set the tags list on the file
-
update(*args, **kwargs)¶ Update a file’s type and/or modality
-
update_classification(classification)¶ Update a file’s classification
-
update_info(*args, **kwargs)¶ Update the file’s info with the passed in arguments
-
url()¶ Get a ticketed download url for the file
-
-
class
flywheel.models.mixins.GroupMixin¶ Bases:
flywheel.models.mixins.ContainerBase,flywheel.models.mixins.TagMethods,flywheel.models.mixins.PermissionMethods-
add_permission_template(permission, **kwargs)¶ Add a permission template for a group
-
add_project(*args, **kwargs)¶ Add a project to this group
-
child_types= ['projects']¶
-
container_type= 'group'¶
-
delete_permission_template(user_id, **kwargs)¶ Delete a user’s permission template from a group
-
get_permission_template(user_id, **kwargs)¶ Get a user’s permission template for a group
-
update_permission_template(user_id, permission, **kwargs)¶ Update a user’s permission template for a group
-
-
class
flywheel.models.mixins.InfoMethods¶ Bases:
object-
delete_info(*args)¶ Delete the info fields listed in args
-
replace_info(info)¶ Fully replace this object’s info with the provided value
-
update_info(*args, **kwargs)¶ Update the info with the passed in arguments
-
-
class
flywheel.models.mixins.JobMixin¶ Bases:
flywheel.models.mixins.ContainerBase-
change_state(new_state)¶ Change the state of the job to new_state
-
child_types= []¶
-
container_type= 'job'¶
-
get_logs()¶ Get the job log entries
-
print_logs(file=None)¶ Print logs to file (or stdout, if file is not specified)
-
update_priority(priority)¶ Update priority of jobs
-
-
class
flywheel.models.mixins.NoteMethods¶ Bases:
object-
add_note(message)¶ Add the given note to the object
-
delete_note(note_id)¶ Delete the given note on the object
-
-
class
flywheel.models.mixins.PermissionMethods¶ Bases:
object-
add_permission(permission)¶ Add a permission to a container
-
delete_permission(user_id)¶ Delete a user’s permission from container
-
get_permission(user_id)¶ Get a user’s permission from container
-
update_permission(user_id, permission)¶ Update a user’s permission on container
-
-
class
flywheel.models.mixins.ProjectMixin¶ Bases:
flywheel.models.mixins.ContainerBase,flywheel.models.mixins.TagMethods,flywheel.models.mixins.NoteMethods,flywheel.models.mixins.PermissionMethods,flywheel.models.mixins.FileMethods,flywheel.models.mixins.InfoMethods,flywheel.models.mixins.DownloadMethods,flywheel.models.mixins.AnalysisMethods-
add_session(*args, **kwargs)¶ Add a session to this project
-
add_subject(*args, **kwargs)¶ Add a subject to this project
-
child_types= ['subjects', 'sessions', 'analyses', 'files']¶
-
container_type= 'project'¶
-
-
class
flywheel.models.mixins.ResolverOutputMixin¶ Bases:
object
-
class
flywheel.models.mixins.SearchResponseMixin¶ Bases:
object
-
class
flywheel.models.mixins.SessionMixin¶ Bases:
flywheel.models.mixins.ContainerBase,flywheel.models.mixins.TagMethods,flywheel.models.mixins.NoteMethods,flywheel.models.mixins.FileMethods,flywheel.models.mixins.InfoMethods,flywheel.models.mixins.TimestampMethods,flywheel.models.mixins.DownloadMethods,flywheel.models.mixins.AnalysisMethods-
add_acquisition(*args, **kwargs)¶ Add a acquisition to this session
-
property
age_days¶
-
property
age_months¶
-
property
age_weeks¶
-
property
age_years¶
-
child_types= ['acquisitions', 'analyses', 'files']¶
-
container_type= 'session'¶
-
-
class
flywheel.models.mixins.SubjectMixin¶ Bases:
flywheel.models.mixins.ContainerBase,flywheel.models.mixins.TagMethods,flywheel.models.mixins.NoteMethods,flywheel.models.mixins.FileMethods,flywheel.models.mixins.InfoMethods,flywheel.models.mixins.AnalysisMethods-
add_session(*args, **kwargs)¶ Add a session to this subject
-
child_types= ['sessions', 'analyses', 'files']¶
-
container_type= 'subject'¶
-
flywheel.models.ml_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.modality module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.modality.Modality(id=None, classification=None, description=None, active=None)¶ Bases:
object-
property
active¶ Gets the active of this Modality.
- Returns
The active of this Modality.
- Return type
bool
-
property
classification¶ Gets the classification of this Modality.
- Returns
The classification of this Modality.
- Return type
-
property
description¶ Gets the description of this Modality.
- Returns
The description of this Modality.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this Modality.
Unique database ID
- Returns
The id of this Modality.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.modality_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.modality_input.ModalityInput(classification=None, active=None, description=None, id=None)¶ Bases:
object-
property
active¶ Gets the active of this ModalityInput.
- Returns
The active of this ModalityInput.
- Return type
bool
-
property
classification¶ Gets the classification of this ModalityInput.
- Returns
The classification of this ModalityInput.
- Return type
dict(str, list[str])
-
property
description¶ Gets the description of this ModalityInput.
- Returns
The description of this ModalityInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ModalityInput.
- Returns
The id of this ModalityInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.modality_modify module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.modality_modify.ModalityModify(classification=None, active=None, description=None)¶ Bases:
object-
property
active¶ Gets the active of this ModalityModify.
- Returns
The active of this ModalityModify.
- Return type
bool
-
property
classification¶ Gets the classification of this ModalityModify.
- Returns
The classification of this ModalityModify.
- Return type
dict(str, list[str])
-
property
description¶ Gets the description of this ModalityModify.
- Returns
The description of this ModalityModify.
- Return type
str
-
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
-
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
-
property
flywheel.models.modality_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.modality_output.ModalityOutput(id=None, classification=None, active=None, description=None, rts_managed=None)¶ Bases:
object-
property
active¶ Gets the active of this ModalityOutput.
- Returns
The active of this ModalityOutput.
- Return type
bool
-
property
classification¶ Gets the classification of this ModalityOutput.
- Returns
The classification of this ModalityOutput.
- Return type
dict(str, list[str])
-
property
description¶ Gets the description of this ModalityOutput.
- Returns
The description of this ModalityOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ModalityOutput.
- Returns
The id of this ModalityOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
rts_managed¶ Gets the rts_managed of this ModalityOutput.
- Returns
The rts_managed of this ModalityOutput.
- Return type
bool
-
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
-
property
flywheel.models.modified_result module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.modified_result.ModifiedResult(modified=None, jobs_spawned=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
jobs_spawned¶ Gets the jobs_spawned of this ModifiedResult.
- Returns
The jobs_spawned of this ModifiedResult.
- Return type
int
-
keys()¶ Returns the list of json properties in the object
-
property
modified¶ Gets the modified of this ModifiedResult.
- Returns
The modified of this ModifiedResult.
- Return type
int
-
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
-
flywheel.models.modify_report_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.modify_report_input.ModifyReportInput(status=None)¶ Bases:
object-
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
-
property
status¶ Gets the status of this ModifyReportInput.
- Returns
The status of this ModifyReportInput.
- Return type
-
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
-
flywheel.models.modify_user_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.modify_user_input.ModifyUserInput(firstname=None, lastname=None, email=None, avatars=None, avatar=None, roles=None, disabled=None, preferences=None, root=None, password=None, multifactor=None)¶ Bases:
object-
property
avatar¶ Gets the avatar of this ModifyUserInput.
- Returns
The avatar of this ModifyUserInput.
- Return type
str
-
property
avatars¶ Gets the avatars of this ModifyUserInput.
- Returns
The avatars of this ModifyUserInput.
- Return type
-
property
disabled¶ Gets the disabled of this ModifyUserInput.
- Returns
The disabled of this ModifyUserInput.
- Return type
bool
-
property
email¶ Gets the email of this ModifyUserInput.
- Returns
The email of this ModifyUserInput.
- Return type
str
-
property
firstname¶ Gets the firstname of this ModifyUserInput.
- Returns
The firstname of this ModifyUserInput.
- Return type
str
-
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
-
property
lastname¶ Gets the lastname of this ModifyUserInput.
- Returns
The lastname of this ModifyUserInput.
- Return type
str
-
property
multifactor¶ Gets the multifactor of this ModifyUserInput.
- Returns
The multifactor of this ModifyUserInput.
- Return type
-
property
password¶ Gets the password of this ModifyUserInput.
- Returns
The password of this ModifyUserInput.
- Return type
str
-
property
preferences¶ Gets the preferences of this ModifyUserInput.
- Returns
The preferences of this ModifyUserInput.
- Return type
-
property
roles¶ Gets the roles of this ModifyUserInput.
- Returns
The roles of this ModifyUserInput.
- Return type
list[RoleType]
-
property
root¶ Gets the root of this ModifyUserInput.
- Returns
The root of this ModifyUserInput.
- Return type
bool
-
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
-
property
flywheel.models.multifactor_account module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.multifactor_account.MultifactorAccount(authy_id=None, preferred_channel=None, verified=False)¶ Bases:
object-
property
authy_id¶ Gets the authy_id of this MultifactorAccount.
- Returns
The authy_id of this MultifactorAccount.
- Return type
str
-
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
-
property
preferred_channel¶ Gets the preferred_channel of this MultifactorAccount.
- Returns
The preferred_channel of this MultifactorAccount.
- Return type
-
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
-
property
verified¶ Gets the verified of this MultifactorAccount.
- Returns
The verified of this MultifactorAccount.
- Return type
bool
-
property
flywheel.models.note module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.note.Note(id=None, created=None, modified=None, timestamp=None, firstname=None, lastname=None, text=None, user=None, avatar=None)¶ Bases:
object-
property
avatar¶ Gets the avatar of this Note.
Last modification time (automatically updated)
- Returns
The avatar of this Note.
- Return type
str
-
property
created¶ Gets the created of this Note.
Creation time (automatically set)
- Returns
The created of this Note.
- Return type
datetime
-
property
firstname¶ Gets the firstname of this Note.
- Returns
The firstname of this Note.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this Note.
Unique database ID
- Returns
The id of this Note.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
lastname¶ Gets the lastname of this Note.
- Returns
The lastname of this Note.
- Return type
str
-
property
modified¶ Gets the modified of this Note.
Last modification time (automatically updated)
- Returns
The modified of this Note.
- Return type
datetime
-
property
text¶ Gets the text of this Note.
The actual contents of the note
- Returns
The text of this Note.
- Return type
str
-
property
timestamp¶ Gets the timestamp of this Note.
- Returns
The timestamp of this Note.
- Return type
datetime
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
user¶ Gets the user of this Note.
Database ID of a user
- Returns
The user of this Note.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.note_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.note_input.NoteInput(text=None)¶ Bases:
object-
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
-
property
text¶ Gets the text of this NoteInput.
- Returns
The text of this NoteInput.
- Return type
str
-
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
-
flywheel.models.open_tracing module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.open_tracing.OpenTracing(agent_host='jaeger-agent', agent_port=6831, sampler_type='const', sampler_param=1.0)¶ Bases:
object-
property
agent_host¶ Gets the agent_host of this OpenTracing.
- Returns
The agent_host of this OpenTracing.
- Return type
str
-
property
agent_port¶ Gets the agent_port of this OpenTracing.
- Returns
The agent_port of this OpenTracing.
- Return type
int
-
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
-
property
sampler_param¶ Gets the sampler_param of this OpenTracing.
- Returns
The sampler_param of this OpenTracing.
- Return type
float
-
property
sampler_type¶ Gets the sampler_type of this OpenTracing.
- Returns
The sampler_type of this OpenTracing.
- Return type
str
-
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
-
property
flywheel.models.order module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.organ_system module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.organ_system.OrganSystem¶ Bases:
str,enum.EnumAn enumeration.
-
ADRENALS= 'Adrenals'¶
-
AIRWAY= 'Airway'¶
-
BILIARY_TREE= 'Biliary Tree'¶
-
BONE_MARROW= 'Bone Marrow'¶
-
BRAIN= 'Brain'¶
-
CARDIOVASCULAR_SYSTEM= 'Cardiovascular System'¶
-
CNS= 'CNS'¶
-
ENDOCRINE_SYSTEM= 'Endocrine System'¶
-
ESOPHAGUS= 'Esophagus'¶
-
FEMALE_REPRODUCTIVE_SYSTEM= 'Female reproductive system'¶
-
GALLBLADDER= 'Gallbladder'¶
-
GASTROINTESTINAL_SYSTEM= 'Gastrointestinal System'¶
-
HEART= 'Heart'¶
-
INTEGUMENTARY_SYSTEM= 'Integumentary System'¶
-
LARGE_BOWEL= 'Large bowel'¶
-
LIVER= 'Liver'¶
-
LUNGS= 'Lungs'¶
-
LYMPHATICS= 'Lymphatics'¶
-
LYMPHATIC_SYSTEM= 'Lymphatic System'¶
-
MALE_REPRODUCTIVE_SYSTEM= 'Male reproductive system'¶
-
MUSCULOSKELETAL_SYSTEM= 'Musculoskeletal System'¶
-
NERVOUS_SYSTEM= 'Nervous System'¶
-
OCULAR_SYSTEM= 'Ocular System'¶
-
PANCREAS= 'Pancreas'¶
-
PNS= 'PNS'¶
-
REPRODUCTIVE_SYSTEM= 'Reproductive System'¶
-
RESPIRATORY_SYSTEM= 'Respiratory System'¶
-
SALIVARY_GLANDS= 'Salivary glands'¶
-
SKELETAL_MUSCLE= 'Skeletal Muscle'¶
-
SKELETON= 'Skeleton'¶
-
SMALL_BOWEL= 'Small bowel'¶
-
SMOOTH_MUSCLE= 'Smooth Muscle'¶
-
SPLEEN= 'Spleen'¶
-
STOMACH= 'Stomach'¶
-
THYROID= 'Thyroid'¶
-
URINARY_SYSTEM= 'Urinary System'¶
-
VASCULAR_SYSTEM= 'Vascular System'¶
-
flywheel.models.origin module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.origin.Origin(type=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this Origin.
- Returns
The id of this Origin.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this Origin.
- Returns
The type of this Origin.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.origin_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.orphaned_count module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.orphaned_count.OrphanedCount(orphaned=None)¶ Bases:
object-
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
-
property
orphaned¶ Gets the orphaned of this OrphanedCount.
- Returns
The orphaned of this OrphanedCount.
- Return type
int
-
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
-
flywheel.models.output_user_page module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.output_user_page.OutputUserPage(count=None, total=None, results=None)¶ Bases:
object-
property
count¶ Gets the count of this OutputUserPage.
- Returns
The count of this OutputUserPage.
- Return type
int
-
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
-
property
results¶ Gets the results of this OutputUserPage.
- Returns
The results of this OutputUserPage.
- Return type
list[UserOutput]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
total¶ Gets the total of this OutputUserPage.
- Returns
The total of this OutputUserPage.
- Return type
int
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.packfile module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.packfile.Packfile(project=None, session=None, acquisition=None, packfile=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this Packfile.
- Returns
The acquisition of this Packfile.
- Return type
-
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
-
property
packfile¶ Gets the packfile of this Packfile.
- Returns
The packfile of this Packfile.
- Return type
-
property
project¶ Gets the project of this Packfile.
- Returns
The project of this Packfile.
- Return type
-
property
session¶ Gets the session of this Packfile.
- Returns
The session of this Packfile.
- Return type
-
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
-
property
flywheel.models.packfile_acquisition_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.packfile_acquisition_input.PackfileAcquisitionInput(label=None, timestamp=None, timezone=None)¶ Bases:
object-
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
-
property
label¶ Gets the label of this PackfileAcquisitionInput.
- Returns
The label of this PackfileAcquisitionInput.
- Return type
str
-
property
timestamp¶ Gets the timestamp of this PackfileAcquisitionInput.
- Returns
The timestamp of this PackfileAcquisitionInput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this PackfileAcquisitionInput.
- Returns
The timezone of this PackfileAcquisitionInput.
- Return type
str
-
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
-
flywheel.models.packfile_packfile_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.packfile_packfile_input.PackfilePackfileInput(type=None, deid_log_id=None)¶ Bases:
object-
property
deid_log_id¶ Gets the deid_log_id of this PackfilePackfileInput.
- Returns
The deid_log_id of this PackfilePackfileInput.
- Return type
str
-
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
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this PackfilePackfileInput.
- Returns
The type of this PackfilePackfileInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.packfile_project_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.packfile_project_input.PackfileProjectInput(id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this PackfileProjectInput.
- Returns
The id of this PackfileProjectInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.packfile_session_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.packfile_session_input.PackfileSessionInput(label=None, subject=None)¶ Bases:
object-
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
-
property
label¶ Gets the label of this PackfileSessionInput.
- Returns
The label of this PackfileSessionInput.
- Return type
str
-
property
subject¶ Gets the subject of this PackfileSessionInput.
- Returns
The subject of this PackfileSessionInput.
- Return type
Subject
-
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
-
flywheel.models.packfile_start module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.packfile_start.PackfileStart(token=None)¶ Bases:
object-
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
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
token¶ Gets the token of this PackfileStart.
- Returns
The token of this PackfileStart.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.page module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.page.Page(count=None, total=None, results=None)¶ Bases:
object-
property
count¶ Gets the count of this Page.
- Returns
The count of this Page.
- Return type
int
-
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
-
property
results¶ Gets the results of this Page.
- Returns
The results of this Page.
- Return type
list[Object]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
total¶ Gets the total of this Page.
- Returns
The total of this Page.
- Return type
int
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.permission_access_permission module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.permission_access_permission.PermissionAccessPermission(id=None, access=None)¶ Bases:
object-
property
access¶ Gets the access of this PermissionAccessPermission.
- Returns
The access of this PermissionAccessPermission.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this PermissionAccessPermission.
Database ID of a user
- Returns
The id of this PermissionAccessPermission.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.premade_jobs_batch_proposal module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.premade_jobs_batch_proposal.PremadeJobsBatchProposal(id=None, proposal=None, origin=None, jobs=None, state=None, created=None, modified=None)¶ Bases:
flywheel.models.mixins.BatchProposalMixin-
property
created¶ Gets the created of this PremadeJobsBatchProposal.
Creation time (automatically set)
- Returns
The created of this PremadeJobsBatchProposal.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this PremadeJobsBatchProposal.
Unique database ID
- Returns
The id of this PremadeJobsBatchProposal.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
property
jobs¶ Gets the jobs of this PremadeJobsBatchProposal.
- Returns
The jobs of this PremadeJobsBatchProposal.
- Return type
list[str]
-
keys()¶ Returns the list of json properties in the object
-
property
modified¶ Gets the modified of this PremadeJobsBatchProposal.
Last modification time (automatically updated)
- Returns
The modified of this PremadeJobsBatchProposal.
- Return type
datetime
-
property
origin¶ Gets the origin of this PremadeJobsBatchProposal.
- Returns
The origin of this PremadeJobsBatchProposal.
- Return type
-
property
proposal¶ Gets the proposal of this PremadeJobsBatchProposal.
- Returns
The proposal of this PremadeJobsBatchProposal.
- Return type
-
property
state¶ Gets the state of this PremadeJobsBatchProposal.
- Returns
The state of this PremadeJobsBatchProposal.
- Return type
-
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
-
property
flywheel.models.premade_jobs_batch_proposal_detail module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.premade_jobs_batch_proposal_detail.PremadeJobsBatchProposalDetail(preconstructed_jobs=None)¶ Bases:
object-
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
-
property
preconstructed_jobs¶ Gets the preconstructed_jobs of this PremadeJobsBatchProposalDetail.
- Returns
The preconstructed_jobs of this PremadeJobsBatchProposalDetail.
- Return type
list[InputJob]
-
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
-
flywheel.models.premade_jobs_batch_proposal_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.premade_jobs_batch_proposal_input.PremadeJobsBatchProposalInput(jobs=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
jobs¶ Gets the jobs of this PremadeJobsBatchProposalInput.
- Returns
The jobs of this PremadeJobsBatchProposalInput.
- Return type
list[InputJob]
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.project module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.project_acquisition_upsert_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_acquisition_upsert_input.ProjectAcquisitionUpsertInput(id=None, uid=None, label=None, timestamp=None, timezone=None, info=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ProjectAcquisitionUpsertInput.
- Returns
The id of this ProjectAcquisitionUpsertInput.
- Return type
str
-
property
info¶ Gets the info of this ProjectAcquisitionUpsertInput.
- Returns
The info of this ProjectAcquisitionUpsertInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectAcquisitionUpsertInput.
- Returns
The label of this ProjectAcquisitionUpsertInput.
- Return type
str
-
property
timestamp¶ Gets the timestamp of this ProjectAcquisitionUpsertInput.
- Returns
The timestamp of this ProjectAcquisitionUpsertInput.
- Return type
str
-
property
timezone¶ Gets the timezone of this ProjectAcquisitionUpsertInput.
- Returns
The timezone of this ProjectAcquisitionUpsertInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this ProjectAcquisitionUpsertInput.
- Returns
The uid of this ProjectAcquisitionUpsertInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.project_acquisition_upsert_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_acquisition_upsert_output.ProjectAcquisitionUpsertOutput(id=None, uid=None, label=None, upsert_result=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ProjectAcquisitionUpsertOutput.
- Returns
The id of this ProjectAcquisitionUpsertOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectAcquisitionUpsertOutput.
- Returns
The label of this ProjectAcquisitionUpsertOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this ProjectAcquisitionUpsertOutput.
- Returns
The uid of this ProjectAcquisitionUpsertOutput.
- Return type
str
-
property
upsert_result¶ Gets the upsert_result of this ProjectAcquisitionUpsertOutput.
- Returns
The upsert_result of this ProjectAcquisitionUpsertOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.project_aet module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_aet.ProjectAET(id=None, created=None, aet=None, creator=None, host=None, port=None, project_id=None)¶ Bases:
object-
property
aet¶ Gets the aet of this ProjectAET.
- Returns
The aet of this ProjectAET.
- Return type
str
-
property
created¶ Gets the created of this ProjectAET.
- Returns
The created of this ProjectAET.
- Return type
datetime
-
property
creator¶ Gets the creator of this ProjectAET.
- Returns
The creator of this ProjectAET.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
host¶ Gets the host of this ProjectAET.
- Returns
The host of this ProjectAET.
- Return type
str
-
property
id¶ Gets the id of this ProjectAET.
- Returns
The id of this ProjectAET.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
port¶ Gets the port of this ProjectAET.
- Returns
The port of this ProjectAET.
- Return type
int
-
property
project_id¶ Gets the project_id of this ProjectAET.
- Returns
The project_id of this ProjectAET.
- Return type
str
-
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
-
property
flywheel.models.project_aet_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_aet_input.ProjectAETInput(aet=None, created=None, creator=None, project_id=None)¶ Bases:
object-
property
aet¶ Gets the aet of this ProjectAETInput.
- Returns
The aet of this ProjectAETInput.
- Return type
str
-
property
created¶ Gets the created of this ProjectAETInput.
- Returns
The created of this ProjectAETInput.
- Return type
datetime
-
property
creator¶ Gets the creator of this ProjectAETInput.
- Returns
The creator of this ProjectAETInput.
- Return type
str
-
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
-
property
project_id¶ Gets the project_id of this ProjectAETInput.
- Returns
The project_id of this ProjectAETInput.
- Return type
str
-
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
-
property
flywheel.models.project_catalog_list_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_catalog_list_output.ProjectCatalogListOutput(id=None, label=None, tags=None, summary=None, therapeutic_areas=None, body_regions=None, organ_systems=None, project_institutions=None, project_contacts=None, stats=None)¶ Bases:
object-
property
body_regions¶ Gets the body_regions of this ProjectCatalogListOutput.
- Returns
The body_regions of this ProjectCatalogListOutput.
- Return type
list[str]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ProjectCatalogListOutput.
Unique database ID
- Returns
The id of this ProjectCatalogListOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectCatalogListOutput.
Application-specific label
- Returns
The label of this ProjectCatalogListOutput.
- Return type
str
-
property
organ_systems¶ Gets the organ_systems of this ProjectCatalogListOutput.
- Returns
The organ_systems of this ProjectCatalogListOutput.
- Return type
list[str]
-
property
project_contacts¶ Gets the project_contacts of this ProjectCatalogListOutput.
- Returns
The project_contacts of this ProjectCatalogListOutput.
- Return type
-
property
project_institutions¶ Gets the project_institutions of this ProjectCatalogListOutput.
- Returns
The project_institutions of this ProjectCatalogListOutput.
- Return type
-
property
stats¶ Gets the stats of this ProjectCatalogListOutput.
- Returns
The stats of this ProjectCatalogListOutput.
- Return type
-
property
summary¶ Gets the summary of this ProjectCatalogListOutput.
- Returns
The summary of this ProjectCatalogListOutput.
- Return type
str
Gets the tags of this ProjectCatalogListOutput.
Array of application-specific tags
- Returns
The tags of this ProjectCatalogListOutput.
- Return type
list[str]
-
property
therapeutic_areas¶ Gets the therapeutic_areas of this ProjectCatalogListOutput.
- Returns
The therapeutic_areas of this ProjectCatalogListOutput.
- Return type
list[str]
-
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
-
property
flywheel.models.project_contact module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_contact.ProjectContact(name=None, email=None)¶ Bases:
object-
property
email¶ Gets the email of this ProjectContact.
- Returns
The email of this ProjectContact.
- Return type
str
-
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
-
property
name¶ Gets the name of this ProjectContact.
- Returns
The name of this ProjectContact.
- Return type
str
-
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
-
property
flywheel.models.project_container_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.project_copy_filter module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_copy_filter.ProjectCopyFilter(exclude_analysis=False, exclude_notes=False, exclude_tags=False, include_rules=None, exclude_rules=None)¶ Bases:
object-
property
exclude_analysis¶ Gets the exclude_analysis of this ProjectCopyFilter.
- Returns
The exclude_analysis of this ProjectCopyFilter.
- Return type
bool
-
property
exclude_notes¶ Gets the exclude_notes of this ProjectCopyFilter.
- Returns
The exclude_notes of this ProjectCopyFilter.
- Return type
bool
-
property
exclude_rules¶ Gets the exclude_rules of this ProjectCopyFilter.
- Returns
The exclude_rules of this ProjectCopyFilter.
- Return type
list[str]
Gets the exclude_tags of this ProjectCopyFilter.
- Returns
The exclude_tags of this ProjectCopyFilter.
- Return type
bool
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
include_rules¶ Gets the include_rules of this ProjectCopyFilter.
- Returns
The include_rules of this ProjectCopyFilter.
- Return type
list[str]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.project_copy_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_copy_input.ProjectCopyInput(group_id=None, project_label=None, filter=None)¶ Bases:
object-
property
filter¶ Gets the filter of this ProjectCopyInput.
- Returns
The filter of this ProjectCopyInput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group_id¶ Gets the group_id of this ProjectCopyInput.
- Returns
The group_id of this ProjectCopyInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project_label¶ Gets the project_label of this ProjectCopyInput.
- Returns
The project_label of this ProjectCopyInput.
- Return type
str
-
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
-
property
flywheel.models.project_copy_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_copy_output.ProjectCopyOutput(task_id=None, snapshot_id=None, project_id=None)¶ Bases:
object-
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
-
property
project_id¶ Gets the project_id of this ProjectCopyOutput.
- Returns
The project_id of this ProjectCopyOutput.
- Return type
str
-
property
snapshot_id¶ Gets the snapshot_id of this ProjectCopyOutput.
- Returns
The snapshot_id of this ProjectCopyOutput.
- Return type
str
-
property
task_id¶ Gets the task_id of this ProjectCopyOutput.
- Returns
The task_id of this ProjectCopyOutput.
- Return type
str
-
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
-
flywheel.models.project_copy_status module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.project_counters module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_counters.ProjectCounters(subjects=None, sessions=None, acquisitions=None, files=None, jobs=None, analyses=None, acquisition_files=None, compliant_sessions=None)¶ Bases:
object-
property
acquisition_files¶ Gets the acquisition_files of this ProjectCounters.
- Returns
The acquisition_files of this ProjectCounters.
- Return type
int
-
property
acquisitions¶ Gets the acquisitions of this ProjectCounters.
- Returns
The acquisitions of this ProjectCounters.
- Return type
int
-
property
analyses¶ Gets the analyses of this ProjectCounters.
- Returns
The analyses of this ProjectCounters.
- Return type
int
-
property
compliant_sessions¶ Gets the compliant_sessions of this ProjectCounters.
- Returns
The compliant_sessions of this ProjectCounters.
- Return type
int
-
property
files¶ Gets the files of this ProjectCounters.
- Returns
The files of this ProjectCounters.
- Return type
int
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
jobs¶ Gets the jobs of this ProjectCounters.
- Returns
The jobs of this ProjectCounters.
- Return type
int
-
keys()¶ Returns the list of json properties in the object
-
property
sessions¶ Gets the sessions of this ProjectCounters.
- Returns
The sessions of this ProjectCounters.
- Return type
int
-
property
subjects¶ Gets the subjects of this ProjectCounters.
- Returns
The subjects of this ProjectCounters.
- Return type
int
-
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
-
property
flywheel.models.project_hierarchy_upsert_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_hierarchy_upsert_input.ProjectHierarchyUpsertInput(origin=None, subject=None, session=None, acquisition=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this ProjectHierarchyUpsertInput.
- Returns
The acquisition of this ProjectHierarchyUpsertInput.
- Return type
-
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
-
property
origin¶ Gets the origin of this ProjectHierarchyUpsertInput.
- Returns
The origin of this ProjectHierarchyUpsertInput.
- Return type
-
property
session¶ Gets the session of this ProjectHierarchyUpsertInput.
- Returns
The session of this ProjectHierarchyUpsertInput.
- Return type
-
property
subject¶ Gets the subject of this ProjectHierarchyUpsertInput.
- Returns
The subject of this ProjectHierarchyUpsertInput.
- Return type
-
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
-
property
flywheel.models.project_hierarchy_upsert_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_hierarchy_upsert_output.ProjectHierarchyUpsertOutput(subject=None, session=None, acquisition=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this ProjectHierarchyUpsertOutput.
- Returns
The acquisition of this ProjectHierarchyUpsertOutput.
- Return type
-
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
-
property
session¶ Gets the session of this ProjectHierarchyUpsertOutput.
- Returns
The session of this ProjectHierarchyUpsertOutput.
- Return type
-
property
subject¶ Gets the subject of this ProjectHierarchyUpsertOutput.
- Returns
The subject of this ProjectHierarchyUpsertOutput.
- Return type
-
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
-
property
flywheel.models.project_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_input.ProjectInput(label=None, description='', group=None, editions=None, providers=None, ldap_sync=None, permissions=None, copyable=None, info=None)¶ Bases:
object-
property
copyable¶ Gets the copyable of this ProjectInput.
- Returns
The copyable of this ProjectInput.
- Return type
bool
-
property
description¶ Gets the description of this ProjectInput.
- Returns
The description of this ProjectInput.
- Return type
str
-
property
editions¶ Gets the editions of this ProjectInput.
- Returns
The editions of this ProjectInput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ProjectInput.
- Returns
The group of this ProjectInput.
- Return type
str
-
property
info¶ Gets the info of this ProjectInput.
- Returns
The info of this ProjectInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectInput.
- Returns
The label of this ProjectInput.
- Return type
str
-
property
ldap_sync¶ Gets the ldap_sync of this ProjectInput.
- Returns
The ldap_sync of this ProjectInput.
- Return type
-
property
permissions¶ Gets the permissions of this ProjectInput.
- Returns
The permissions of this ProjectInput.
- Return type
list[RolePermission]
-
property
providers¶ Gets the providers of this ProjectInput.
- Returns
The providers of this ProjectInput.
- Return type
-
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
-
property
flywheel.models.project_institution module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_institution.ProjectInstitution(name=None, url=None)¶ Bases:
object-
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
-
property
name¶ Gets the name of this ProjectInstitution.
- Returns
The name of this ProjectInstitution.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
url¶ Gets the url of this ProjectInstitution.
- Returns
The url of this ProjectInstitution.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.project_list_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_list_output.ProjectListOutput(id=None, label=None, description=None, group=None, parents=None, editions=None, providers=None, ldap_sync=None, permissions=None, files=None, info=None, info_exists=None, notes=None, tags=None, templates=None, join_origin=None, analyses=None, locked=None, copyable=None, copy_status=None, copy_failure_reason=None, copy_of=None, original_copy_of=None, stats=None, revision=None, modified=None, created=None, settings=None)¶ Bases:
flywheel.models.mixins.ProjectMixin-
property
analyses¶ Gets the analyses of this ProjectListOutput.
- Returns
The analyses of this ProjectListOutput.
- Return type
list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]
-
property
copy_failure_reason¶ Gets the copy_failure_reason of this ProjectListOutput.
- Returns
The copy_failure_reason of this ProjectListOutput.
- Return type
str
-
property
copy_of¶ Gets the copy_of of this ProjectListOutput.
- Returns
The copy_of of this ProjectListOutput.
- Return type
str
-
property
copy_status¶ Gets the copy_status of this ProjectListOutput.
- Returns
The copy_status of this ProjectListOutput.
- Return type
str
-
property
copyable¶ Gets the copyable of this ProjectListOutput.
- Returns
The copyable of this ProjectListOutput.
- Return type
bool
-
property
created¶ Gets the created of this ProjectListOutput.
- Returns
The created of this ProjectListOutput.
- Return type
datetime
-
property
description¶ Gets the description of this ProjectListOutput.
- Returns
The description of this ProjectListOutput.
- Return type
str
-
property
editions¶ Gets the editions of this ProjectListOutput.
- Returns
The editions of this ProjectListOutput.
- Return type
-
property
files¶ Gets the files of this ProjectListOutput.
- Returns
The files of this ProjectListOutput.
- Return type
list[FileListOutput]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ProjectListOutput.
- Returns
The group of this ProjectListOutput.
- Return type
str
-
property
id¶ Gets the id of this ProjectListOutput.
- Returns
The id of this ProjectListOutput.
- Return type
str
-
property
info¶ Gets the info of this ProjectListOutput.
- Returns
The info of this ProjectListOutput.
- Return type
object
-
property
info_exists¶ Gets the info_exists of this ProjectListOutput.
- Returns
The info_exists of this ProjectListOutput.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
property
join_origin¶ Gets the join_origin of this ProjectListOutput.
- Returns
The join_origin of this ProjectListOutput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectListOutput.
- Returns
The label of this ProjectListOutput.
- Return type
str
-
property
ldap_sync¶ Gets the ldap_sync of this ProjectListOutput.
- Returns
The ldap_sync of this ProjectListOutput.
- Return type
-
property
locked¶ Gets the locked of this ProjectListOutput.
- Returns
The locked of this ProjectListOutput.
- Return type
-
property
modified¶ Gets the modified of this ProjectListOutput.
- Returns
The modified of this ProjectListOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this ProjectListOutput.
- Returns
The notes of this ProjectListOutput.
- Return type
list[Note]
-
property
original_copy_of¶ Gets the original_copy_of of this ProjectListOutput.
- Returns
The original_copy_of of this ProjectListOutput.
- Return type
str
-
property
parents¶ Gets the parents of this ProjectListOutput.
- Returns
The parents of this ProjectListOutput.
- Return type
-
property
permissions¶ Gets the permissions of this ProjectListOutput.
- Returns
The permissions of this ProjectListOutput.
- Return type
-
property
providers¶ Gets the providers of this ProjectListOutput.
- Returns
The providers of this ProjectListOutput.
- Return type
-
property
revision¶ Gets the revision of this ProjectListOutput.
- Returns
The revision of this ProjectListOutput.
- Return type
int
-
property
settings¶ Gets the settings of this ProjectListOutput.
- Returns
The settings of this ProjectListOutput.
- Return type
-
property
stats¶ Gets the stats of this ProjectListOutput.
- Returns
The stats of this ProjectListOutput.
- Return type
Gets the tags of this ProjectListOutput.
- Returns
The tags of this ProjectListOutput.
- Return type
list[str]
-
property
templates¶ Gets the templates of this ProjectListOutput.
- Returns
The templates of this ProjectListOutput.
- Return type
list[ProjectTemplate]
-
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
-
property
flywheel.models.project_locking_reason module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.project_metadata_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_metadata_input.ProjectMetadataInput(label=None, info=None, files=None, tags=None)¶ Bases:
object-
property
files¶ Gets the files of this ProjectMetadataInput.
- Returns
The files of this ProjectMetadataInput.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this ProjectMetadataInput.
- Returns
The info of this ProjectMetadataInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectMetadataInput.
- Returns
The label of this ProjectMetadataInput.
- Return type
str
Gets the tags of this ProjectMetadataInput.
Array of application-specific tags
- Returns
The tags of this ProjectMetadataInput.
- Return type
list[str]
-
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
-
property
flywheel.models.project_modify module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_modify.ProjectModify(label=None, group=None, description=None, editions=None, providers=None, ldap_sync=None, info=None, copyable=None, copy_status=None, copy_failure_reason=None)¶ Bases:
object-
property
copy_failure_reason¶ Gets the copy_failure_reason of this ProjectModify.
- Returns
The copy_failure_reason of this ProjectModify.
- Return type
str
-
property
copy_status¶ Gets the copy_status of this ProjectModify.
- Returns
The copy_status of this ProjectModify.
- Return type
-
property
copyable¶ Gets the copyable of this ProjectModify.
- Returns
The copyable of this ProjectModify.
- Return type
bool
-
property
description¶ Gets the description of this ProjectModify.
- Returns
The description of this ProjectModify.
- Return type
str
-
property
editions¶ Gets the editions of this ProjectModify.
- Returns
The editions of this ProjectModify.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ProjectModify.
- Returns
The group of this ProjectModify.
- Return type
str
-
property
info¶ Gets the info of this ProjectModify.
- Returns
The info of this ProjectModify.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectModify.
- Returns
The label of this ProjectModify.
- Return type
str
-
property
ldap_sync¶ Gets the ldap_sync of this ProjectModify.
- Returns
The ldap_sync of this ProjectModify.
- Return type
-
property
providers¶ Gets the providers of this ProjectModify.
- Returns
The providers of this ProjectModify.
- Return type
-
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
-
property
flywheel.models.project_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_output.ProjectOutput(id=None, label=None, description=None, group=None, parents=None, editions=None, providers=None, ldap_sync=None, permissions=None, files=None, info=None, info_exists=None, notes=None, tags=None, templates=None, join_origin=None, analyses=None, settings=None, locked=None, revision=None, modified=None, created=None, copyable=None, copy_status=None, copy_failure_reason=None, copy_of=None, original_copy_of=None, stats=None)¶ Bases:
flywheel.models.mixins.ProjectMixin-
property
analyses¶ Gets the analyses of this ProjectOutput.
- Returns
The analyses of this ProjectOutput.
- Return type
list[union[AnalysisOutput,AnalysisOutputInflatedJob]]
-
property
copy_failure_reason¶ Gets the copy_failure_reason of this ProjectOutput.
- Returns
The copy_failure_reason of this ProjectOutput.
- Return type
str
-
property
copy_of¶ Gets the copy_of of this ProjectOutput.
- Returns
The copy_of of this ProjectOutput.
- Return type
str
-
property
copy_status¶ Gets the copy_status of this ProjectOutput.
- Returns
The copy_status of this ProjectOutput.
- Return type
-
property
copyable¶ Gets the copyable of this ProjectOutput.
- Returns
The copyable of this ProjectOutput.
- Return type
bool
-
property
created¶ Gets the created of this ProjectOutput.
- Returns
The created of this ProjectOutput.
- Return type
datetime
-
property
description¶ Gets the description of this ProjectOutput.
- Returns
The description of this ProjectOutput.
- Return type
str
-
property
editions¶ Gets the editions of this ProjectOutput.
- Returns
The editions of this ProjectOutput.
- Return type
-
property
files¶ Gets the files of this ProjectOutput.
- Returns
The files of this ProjectOutput.
- Return type
list[FileOutput]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ProjectOutput.
- Returns
The group of this ProjectOutput.
- Return type
str
-
property
id¶ Gets the id of this ProjectOutput.
- Returns
The id of this ProjectOutput.
- Return type
str
-
property
info¶ Gets the info of this ProjectOutput.
- Returns
The info of this ProjectOutput.
- Return type
object
-
property
info_exists¶ Gets the info_exists of this ProjectOutput.
- Returns
The info_exists of this ProjectOutput.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
property
join_origin¶ Gets the join_origin of this ProjectOutput.
- Returns
The join_origin of this ProjectOutput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectOutput.
- Returns
The label of this ProjectOutput.
- Return type
str
-
property
ldap_sync¶ Gets the ldap_sync of this ProjectOutput.
- Returns
The ldap_sync of this ProjectOutput.
- Return type
-
property
locked¶ Gets the locked of this ProjectOutput.
- Returns
The locked of this ProjectOutput.
- Return type
-
property
modified¶ Gets the modified of this ProjectOutput.
- Returns
The modified of this ProjectOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this ProjectOutput.
- Returns
The notes of this ProjectOutput.
- Return type
list[Note]
-
property
original_copy_of¶ Gets the original_copy_of of this ProjectOutput.
- Returns
The original_copy_of of this ProjectOutput.
- Return type
str
-
property
parents¶ Gets the parents of this ProjectOutput.
- Returns
The parents of this ProjectOutput.
- Return type
-
property
permissions¶ Gets the permissions of this ProjectOutput.
- Returns
The permissions of this ProjectOutput.
- Return type
-
property
providers¶ Gets the providers of this ProjectOutput.
- Returns
The providers of this ProjectOutput.
- Return type
-
property
revision¶ Gets the revision of this ProjectOutput.
- Returns
The revision of this ProjectOutput.
- Return type
int
-
property
settings¶ Gets the settings of this ProjectOutput.
- Returns
The settings of this ProjectOutput.
- Return type
-
property
stats¶ Gets the stats of this ProjectOutput.
- Returns
The stats of this ProjectOutput.
- Return type
Gets the tags of this ProjectOutput.
- Returns
The tags of this ProjectOutput.
- Return type
list[str]
-
property
templates¶ Gets the templates of this ProjectOutput.
- Returns
The templates of this ProjectOutput.
- Return type
list[ProjectTemplate]
-
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
-
property
flywheel.models.project_parents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_parents.ProjectParents(group=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ProjectParents.
- Returns
The group of this ProjectParents.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.project_report module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_report.ProjectReport(name='', group_name='', admins=None, session_count=0, subjects_count=0, female_count=0, male_count=0, other_count=0, demographics_grid=None, demographics_total=0, over_18_count=0, under_18_count=0)¶ Bases:
object-
property
admins¶ Gets the admins of this ProjectReport.
- Returns
The admins of this ProjectReport.
- Return type
list[object]
-
property
demographics_grid¶ Gets the demographics_grid of this ProjectReport.
- Returns
The demographics_grid of this ProjectReport.
- Return type
object
-
property
demographics_total¶ Gets the demographics_total of this ProjectReport.
- Returns
The demographics_total of this ProjectReport.
- Return type
int
-
property
female_count¶ Gets the female_count of this ProjectReport.
- Returns
The female_count of this ProjectReport.
- Return type
int
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group_name¶ Gets the group_name of this ProjectReport.
- Returns
The group_name of this ProjectReport.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
male_count¶ Gets the male_count of this ProjectReport.
- Returns
The male_count of this ProjectReport.
- Return type
int
-
property
name¶ Gets the name of this ProjectReport.
Application-specific label
- Returns
The name of this ProjectReport.
- Return type
str
-
property
other_count¶ Gets the other_count of this ProjectReport.
- Returns
The other_count of this ProjectReport.
- Return type
int
-
property
over_18_count¶ Gets the over_18_count of this ProjectReport.
- Returns
The over_18_count of this ProjectReport.
- Return type
int
-
property
session_count¶ Gets the session_count of this ProjectReport.
- Returns
The session_count of this ProjectReport.
- Return type
int
-
property
subjects_count¶ Gets the subjects_count of this ProjectReport.
- Returns
The subjects_count of this ProjectReport.
- Return type
int
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
under_18_count¶ Gets the under_18_count of this ProjectReport.
- Returns
The under_18_count of this ProjectReport.
- Return type
int
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.project_report_list module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_report_list.ProjectReportList(projects=None)¶ Bases:
object-
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
-
property
projects¶ Gets the projects of this ProjectReportList.
- Returns
The projects of this ProjectReportList.
- Return type
list[ProjectReport]
-
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
-
flywheel.models.project_session_upsert_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_session_upsert_input.ProjectSessionUpsertInput(id=None, uid=None, label=None, timestamp=None, timezone=None, age=None, weight=None, operator=None, info=None)¶ Bases:
object-
property
age¶ Gets the age of this ProjectSessionUpsertInput.
- Returns
The age of this ProjectSessionUpsertInput.
- Return type
float
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ProjectSessionUpsertInput.
- Returns
The id of this ProjectSessionUpsertInput.
- Return type
str
-
property
info¶ Gets the info of this ProjectSessionUpsertInput.
- Returns
The info of this ProjectSessionUpsertInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectSessionUpsertInput.
- Returns
The label of this ProjectSessionUpsertInput.
- Return type
str
-
property
operator¶ Gets the operator of this ProjectSessionUpsertInput.
- Returns
The operator of this ProjectSessionUpsertInput.
- Return type
str
-
property
timestamp¶ Gets the timestamp of this ProjectSessionUpsertInput.
- Returns
The timestamp of this ProjectSessionUpsertInput.
- Return type
str
-
property
timezone¶ Gets the timezone of this ProjectSessionUpsertInput.
- Returns
The timezone of this ProjectSessionUpsertInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this ProjectSessionUpsertInput.
- Returns
The uid of this ProjectSessionUpsertInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
weight¶ Gets the weight of this ProjectSessionUpsertInput.
- Returns
The weight of this ProjectSessionUpsertInput.
- Return type
float
-
property
flywheel.models.project_session_upsert_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_session_upsert_output.ProjectSessionUpsertOutput(id=None, uid=None, label=None, upsert_result=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ProjectSessionUpsertOutput.
- Returns
The id of this ProjectSessionUpsertOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectSessionUpsertOutput.
- Returns
The label of this ProjectSessionUpsertOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this ProjectSessionUpsertOutput.
- Returns
The uid of this ProjectSessionUpsertOutput.
- Return type
str
-
property
upsert_result¶ Gets the upsert_result of this ProjectSessionUpsertOutput.
- Returns
The upsert_result of this ProjectSessionUpsertOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.project_settings_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_settings_input.ProjectSettingsInput(viewer_apps=None, deid_profile=None, forms=None, external_routing_id=None, sharing=None)¶ Bases:
object-
property
deid_profile¶ Gets the deid_profile of this ProjectSettingsInput.
- Returns
The deid_profile of this ProjectSettingsInput.
- Return type
union[string,object]
-
property
external_routing_id¶ Gets the external_routing_id of this ProjectSettingsInput.
- Returns
The external_routing_id of this ProjectSettingsInput.
- Return type
str
-
property
forms¶ Gets the forms of this ProjectSettingsInput.
- Returns
The forms of this ProjectSettingsInput.
- Return type
dict(str, list[FormDefinition])
-
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
-
property
sharing¶ Gets the sharing of this ProjectSettingsInput.
- Returns
The sharing of this ProjectSettingsInput.
- Return type
-
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
-
property
flywheel.models.project_settings_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_settings_output.ProjectSettingsOutput(viewer_apps=None, deid_profile=None, forms=None, external_routing_id=None, sharing=None)¶ Bases:
object-
property
deid_profile¶ Gets the deid_profile of this ProjectSettingsOutput.
- Returns
The deid_profile of this ProjectSettingsOutput.
- Return type
object
-
property
external_routing_id¶ Gets the external_routing_id of this ProjectSettingsOutput.
- Returns
The external_routing_id of this ProjectSettingsOutput.
- Return type
str
-
property
forms¶ Gets the forms of this ProjectSettingsOutput.
- Returns
The forms of this ProjectSettingsOutput.
- Return type
dict(str, list[FormDefinition])
-
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
-
property
sharing¶ Gets the sharing of this ProjectSettingsOutput.
- Returns
The sharing of this ProjectSettingsOutput.
- Return type
-
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
-
property
flywheel.models.project_settings_sharing module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_settings_sharing.ProjectSettingsSharing(share_level=None, project_institutions=None, project_contacts=None, summary=None, therapeutic_areas=None, body_regions=None, organ_systems=None)¶ Bases:
object-
property
body_regions¶ Gets the body_regions of this ProjectSettingsSharing.
- Returns
The body_regions of this ProjectSettingsSharing.
- Return type
list[BodyRegion]
-
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
-
property
organ_systems¶ Gets the organ_systems of this ProjectSettingsSharing.
- Returns
The organ_systems of this ProjectSettingsSharing.
- Return type
list[OrganSystem]
-
property
project_contacts¶ Gets the project_contacts of this ProjectSettingsSharing.
- Returns
The project_contacts of this ProjectSettingsSharing.
- Return type
list[ProjectContact]
-
property
project_institutions¶ Gets the project_institutions of this ProjectSettingsSharing.
- Returns
The project_institutions of this ProjectSettingsSharing.
- Return type
list[ProjectInstitution]
Gets the share_level of this ProjectSettingsSharing.
- Returns
The share_level of this ProjectSettingsSharing.
- Return type
-
property
summary¶ Gets the summary of this ProjectSettingsSharing.
- Returns
The summary of this ProjectSettingsSharing.
- Return type
str
-
property
therapeutic_areas¶ Gets the therapeutic_areas of this ProjectSettingsSharing.
- Returns
The therapeutic_areas of this ProjectSettingsSharing.
- Return type
list[TherapeuticArea]
-
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
-
property
flywheel.models.project_settings_sharing_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_settings_sharing_input.ProjectSettingsSharingInput(share_level=None, project_institutions=None, project_contacts=None, summary=None, therapeutic_areas=None, body_regions=None, organ_systems=None)¶ Bases:
object-
property
body_regions¶ Gets the body_regions of this ProjectSettingsSharingInput.
- Returns
The body_regions of this ProjectSettingsSharingInput.
- Return type
list[BodyRegion]
-
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
-
property
organ_systems¶ Gets the organ_systems of this ProjectSettingsSharingInput.
- Returns
The organ_systems of this ProjectSettingsSharingInput.
- Return type
list[OrganSystem]
-
property
project_contacts¶ Gets the project_contacts of this ProjectSettingsSharingInput.
- Returns
The project_contacts of this ProjectSettingsSharingInput.
- Return type
list[ProjectContact]
-
property
project_institutions¶ Gets the project_institutions of this ProjectSettingsSharingInput.
- Returns
The project_institutions of this ProjectSettingsSharingInput.
- Return type
list[ProjectInstitution]
Gets the share_level of this ProjectSettingsSharingInput.
- Returns
The share_level of this ProjectSettingsSharingInput.
- Return type
-
property
summary¶ Gets the summary of this ProjectSettingsSharingInput.
- Returns
The summary of this ProjectSettingsSharingInput.
- Return type
str
-
property
therapeutic_areas¶ Gets the therapeutic_areas of this ProjectSettingsSharingInput.
- Returns
The therapeutic_areas of this ProjectSettingsSharingInput.
- Return type
list[TherapeuticArea]
-
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
-
property
flywheel.models.project_sharing_settings_project_contact module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_sharing_settings_project_contact.ProjectSharingSettingsProjectContact(name=None, email=None)¶ Bases:
object-
property
email¶ Gets the email of this ProjectSharingSettingsProjectContact.
- Returns
The email of this ProjectSharingSettingsProjectContact.
- Return type
str
-
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
-
property
name¶ Gets the name of this ProjectSharingSettingsProjectContact.
- Returns
The name of this ProjectSharingSettingsProjectContact.
- Return type
str
-
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
-
property
flywheel.models.project_sharing_settings_project_counters module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_sharing_settings_project_counters.ProjectSharingSettingsProjectCounters(subjects=None, sessions=None, acquisitions=None, files=None)¶ Bases:
object-
property
acquisitions¶ Gets the acquisitions of this ProjectSharingSettingsProjectCounters.
- Returns
The acquisitions of this ProjectSharingSettingsProjectCounters.
- Return type
int
-
property
files¶ Gets the files of this ProjectSharingSettingsProjectCounters.
- Returns
The files of this ProjectSharingSettingsProjectCounters.
- Return type
int
-
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
-
property
sessions¶ Gets the sessions of this ProjectSharingSettingsProjectCounters.
- Returns
The sessions of this ProjectSharingSettingsProjectCounters.
- Return type
int
-
property
subjects¶ Gets the subjects of this ProjectSharingSettingsProjectCounters.
- Returns
The subjects of this ProjectSharingSettingsProjectCounters.
- Return type
int
-
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
-
property
flywheel.models.project_sharing_settings_project_institution module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_sharing_settings_project_institution.ProjectSharingSettingsProjectInstitution(name=None, url=None)¶ Bases:
object-
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
-
property
name¶ Gets the name of this ProjectSharingSettingsProjectInstitution.
- Returns
The name of this ProjectSharingSettingsProjectInstitution.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
url¶ Gets the url of this ProjectSharingSettingsProjectInstitution.
- Returns
The url of this ProjectSharingSettingsProjectInstitution.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.project_sharing_settings_project_settings_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_sharing_settings_project_settings_input.ProjectSharingSettingsProjectSettingsInput(sharing=None)¶ Bases:
object-
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
-
property
sharing¶ Gets the sharing of this ProjectSharingSettingsProjectSettingsInput.
- Returns
The sharing of this ProjectSharingSettingsProjectSettingsInput.
- Return type
-
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
-
flywheel.models.project_sharing_settings_project_settings_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_sharing_settings_project_settings_output.ProjectSharingSettingsProjectSettingsOutput(sharing=None)¶ Bases:
object-
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
-
property
sharing¶ Gets the sharing of this ProjectSharingSettingsProjectSettingsOutput.
- Returns
The sharing of this ProjectSharingSettingsProjectSettingsOutput.
- Return type
-
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
-
flywheel.models.project_sharing_settings_project_settings_sharing module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_sharing_settings_project_settings_sharing.ProjectSharingSettingsProjectSettingsSharing(share_level=None, project_institutions=None, project_contacts=None, summary=None, therapeutic_areas=None, body_regions=None, organ_systems=None)¶ Bases:
object-
property
body_regions¶ Gets the body_regions of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The body_regions of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
list[str]
-
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
-
property
organ_systems¶ Gets the organ_systems of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The organ_systems of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
list[str]
-
property
project_contacts¶ Gets the project_contacts of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The project_contacts of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
-
property
project_institutions¶ Gets the project_institutions of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The project_institutions of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
Gets the share_level of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The share_level of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
str
-
property
summary¶ Gets the summary of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The summary of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
str
-
property
therapeutic_areas¶ Gets the therapeutic_areas of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The therapeutic_areas of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
list[str]
-
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
-
property
flywheel.models.project_sharing_settings_project_settings_sharing_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_sharing_settings_project_settings_sharing_input.ProjectSharingSettingsProjectSettingsSharingInput(share_level=None, project_institutions=None, project_contacts=None, summary=None, therapeutic_areas=None, body_regions=None, organ_systems=None)¶ Bases:
object-
property
body_regions¶ Gets the body_regions of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The body_regions of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
list[str]
-
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
-
property
organ_systems¶ Gets the organ_systems of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The organ_systems of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
list[str]
-
property
project_contacts¶ Gets the project_contacts of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The project_contacts of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
-
property
project_institutions¶ Gets the project_institutions of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The project_institutions of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
Gets the share_level of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The share_level of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
str
-
property
summary¶ Gets the summary of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The summary of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
str
-
property
therapeutic_areas¶ Gets the therapeutic_areas of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The therapeutic_areas of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
list[str]
-
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
-
property
flywheel.models.project_sharing_settings_project_stats module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_sharing_settings_project_stats.ProjectSharingSettingsProjectStats(number_of=None, age_groups=None, measurements=None, modalities=None, file_types=None)¶ Bases:
object-
property
age_groups¶ Gets the age_groups of this ProjectSharingSettingsProjectStats.
- Returns
The age_groups of this ProjectSharingSettingsProjectStats.
- Return type
str
-
property
file_types¶ Gets the file_types of this ProjectSharingSettingsProjectStats.
- Returns
The file_types of this ProjectSharingSettingsProjectStats.
- Return type
str
-
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
-
property
measurements¶ Gets the measurements of this ProjectSharingSettingsProjectStats.
- Returns
The measurements of this ProjectSharingSettingsProjectStats.
- Return type
str
-
property
modalities¶ Gets the modalities of this ProjectSharingSettingsProjectStats.
- Returns
The modalities of this ProjectSharingSettingsProjectStats.
- Return type
str
-
property
number_of¶ Gets the number_of of this ProjectSharingSettingsProjectStats.
- Returns
The number_of of this ProjectSharingSettingsProjectStats.
- Return type
-
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
-
property
flywheel.models.project_stats module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_stats.ProjectStats(number_of=None, age_groups=None, measurements=None, modalities=None, file_types=None)¶ Bases:
object-
property
age_groups¶ Gets the age_groups of this ProjectStats.
- Returns
The age_groups of this ProjectStats.
- Return type
list[str]
-
property
file_types¶ Gets the file_types of this ProjectStats.
- Returns
The file_types of this ProjectStats.
- Return type
list[str]
-
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
-
property
measurements¶ Gets the measurements of this ProjectStats.
- Returns
The measurements of this ProjectStats.
- Return type
list[str]
-
property
modalities¶ Gets the modalities of this ProjectStats.
- Returns
The modalities of this ProjectStats.
- Return type
list[str]
-
property
number_of¶ Gets the number_of of this ProjectStats.
- Returns
The number_of of this ProjectStats.
- Return type
-
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
-
property
flywheel.models.project_subject_upsert_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_subject_upsert_input.ProjectSubjectUpsertInput(id=None, label=None, firstname=None, lastname=None, sex=None, type=None, race=None, ethnicity=None, species=None, strain=None, info=None)¶ Bases:
object-
property
ethnicity¶ Gets the ethnicity of this ProjectSubjectUpsertInput.
- Returns
The ethnicity of this ProjectSubjectUpsertInput.
- Return type
str
-
property
firstname¶ Gets the firstname of this ProjectSubjectUpsertInput.
- Returns
The firstname of this ProjectSubjectUpsertInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ProjectSubjectUpsertInput.
- Returns
The id of this ProjectSubjectUpsertInput.
- Return type
str
-
property
info¶ Gets the info of this ProjectSubjectUpsertInput.
- Returns
The info of this ProjectSubjectUpsertInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectSubjectUpsertInput.
- Returns
The label of this ProjectSubjectUpsertInput.
- Return type
str
-
property
lastname¶ Gets the lastname of this ProjectSubjectUpsertInput.
- Returns
The lastname of this ProjectSubjectUpsertInput.
- Return type
str
-
property
race¶ Gets the race of this ProjectSubjectUpsertInput.
- Returns
The race of this ProjectSubjectUpsertInput.
- Return type
str
-
property
sex¶ Gets the sex of this ProjectSubjectUpsertInput.
- Returns
The sex of this ProjectSubjectUpsertInput.
- Return type
str
-
property
species¶ Gets the species of this ProjectSubjectUpsertInput.
- Returns
The species of this ProjectSubjectUpsertInput.
- Return type
str
-
property
strain¶ Gets the strain of this ProjectSubjectUpsertInput.
- Returns
The strain of this ProjectSubjectUpsertInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this ProjectSubjectUpsertInput.
- Returns
The type of this ProjectSubjectUpsertInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.project_subject_upsert_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_subject_upsert_output.ProjectSubjectUpsertOutput(id=None, label=None, upsert_result=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ProjectSubjectUpsertOutput.
- Returns
The id of this ProjectSubjectUpsertOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ProjectSubjectUpsertOutput.
- Returns
The label of this ProjectSubjectUpsertOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
upsert_result¶ Gets the upsert_result of this ProjectSubjectUpsertOutput.
- Returns
The upsert_result of this ProjectSubjectUpsertOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.project_template module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_template.ProjectTemplate(session=None, acquisitions=None)¶ Bases:
object-
property
acquisitions¶ Gets the acquisitions of this ProjectTemplate.
- Returns
The acquisitions of this ProjectTemplate.
- Return type
-
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
-
property
session¶ Gets the session of this ProjectTemplate.
- Returns
The session of this ProjectTemplate.
- Return type
-
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
-
property
flywheel.models.project_template_requirement module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_template_requirement.ProjectTemplateRequirement(minimum=None, maximum=None)¶ Bases:
object-
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
-
property
maximum¶ Gets the maximum of this ProjectTemplateRequirement.
- Returns
The maximum of this ProjectTemplateRequirement.
- Return type
int
-
property
minimum¶ Gets the minimum of this ProjectTemplateRequirement.
- Returns
The minimum of this ProjectTemplateRequirement.
- Return type
int
-
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
-
flywheel.models.project_template_session_template module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_template_session_template.ProjectTemplateSessionTemplate(session=None, acquisitions=None)¶ Bases:
object-
property
acquisitions¶ Gets the acquisitions of this ProjectTemplateSessionTemplate.
- Returns
The acquisitions of this ProjectTemplateSessionTemplate.
- Return type
-
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
-
property
session¶ Gets the session of this ProjectTemplateSessionTemplate.
- Returns
The session of this ProjectTemplateSessionTemplate.
- Return type
object
-
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
-
property
flywheel.models.project_upsert_origin module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project_upsert_origin.ProjectUpsertOrigin(type=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ProjectUpsertOrigin.
- Returns
The id of this ProjectUpsertOrigin.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this ProjectUpsertOrigin.
- Returns
The type of this ProjectUpsertOrigin.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.provider module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.provider.Provider(id=None, provider_class=None, provider_type=None, access_type=None, label=None, origin=None, created=None, modified=None, config=None, creds=None)¶ Bases:
object-
property
access_type¶ Gets the access_type of this Provider.
The access type - required for storage class providers
- Returns
The access_type of this Provider.
- Return type
str
-
property
config¶ Gets the config of this Provider.
The provider-specific configuration fields.
- Returns
The config of this Provider.
- Return type
object
-
property
created¶ Gets the created of this Provider.
Creation time (automatically set)
- Returns
The created of this Provider.
- Return type
datetime
-
property
creds¶ Gets the creds of this Provider.
The provider-specific credential fields.
- Returns
The creds of this Provider.
- Return type
object
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this Provider.
Unique database ID
- Returns
The id of this Provider.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this Provider.
A human readable label for the provider
- Returns
The label of this Provider.
- Return type
str
-
property
modified¶ Gets the modified of this Provider.
Last modification time (automatically updated)
- Returns
The modified of this Provider.
- Return type
datetime
-
property
origin¶ Gets the origin of this Provider.
- Returns
The origin of this Provider.
- Return type
-
property
provider_class¶ Gets the provider_class of this Provider.
The provider class - one of compute or storage
- Returns
The provider_class of this Provider.
- Return type
str
-
property
provider_type¶ Gets the provider_type of this Provider.
The provider type (e.g. static or gcloud)
- Returns
The provider_type of this Provider.
- Return type
str
-
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
-
property
flywheel.models.provider_access_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.provider_class module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.provider_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.provider_input.ProviderInput(provider_class=None, provider_type=None, access_type=None, label=None, config=None, creds=None)¶ Bases:
object-
property
access_type¶ Gets the access_type of this ProviderInput.
The access type - required for storage class providers
- Returns
The access_type of this ProviderInput.
- Return type
str
-
property
config¶ Gets the config of this ProviderInput.
The provider-specific configuration fields.
- Returns
The config of this ProviderInput.
- Return type
object
-
property
creds¶ Gets the creds of this ProviderInput.
The provider-specific credential fields.
- Returns
The creds of this ProviderInput.
- Return type
object
-
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
-
property
label¶ Gets the label of this ProviderInput.
A human readable label for the provider
- Returns
The label of this ProviderInput.
- Return type
str
-
property
provider_class¶ Gets the provider_class of this ProviderInput.
The provider class - one of compute or storage
- Returns
The provider_class of this ProviderInput.
- Return type
str
-
property
provider_type¶ Gets the provider_type of this ProviderInput.
The provider type (e.g. static or gcloud)
- Returns
The provider_type of this ProviderInput.
- Return type
str
-
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
-
property
flywheel.models.provider_links module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.provider_links.ProviderLinks(compute=None, storage=None, access_log=None, change_log=None, job_logs=None)¶ Bases:
object-
property
access_log¶ Gets the access_log of this ProviderLinks.
Unique database ID
- Returns
The access_log of this ProviderLinks.
- Return type
str
-
property
change_log¶ Gets the change_log of this ProviderLinks.
Unique database ID
- Returns
The change_log of this ProviderLinks.
- Return type
str
-
property
compute¶ Gets the compute of this ProviderLinks.
Unique database ID
- Returns
The compute of this ProviderLinks.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
job_logs¶ Gets the job_logs of this ProviderLinks.
Unique database ID
- Returns
The job_logs of this ProviderLinks.
- Return type
str
-
keys()¶ Returns the list of json properties in the object
-
property
storage¶ Gets the storage of this ProviderLinks.
Unique database ID
- Returns
The storage of this ProviderLinks.
- Return type
str
-
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
-
property
flywheel.models.provider_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.providers module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.providers.Providers(storage=None, compute=None, change_log=None, job_logs=None, access_log=None)¶ Bases:
object-
property
access_log¶ Gets the access_log of this Providers.
- Returns
The access_log of this Providers.
- Return type
str
-
property
change_log¶ Gets the change_log of this Providers.
- Returns
The change_log of this Providers.
- Return type
str
-
property
compute¶ Gets the compute of this Providers.
- Returns
The compute of this Providers.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
job_logs¶ Gets the job_logs of this Providers.
- Returns
The job_logs of this Providers.
- Return type
str
-
keys()¶ Returns the list of json properties in the object
-
property
storage¶ Gets the storage of this Providers.
- Returns
The storage of this Providers.
- Return type
str
-
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
-
property
flywheel.models.report_access_log_context module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_access_log_context.ReportAccessLogContext(group=None, project=None, subject=None, session=None, acquisition=None, file=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this ReportAccessLogContext.
- Returns
The acquisition of this ReportAccessLogContext.
- Return type
-
property
file¶ Gets the file of this ReportAccessLogContext.
- Returns
The file of this ReportAccessLogContext.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ReportAccessLogContext.
- Returns
The group of this ReportAccessLogContext.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this ReportAccessLogContext.
- Returns
The project of this ReportAccessLogContext.
- Return type
-
property
session¶ Gets the session of this ReportAccessLogContext.
- Returns
The session of this ReportAccessLogContext.
- Return type
-
property
subject¶ Gets the subject of this ReportAccessLogContext.
- Returns
The subject of this ReportAccessLogContext.
- Return type
-
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
-
property
flywheel.models.report_access_log_context_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_access_log_context_entry.ReportAccessLogContextEntry(id=None, label=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ReportAccessLogContextEntry.
Unique database ID
- Returns
The id of this ReportAccessLogContextEntry.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ReportAccessLogContextEntry.
Application-specific label
- Returns
The label of this ReportAccessLogContextEntry.
- Return type
str
-
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
-
flywheel.models.report_access_log_context_file_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_access_log_context_file_entry.ReportAccessLogContextFileEntry(name=None)¶ Bases:
object-
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
-
property
name¶ Gets the name of this ReportAccessLogContextFileEntry.
The name of the file on disk
- Returns
The name of this ReportAccessLogContextFileEntry.
- Return type
str
-
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
-
flywheel.models.report_access_log_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_access_log_entry.ReportAccessLogEntry(id=None, access_type=None, context=None, origin=None, request_method=None, request_path=None, timestamp=None)¶ Bases:
object-
property
access_type¶ Gets the access_type of this ReportAccessLogEntry.
A named field used in the access log report
- Returns
The access_type of this ReportAccessLogEntry.
- Return type
str
-
property
context¶ Gets the context of this ReportAccessLogEntry.
- Returns
The context of this ReportAccessLogEntry.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ReportAccessLogEntry.
The access log entry id
- Returns
The id of this ReportAccessLogEntry.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
origin¶ Gets the origin of this ReportAccessLogEntry.
- Returns
The origin of this ReportAccessLogEntry.
- Return type
-
property
request_method¶ Gets the request_method of this ReportAccessLogEntry.
The http request method (e.g. GET, PUT, POST, DELETE)
- Returns
The request_method of this ReportAccessLogEntry.
- Return type
str
-
property
request_path¶ Gets the request_path of this ReportAccessLogEntry.
The HTTP request path (e.g. /api/projects)
- Returns
The request_path of this ReportAccessLogEntry.
- Return type
str
-
property
timestamp¶ Gets the timestamp of this ReportAccessLogEntry.
- Returns
The timestamp of this ReportAccessLogEntry.
- Return type
datetime
-
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
-
property
flywheel.models.report_access_log_origin module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_access_log_origin.ReportAccessLogOrigin(type=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ReportAccessLogOrigin.
The origin id (e.g. user id)
- Returns
The id of this ReportAccessLogOrigin.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this ReportAccessLogOrigin.
The origin type (e.g. user)
- Returns
The type of this ReportAccessLogOrigin.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.report_daily_usage_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_daily_usage_entry.ReportDailyUsageEntry(year=None, month=None, day=None, group=None, project=None, project_label=None, session_count=None, center_job_count=None, group_job_count=None, center_compute_ms=None, group_compute_ms=None, center_storage_bytes=None, group_storage_bytes=None)¶ Bases:
object-
property
center_compute_ms¶ Gets the center_compute_ms of this ReportDailyUsageEntry.
The compute time of center-designated gear jobs completed during the time frame (billable to the center)
- Returns
The center_compute_ms of this ReportDailyUsageEntry.
- Return type
int
-
property
center_job_count¶ Gets the center_job_count of this ReportDailyUsageEntry.
The number of center-designated gear jobs that completed during the time frame (billable to the center)
- Returns
The center_job_count of this ReportDailyUsageEntry.
- Return type
int
-
property
center_storage_bytes¶ Gets the center_storage_bytes of this ReportDailyUsageEntry.
The total storage used by files originating from devices or center-designated gears on this day (billable to the center)
- Returns
The center_storage_bytes of this ReportDailyUsageEntry.
- Return type
int
-
property
day¶ Gets the day of this ReportDailyUsageEntry.
The day that this record represents
- Returns
The day of this ReportDailyUsageEntry.
- Return type
int
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ReportDailyUsageEntry.
The group label
- Returns
The group of this ReportDailyUsageEntry.
- Return type
str
-
property
group_compute_ms¶ Gets the group_compute_ms of this ReportDailyUsageEntry.
The compute time of non-center-designated (lab) gear jobs completed during the time frame (billable to the group)
- Returns
The group_compute_ms of this ReportDailyUsageEntry.
- Return type
int
-
property
group_job_count¶ Gets the group_job_count of this ReportDailyUsageEntry.
The number of non-center-designated (lab) gear jobs that completed during the time frame (billable to the group)
- Returns
The group_job_count of this ReportDailyUsageEntry.
- Return type
int
-
property
group_storage_bytes¶ Gets the group_storage_bytes of this ReportDailyUsageEntry.
The total storage used by files not originating from devices or non-center-designated (lab) gears on this day (billable to the group)
- Returns
The group_storage_bytes of this ReportDailyUsageEntry.
- Return type
int
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
month¶ Gets the month of this ReportDailyUsageEntry.
The month that this record represents
- Returns
The month of this ReportDailyUsageEntry.
- Return type
int
-
property
project¶ Gets the project of this ReportDailyUsageEntry.
Unique database ID
- Returns
The project of this ReportDailyUsageEntry.
- Return type
str
-
property
project_label¶ Gets the project_label of this ReportDailyUsageEntry.
Application-specific label
- Returns
The project_label of this ReportDailyUsageEntry.
- Return type
str
-
property
session_count¶ Gets the session_count of this ReportDailyUsageEntry.
The number of sessions that existed at the last collection time
- Returns
The session_count of this ReportDailyUsageEntry.
- Return type
int
-
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
-
property
year¶ Gets the year of this ReportDailyUsageEntry.
The year that this record represents
- Returns
The year of this ReportDailyUsageEntry.
- Return type
int
-
property
flywheel.models.report_demographics_grid module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_demographics_grid.ReportDemographicsGrid(black_or_african_american=None, unknown_or_not_reported=None, american_indian_or_alaska_native=None, asian=None, white=None, total=None, native_hawaiian_or_other_pacific_islander=None, more_than_one_race=None, male_count=None, group_label=None, over_18_count=None, under_18_count=None, female_count=None, subjects_count=None, other_count=None, name=None, session_count=None, admins=None, demographics_total=None)¶ Bases:
object-
property
admins¶ Gets the admins of this ReportDemographicsGrid.
- Returns
The admins of this ReportDemographicsGrid.
- Return type
list[str]
-
property
american_indian_or_alaska_native¶ Gets the american_indian_or_alaska_native of this ReportDemographicsGrid.
- Returns
The american_indian_or_alaska_native of this ReportDemographicsGrid.
- Return type
-
property
asian¶ Gets the asian of this ReportDemographicsGrid.
- Returns
The asian of this ReportDemographicsGrid.
- Return type
-
property
black_or_african_american¶ Gets the black_or_african_american of this ReportDemographicsGrid.
- Returns
The black_or_african_american of this ReportDemographicsGrid.
- Return type
-
property
demographics_total¶ Gets the demographics_total of this ReportDemographicsGrid.
- Returns
The demographics_total of this ReportDemographicsGrid.
- Return type
int
-
property
female_count¶ Gets the female_count of this ReportDemographicsGrid.
- Returns
The female_count of this ReportDemographicsGrid.
- Return type
int
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group_label¶ Gets the group_label of this ReportDemographicsGrid.
Application-specific label
- Returns
The group_label of this ReportDemographicsGrid.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
male_count¶ Gets the male_count of this ReportDemographicsGrid.
- Returns
The male_count of this ReportDemographicsGrid.
- Return type
int
-
property
more_than_one_race¶ Gets the more_than_one_race of this ReportDemographicsGrid.
- Returns
The more_than_one_race of this ReportDemographicsGrid.
- Return type
-
property
name¶ Gets the name of this ReportDemographicsGrid.
Application-specific label
- Returns
The name of this ReportDemographicsGrid.
- Return type
str
-
property
native_hawaiian_or_other_pacific_islander¶ Gets the native_hawaiian_or_other_pacific_islander of this ReportDemographicsGrid.
- Returns
The native_hawaiian_or_other_pacific_islander of this ReportDemographicsGrid.
- Return type
-
property
other_count¶ Gets the other_count of this ReportDemographicsGrid.
- Returns
The other_count of this ReportDemographicsGrid.
- Return type
int
-
property
over_18_count¶ Gets the over_18_count of this ReportDemographicsGrid.
- Returns
The over_18_count of this ReportDemographicsGrid.
- Return type
int
-
property
session_count¶ Gets the session_count of this ReportDemographicsGrid.
- Returns
The session_count of this ReportDemographicsGrid.
- Return type
int
-
property
subjects_count¶ Gets the subjects_count of this ReportDemographicsGrid.
- Returns
The subjects_count of this ReportDemographicsGrid.
- Return type
int
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
total¶ Gets the total of this ReportDemographicsGrid.
- Returns
The total of this ReportDemographicsGrid.
- Return type
-
property
under_18_count¶ Gets the under_18_count of this ReportDemographicsGrid.
- Returns
The under_18_count of this ReportDemographicsGrid.
- Return type
int
-
property
unknown_or_not_reported¶ Gets the unknown_or_not_reported of this ReportDemographicsGrid.
- Returns
The unknown_or_not_reported of this ReportDemographicsGrid.
- Return type
-
values()¶ Returns the list of values in the object
-
property
white¶ Gets the white of this ReportDemographicsGrid.
- Returns
The white of this ReportDemographicsGrid.
- Return type
-
property
flywheel.models.report_ethnicity_grid module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_ethnicity_grid.ReportEthnicityGrid(not_hispanic_or_latino=None, hispanic_or_latino=None, unknown_or_not_reported=None, total=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
hispanic_or_latino¶ Gets the hispanic_or_latino of this ReportEthnicityGrid.
- Returns
The hispanic_or_latino of this ReportEthnicityGrid.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
not_hispanic_or_latino¶ Gets the not_hispanic_or_latino of this ReportEthnicityGrid.
- Returns
The not_hispanic_or_latino of this ReportEthnicityGrid.
- Return type
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
total¶ Gets the total of this ReportEthnicityGrid.
- Returns
The total of this ReportEthnicityGrid.
- Return type
int
-
property
unknown_or_not_reported¶ Gets the unknown_or_not_reported of this ReportEthnicityGrid.
- Returns
The unknown_or_not_reported of this ReportEthnicityGrid.
- Return type
-
values()¶ Returns the list of values in the object
-
flywheel.models.report_gender_count module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_gender_count.ReportGenderCount(male=None, unknown_or_not_reported=None, female=None)¶ Bases:
object-
property
female¶ Gets the female of this ReportGenderCount.
- Returns
The female of this ReportGenderCount.
- Return type
int
-
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
-
property
male¶ Gets the male of this ReportGenderCount.
- Returns
The male of this ReportGenderCount.
- Return type
int
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
unknown_or_not_reported¶ Gets the unknown_or_not_reported of this ReportGenderCount.
- Returns
The unknown_or_not_reported of this ReportGenderCount.
- Return type
int
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.report_group_report module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_group_report.ReportGroupReport(project_count=None, label=None, session_count=None)¶ Bases:
object-
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
-
property
label¶ Gets the label of this ReportGroupReport.
The group label
- Returns
The label of this ReportGroupReport.
- Return type
str
-
property
project_count¶ Gets the project_count of this ReportGroupReport.
- Returns
The project_count of this ReportGroupReport.
- Return type
int
-
property
session_count¶ Gets the session_count of this ReportGroupReport.
- Returns
The session_count of this ReportGroupReport.
- Return type
int
-
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
-
flywheel.models.report_legacy_usage_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_legacy_usage_entry.ReportLegacyUsageEntry(file_mbs=None, gear_execution_count=None, session_count=None, year=None, month=None, project=None)¶ Bases:
object-
property
file_mbs¶ Gets the file_mbs of this ReportLegacyUsageEntry.
File storage usage, in megabytes
- Returns
The file_mbs of this ReportLegacyUsageEntry.
- Return type
float
-
property
gear_execution_count¶ Gets the gear_execution_count of this ReportLegacyUsageEntry.
The number of gears executed
- Returns
The gear_execution_count of this ReportLegacyUsageEntry.
- Return type
int
-
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
-
property
month¶ Gets the month of this ReportLegacyUsageEntry.
The month portion of the entry date
- Returns
The month of this ReportLegacyUsageEntry.
- Return type
str
-
property
project¶ Gets the project of this ReportLegacyUsageEntry.
- Returns
The project of this ReportLegacyUsageEntry.
- Return type
-
property
session_count¶ Gets the session_count of this ReportLegacyUsageEntry.
The number of sessions created
- Returns
The session_count of this ReportLegacyUsageEntry.
- Return type
int
-
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
-
property
year¶ Gets the year of this ReportLegacyUsageEntry.
The year portion of the entry date
- Returns
The year of this ReportLegacyUsageEntry.
- Return type
str
-
property
flywheel.models.report_legacy_usage_project_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_legacy_usage_project_entry.ReportLegacyUsageProjectEntry(id=None, label=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ReportLegacyUsageProjectEntry.
Unique database ID
- Returns
The id of this ReportLegacyUsageProjectEntry.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ReportLegacyUsageProjectEntry.
Application-specific label
- Returns
The label of this ReportLegacyUsageProjectEntry.
- Return type
str
-
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
-
flywheel.models.report_project module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_project.ReportProject(projects=None)¶ Bases:
object-
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
-
property
projects¶ Gets the projects of this ReportProject.
- Returns
The projects of this ReportProject.
- Return type
list[ReportDemographicsGrid]
-
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
-
flywheel.models.report_site module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_site.ReportSite(group_count=None, groups=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group_count¶ Gets the group_count of this ReportSite.
- Returns
The group_count of this ReportSite.
- Return type
int
-
property
groups¶ Gets the groups of this ReportSite.
- Returns
The groups of this ReportSite.
- Return type
list[ReportGroupReport]
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.report_time_period module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_time_period.ReportTimePeriod(year=None, month=None, day=None)¶ Bases:
object-
property
day¶ Gets the day of this ReportTimePeriod.
The day that this report row represents
- Returns
The day of this ReportTimePeriod.
- Return type
int
-
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
-
property
month¶ Gets the month of this ReportTimePeriod.
The month that this report row represents
- Returns
The month of this ReportTimePeriod.
- Return type
int
-
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
-
property
year¶ Gets the year of this ReportTimePeriod.
The year that this report row represents
- Returns
The year of this ReportTimePeriod.
- Return type
int
-
property
flywheel.models.report_usage_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.report_usage_entry.ReportUsageEntry(group=None, project=None, project_label=None, session_count=None, center_job_count=None, group_job_count=None, total_job_count=None, center_compute_ms=None, group_compute_ms=None, total_compute_ms=None, center_storage_byte_day=None, group_storage_byte_day=None, total_storage_byte_day=None, days=None)¶ Bases:
object-
property
center_compute_ms¶ Gets the center_compute_ms of this ReportUsageEntry.
The compute time (in ms) used by center-designated jobs in this project during the month (billable to the center)
- Returns
The center_compute_ms of this ReportUsageEntry.
- Return type
int
-
property
center_job_count¶ Gets the center_job_count of this ReportUsageEntry.
The number of center-designated gear jobs run in this project during the month (billable to the center)
- Returns
The center_job_count of this ReportUsageEntry.
- Return type
int
-
property
center_storage_byte_day¶ Gets the center_storage_byte_day of this ReportUsageEntry.
The storage, in byte-days, used by files originating from devices or center-designated gears in this project during the month (billable to the center)
- Returns
The center_storage_byte_day of this ReportUsageEntry.
- Return type
int
-
property
days¶ Gets the days of this ReportUsageEntry.
Number of days captured in this entry (normally the number of days in the month, unless the project was created in that month or it is the current month)
- Returns
The days of this ReportUsageEntry.
- Return type
int
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ReportUsageEntry.
The group label
- Returns
The group of this ReportUsageEntry.
- Return type
str
-
property
group_compute_ms¶ Gets the group_compute_ms of this ReportUsageEntry.
The compute time (in ms) used by non-center-designated (lab) gear jobs in this project during the month (billable to the group)
- Returns
The group_compute_ms of this ReportUsageEntry.
- Return type
int
-
property
group_job_count¶ Gets the group_job_count of this ReportUsageEntry.
The number of non-center-designated (lab) gear jobs run in this project during the month (billable to the group)
- Returns
The group_job_count of this ReportUsageEntry.
- Return type
int
-
property
group_storage_byte_day¶ Gets the group_storage_byte_day of this ReportUsageEntry.
The storage, in byte-days, used by files not originating from devices or non-center-designated (lab) gears in this project during the month (billable to the group)
- Returns
The group_storage_byte_day of this ReportUsageEntry.
- Return type
int
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this ReportUsageEntry.
The project ID
- Returns
The project of this ReportUsageEntry.
- Return type
str
-
property
project_label¶ Gets the project_label of this ReportUsageEntry.
The project label
- Returns
The project_label of this ReportUsageEntry.
- Return type
str
-
property
session_count¶ Gets the session_count of this ReportUsageEntry.
The number of sessions in the project on the last recorded day of the month
- Returns
The session_count of this ReportUsageEntry.
- Return type
int
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
total_compute_ms¶ Gets the total_compute_ms of this ReportUsageEntry.
The total compute time (in ms) used by gear jobs in this project during the month
- Returns
The total_compute_ms of this ReportUsageEntry.
- Return type
int
-
property
total_job_count¶ Gets the total_job_count of this ReportUsageEntry.
The total number of gear jobs run in this project during the month
- Returns
The total_job_count of this ReportUsageEntry.
- Return type
int
-
property
total_storage_byte_day¶ Gets the total_storage_byte_day of this ReportUsageEntry.
The total storage, in byte-days, used by files in this project during the month
- Returns
The total_storage_byte_day of this ReportUsageEntry.
- Return type
int
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.resolver_acquisition_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.resolver_analysis_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.resolver_file_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.resolver_file_node.ResolverFileNode(id=None, file_id=None, version=None, name=None, type=None, mimetype=None, modality=None, deid_log_id=None, classification=None, tags=None, info=None, origin=None, hash=None, parents=None, parent_ref=None, created=None, modified=None, replaced=None, size=None, info_exists=None, zip_member_count=None)¶ Bases:
flywheel.models.mixins.FileMixin-
property
classification¶ Gets the classification of this ResolverFileNode.
- Returns
The classification of this ResolverFileNode.
- Return type
-
property
created¶ Gets the created of this ResolverFileNode.
Creation time (automatically set)
- Returns
The created of this ResolverFileNode.
- Return type
datetime
-
property
deid_log_id¶ Gets the deid_log_id of this ResolverFileNode.
The UUID of the de-id log
- Returns
The deid_log_id of this ResolverFileNode.
- Return type
str
-
property
file_id¶ Gets the file_id of this ResolverFileNode.
Unique database ID
- Returns
The file_id of this ResolverFileNode.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
hash¶ Gets the hash of this ResolverFileNode.
Cryptographic hash of the file
- Returns
The hash of this ResolverFileNode.
- Return type
str
-
property
id¶ Gets the id of this ResolverFileNode.
- Returns
The id of this ResolverFileNode.
- Return type
str
-
property
info¶ Gets the info of this ResolverFileNode.
- Returns
The info of this ResolverFileNode.
- Return type
-
property
info_exists¶ Gets the info_exists of this ResolverFileNode.
- Returns
The info_exists of this ResolverFileNode.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
mimetype¶ Gets the mimetype of this ResolverFileNode.
A MIME Content-Type of the file
- Returns
The mimetype of this ResolverFileNode.
- Return type
str
-
property
modality¶ Gets the modality of this ResolverFileNode.
The type of instrument that originated the file (e.g. MR, CT, …)
- Returns
The modality of this ResolverFileNode.
- Return type
str
-
property
modified¶ Gets the modified of this ResolverFileNode.
Last modification time (automatically updated)
- Returns
The modified of this ResolverFileNode.
- Return type
datetime
-
property
name¶ Gets the name of this ResolverFileNode.
The name of the file on disk
- Returns
The name of this ResolverFileNode.
- Return type
str
-
property
origin¶ Gets the origin of this ResolverFileNode.
- Returns
The origin of this ResolverFileNode.
- Return type
-
property
parent_ref¶ Gets the parent_ref of this ResolverFileNode.
- Returns
The parent_ref of this ResolverFileNode.
- Return type
-
property
parents¶ Gets the parents of this ResolverFileNode.
- Returns
The parents of this ResolverFileNode.
- Return type
-
property
replaced¶ Gets the replaced of this ResolverFileNode.
Last replaced time (automatically updated)
- Returns
The replaced of this ResolverFileNode.
- Return type
datetime
-
property
size¶ Gets the size of this ResolverFileNode.
Size of the file, in bytes
- Returns
The size of this ResolverFileNode.
- Return type
int
Gets the tags of this ResolverFileNode.
Array of application-specific tags
- Returns
The tags of this ResolverFileNode.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this ResolverFileNode.
A descriptive file type (e.g. dicom, image, document, …)
- Returns
The type of this ResolverFileNode.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this ResolverFileNode.
Version of the file
- Returns
The version of this ResolverFileNode.
- Return type
int
-
property
zip_member_count¶ Gets the zip_member_count of this ResolverFileNode.
Number of entries in the zip archive
- Returns
The zip_member_count of this ResolverFileNode.
- Return type
int
-
property
flywheel.models.resolver_gear_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.resolver_gear_node.ResolverGearNode(id=None, category=None, gear=None, exchange=None, created=None, modified=None, disabled=None)¶ Bases:
flywheel.models.gear_mixin.GearMixin-
property
category¶ Gets the category of this ResolverGearNode.
The gear category
- Returns
The category of this ResolverGearNode.
- Return type
str
-
property
created¶ Gets the created of this ResolverGearNode.
Creation time (automatically set)
- Returns
The created of this ResolverGearNode.
- Return type
datetime
-
property
disabled¶ Gets the disabled of this ResolverGearNode.
The time the gear was disabled (automatically set)
- Returns
The disabled of this ResolverGearNode.
- Return type
datetime
-
property
exchange¶ Gets the exchange of this ResolverGearNode.
- Returns
The exchange of this ResolverGearNode.
- Return type
-
property
gear¶ Gets the gear of this ResolverGearNode.
- Returns
The gear of this ResolverGearNode.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ResolverGearNode.
Unique database ID
- Returns
The id of this ResolverGearNode.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
modified¶ Gets the modified of this ResolverGearNode.
Last modification time (automatically updated)
- Returns
The modified of this ResolverGearNode.
- Return type
datetime
-
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
-
property
flywheel.models.resolver_group_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.resolver_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.resolver_input.ResolverInput(path=None)¶ Bases:
object-
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
-
property
path¶ Gets the path of this ResolverInput.
- Returns
The path of this ResolverInput.
- Return type
list[str]
-
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
-
flywheel.models.resolver_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.resolver_node.ResolverNode(container_type=None)¶ Bases:
object-
property
container_type¶ Gets the container_type of this ResolverNode.
- Returns
The container_type of this ResolverNode.
- Return type
str
-
discriminator_value_class_map= {'acquisition': 'ResolverAcquisitionNode', 'analysis': 'ResolverAnalysisNode', 'file': 'ResolverFileNode', 'gear': 'ResolverGearNode', 'group': 'ResolverGroupNode', 'project': 'ResolverProjectNode', 'session': 'ResolverSessionNode', 'subject': 'ResolverSubjectNode'}¶
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
get_real_child_model(data)¶ Returns the real base class specified by the discriminator
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
property
flywheel.models.resolver_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.resolver_output.ResolverOutput(path=None, children=None)¶ Bases:
flywheel.models.mixins.ResolverOutputMixin-
property
children¶ Gets the children of this ResolverOutput.
- Returns
The children of this ResolverOutput.
- Return type
list[ResolverNode]
-
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
-
property
path¶ Gets the path of this ResolverOutput.
- Returns
The path of this ResolverOutput.
- Return type
list[ResolverNode]
-
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
-
property
flywheel.models.resolver_project_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.resolver_session_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.resolver_subject_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.role_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.role_output.RoleOutput(id=None, label=None, default_flywheel_role=None, actions=None, in_use=None)¶ Bases:
object-
property
actions¶ Gets the actions of this RoleOutput.
- Returns
The actions of this RoleOutput.
- Return type
list[union[Action,DeprecatedAction]]
-
property
default_flywheel_role¶ Gets the default_flywheel_role of this RoleOutput.
- Returns
The default_flywheel_role of this RoleOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this RoleOutput.
- Returns
The id of this RoleOutput.
- Return type
str
-
property
in_use¶ Gets the in_use of this RoleOutput.
- Returns
The in_use of this RoleOutput.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this RoleOutput.
- Returns
The label of this RoleOutput.
- Return type
str
-
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
-
property
flywheel.models.role_permission module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.role_permission.RolePermission(id=None, role_ids=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this RolePermission.
- Returns
The id of this RolePermission.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
role_ids¶ Gets the role_ids of this RolePermission.
- Returns
The role_ids of this RolePermission.
- Return type
list[str]
-
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
-
flywheel.models.role_permission_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.role_permission_output.RolePermissionOutput(id=None, role_ids=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this RolePermissionOutput.
- Returns
The id of this RolePermissionOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
role_ids¶ Gets the role_ids of this RolePermissionOutput.
- Returns
The role_ids of this RolePermissionOutput.
- Return type
list[str]
-
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
-
flywheel.models.role_permission_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.role_permission_update.RolePermissionUpdate(role_ids=None)¶ Bases:
object-
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
-
property
role_ids¶ Gets the role_ids of this RolePermissionUpdate.
- Returns
The role_ids of this RolePermissionUpdate.
- Return type
list[str]
-
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
-
flywheel.models.role_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.roles_backwards_compatible_role_assignment module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.roles_backwards_compatible_role_assignment.RolesBackwardsCompatibleRoleAssignment(id=None, role_ids=None, access=None)¶ Bases:
object-
property
access¶ Gets the access of this RolesBackwardsCompatibleRoleAssignment.
- Returns
The access of this RolesBackwardsCompatibleRoleAssignment.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this RolesBackwardsCompatibleRoleAssignment.
Database ID of a user
- Returns
The id of this RolesBackwardsCompatibleRoleAssignment.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
role_ids¶ Gets the role_ids of this RolesBackwardsCompatibleRoleAssignment.
- Returns
The role_ids of this RolesBackwardsCompatibleRoleAssignment.
- Return type
list[str]
-
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
-
property
flywheel.models.roles_group_role_pool_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.roles_group_role_pool_input.RolesGroupRolePoolInput(id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this RolesGroupRolePoolInput.
Unique database ID
- Returns
The id of this RolesGroupRolePoolInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.roles_role module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.roles_role.RolesRole(id=None, label=None, default_flywheel_role=None, actions=None, in_use=None)¶ Bases:
object-
property
actions¶ Gets the actions of this RolesRole.
- Returns
The actions of this RolesRole.
- Return type
list[str]
-
property
default_flywheel_role¶ Gets the default_flywheel_role of this RolesRole.
- Returns
The default_flywheel_role of this RolesRole.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this RolesRole.
Unique database ID
- Returns
The id of this RolesRole.
- Return type
str
-
property
in_use¶ Gets the in_use of this RolesRole.
- Returns
The in_use of this RolesRole.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this RolesRole.
Application-specific label
- Returns
The label of this RolesRole.
- Return type
str
-
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
-
property
flywheel.models.roles_role_assignment module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.roles_role_assignment.RolesRoleAssignment(id=None, role_ids=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this RolesRoleAssignment.
Database ID of a user
- Returns
The id of this RolesRoleAssignment.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
role_ids¶ Gets the role_ids of this RolesRoleAssignment.
- Returns
The role_ids of this RolesRoleAssignment.
- Return type
list[str]
-
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
-
flywheel.models.roles_role_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.roles_role_input.RolesRoleInput(label=None, actions=None)¶ Bases:
object-
property
actions¶ Gets the actions of this RolesRoleInput.
- Returns
The actions of this RolesRoleInput.
- Return type
list[str]
-
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
-
property
label¶ Gets the label of this RolesRoleInput.
Application-specific label
- Returns
The label of this RolesRoleInput.
- Return type
str
-
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
-
property
flywheel.models.rule module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.rule.Rule(project_id=None, gear_id=None, name=None, config=None, fixed_inputs=None, auto_update=None, any=None, all=None, _not=None, disabled=None, compute_provider_id=None, id=None)¶ Bases:
object-
property
auto_update¶ Gets the auto_update of this Rule.
- Returns
The auto_update of this Rule.
- Return type
bool
-
property
compute_provider_id¶ Gets the compute_provider_id of this Rule.
Unique database ID
- Returns
The compute_provider_id of this Rule.
- Return type
str
-
property
config¶ Gets the config of this Rule.
- Returns
The config of this Rule.
- Return type
object
-
property
disabled¶ Gets the disabled of this Rule.
- Returns
The disabled of this Rule.
- Return type
bool
-
property
fixed_inputs¶ Gets the fixed_inputs of this Rule.
- Returns
The fixed_inputs of this Rule.
- Return type
list[JobInputsArrayItem]
-
property
gear_id¶ Gets the gear_id of this Rule.
- Returns
The gear_id of this Rule.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this Rule.
- Returns
The id of this Rule.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
name¶ Gets the name of this Rule.
- Returns
The name of this Rule.
- Return type
str
-
property
project_id¶ Gets the project_id of this Rule.
- Returns
The project_id of this Rule.
- Return type
str
-
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
-
property
flywheel.models.rule_any module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.rule_any.RuleAny(type=None, value=None, regex=None)¶ Bases:
object-
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
-
property
regex¶ Gets the regex of this RuleAny.
- Returns
The regex of this RuleAny.
- Return type
bool
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this RuleAny.
- Returns
The type of this RuleAny.
- Return type
str
-
property
value¶ Gets the value of this RuleAny.
- Returns
The value of this RuleAny.
- Return type
object
-
values()¶ Returns the list of values in the object
-
flywheel.models.s3_compat_storage module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.s3_compat_storage.S3CompatStorage(region=None, bucket=None, path='', endpoint_url=None, verify_certs=False, signed_urls=False, config_type=None, config_class=None)¶ Bases:
object-
property
bucket¶ Gets the bucket of this S3CompatStorage.
- Returns
The bucket of this S3CompatStorage.
- Return type
str
-
property
config_class¶ Gets the config_class of this S3CompatStorage.
- Returns
The config_class of this S3CompatStorage.
- Return type
str
-
property
config_type¶ Gets the config_type of this S3CompatStorage.
- Returns
The config_type of this S3CompatStorage.
- Return type
str
-
property
endpoint_url¶ Gets the endpoint_url of this S3CompatStorage.
- Returns
The endpoint_url of this S3CompatStorage.
- Return type
str
-
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
-
property
path¶ Gets the path of this S3CompatStorage.
- Returns
The path of this S3CompatStorage.
- Return type
str
-
property
region¶ Gets the region of this S3CompatStorage.
- Returns
The region of this S3CompatStorage.
- Return type
str
-
property
signed_urls¶ Gets the signed_urls of this S3CompatStorage.
- Returns
The signed_urls of this S3CompatStorage.
- Return type
bool
-
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
-
property
verify_certs¶ Gets the verify_certs of this S3CompatStorage.
- Returns
The verify_certs of this S3CompatStorage.
- Return type
bool
-
property
flywheel.models.search_acquisition_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_acquisition_response.SearchAcquisitionResponse(id=None, label=None, timestamp=None, created=None)¶ Bases:
flywheel.models.mixins.AcquisitionMixin-
property
created¶ Gets the created of this SearchAcquisitionResponse.
Creation time (automatically set)
- Returns
The created of this SearchAcquisitionResponse.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SearchAcquisitionResponse.
Unique database ID
- Returns
The id of this SearchAcquisitionResponse.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SearchAcquisitionResponse.
Application-specific label
- Returns
The label of this SearchAcquisitionResponse.
- Return type
str
-
property
timestamp¶ Gets the timestamp of this SearchAcquisitionResponse.
- Returns
The timestamp of this SearchAcquisitionResponse.
- Return type
datetime
-
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
-
property
flywheel.models.search_analysis_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_analysis_response.SearchAnalysisResponse(id=None, label=None, user=None, created=None)¶ Bases:
flywheel.models.mixins.AnalysisMixin-
property
created¶ Gets the created of this SearchAnalysisResponse.
Creation time (automatically set)
- Returns
The created of this SearchAnalysisResponse.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SearchAnalysisResponse.
Unique database ID
- Returns
The id of this SearchAnalysisResponse.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SearchAnalysisResponse.
Application-specific label
- Returns
The label of this SearchAnalysisResponse.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
user¶ Gets the user of this SearchAnalysisResponse.
Database ID of a user
- Returns
The user of this SearchAnalysisResponse.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.search_collection_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_collection_response.SearchCollectionResponse(id=None, label=None, curator=None, created=None)¶ Bases:
flywheel.models.mixins.CollectionMixin-
property
created¶ Gets the created of this SearchCollectionResponse.
Creation time (automatically set)
- Returns
The created of this SearchCollectionResponse.
- Return type
datetime
-
property
curator¶ Gets the curator of this SearchCollectionResponse.
Database ID of a user
- Returns
The curator of this SearchCollectionResponse.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SearchCollectionResponse.
Unique database ID
- Returns
The id of this SearchCollectionResponse.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SearchCollectionResponse.
Application-specific label
- Returns
The label of this SearchCollectionResponse.
- Return type
str
-
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
-
property
flywheel.models.search_file_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_file_response.SearchFileResponse(classification=None, created=None, type=None, name=None, size=None)¶ Bases:
flywheel.models.mixins.FileMixin-
property
classification¶ Gets the classification of this SearchFileResponse.
- Returns
The classification of this SearchFileResponse.
- Return type
-
property
created¶ Gets the created of this SearchFileResponse.
Creation time (automatically set)
- Returns
The created of this SearchFileResponse.
- Return type
datetime
-
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
-
property
name¶ Gets the name of this SearchFileResponse.
The name of the file on disk
- Returns
The name of this SearchFileResponse.
- Return type
str
-
property
size¶ Gets the size of this SearchFileResponse.
Size of the file, in bytes
- Returns
The size of this SearchFileResponse.
- Return type
int
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this SearchFileResponse.
A descriptive file type (e.g. dicom, image, document, …)
- Returns
The type of this SearchFileResponse.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.search_group_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_group_response.SearchGroupResponse(id=None, label=None)¶ Bases:
flywheel.models.mixins.GroupMixin-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SearchGroupResponse.
Unique database ID
- Returns
The id of this SearchGroupResponse.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SearchGroupResponse.
Application-specific label
- Returns
The label of this SearchGroupResponse.
- Return type
str
-
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
-
flywheel.models.search_ml_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_ml_input.SearchMlInput(labels=None, search_query=None, files=None, output=None)¶ Bases:
object-
property
files¶ Gets the files of this SearchMlInput.
- Returns
The files of this SearchMlInput.
- Return type
list[SearchMlInputFile]
-
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
-
property
labels¶ Gets the labels of this SearchMlInput.
- Returns
The labels of this SearchMlInput.
- Return type
list[str]
-
property
output¶ Gets the output of this SearchMlInput.
- Returns
The output of this SearchMlInput.
- Return type
-
property
search_query¶ Gets the search_query of this SearchMlInput.
- Returns
The search_query of this SearchMlInput.
- Return type
-
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
-
property
flywheel.models.search_ml_input_file module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_ml_input_file.SearchMlInputFile(id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SearchMlInputFile.
- Returns
The id of this SearchMlInputFile.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.search_parent_analysis module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.search_parent_collection module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_parent_collection.SearchParentCollection¶ Bases:
flywheel.models.mixins.CollectionMixin-
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
-
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
-
flywheel.models.search_parent_project module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.search_parent_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_parent_response.SearchParentResponse(id=None, type=None)¶ Bases:
object-
discriminator_value_class_map= {'analysis': 'SearchParentAnalysis', 'collection': 'SearchParentCollection', 'project': 'SearchParentProject', 'session': 'SearchParentSession'}¶
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
get_real_child_model(data)¶ Returns the real base class specified by the discriminator
-
property
id¶ Gets the id of this SearchParentResponse.
Unique database ID
- Returns
The id of this SearchParentResponse.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this SearchParentResponse.
The type of container (e.g. session)
- Returns
The type of this SearchParentResponse.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.search_parent_session module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.search_parse_error module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_parse_error.SearchParseError(line=None, pos=None, offset=None, message=None)¶ Bases:
object-
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
-
property
line¶ Gets the line of this SearchParseError.
The line number where the error occurred
- Returns
The line of this SearchParseError.
- Return type
int
-
property
message¶ Gets the message of this SearchParseError.
The error message
- Returns
The message of this SearchParseError.
- Return type
str
-
property
offset¶ Gets the offset of this SearchParseError.
The absolute offset in the input (from 0) where the error occurred
- Returns
The offset of this SearchParseError.
- Return type
int
-
property
pos¶ Gets the pos of this SearchParseError.
The position where the error occurred
- Returns
The pos of this SearchParseError.
- Return type
int
-
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
-
flywheel.models.search_parse_search_query_result module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_parse_search_query_result.SearchParseSearchQueryResult(valid=None, errors=None)¶ Bases:
object-
property
errors¶ Gets the errors of this SearchParseSearchQueryResult.
- Returns
The errors of this SearchParseSearchQueryResult.
- Return type
list[SearchParseError]
-
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
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
valid¶ Gets the valid of this SearchParseSearchQueryResult.
Whether the structured query was valid or not
- Returns
The valid of this SearchParseSearchQueryResult.
- Return type
bool
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.search_project_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_project_response.SearchProjectResponse(id=None, label=None)¶ Bases:
flywheel.models.mixins.ProjectMixin-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SearchProjectResponse.
Unique database ID
- Returns
The id of this SearchProjectResponse.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SearchProjectResponse.
Application-specific label
- Returns
The label of this SearchProjectResponse.
- Return type
str
-
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
-
flywheel.models.search_query module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_query.SearchQuery(return_type=None, search_string=None, structured_query=None, all_data=False, filters=None)¶ Bases:
object-
property
all_data¶ Gets the all_data of this SearchQuery.
When set will include all data that the user does not have access to read
- Returns
The all_data of this SearchQuery.
- Return type
bool
-
property
filters¶ Gets the filters of this SearchQuery.
See https://www.elastic.co/guide/en/elasticsearch/reference/current/term-level-queries.html
- Returns
The filters of this SearchQuery.
- Return type
list[object]
-
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
-
property
return_type¶ Gets the return_type of this SearchQuery.
Sets the type of search results to return
- Returns
The return_type of this SearchQuery.
- Return type
str
-
property
search_string¶ Gets the search_string of this SearchQuery.
Represents the plain text search query
- Returns
The search_string of this SearchQuery.
- Return type
str
-
property
structured_query¶ Gets the structured_query of this SearchQuery.
Represents structured query language search
- Returns
The structured_query of this SearchQuery.
- Return type
str
-
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
-
property
flywheel.models.search_query_suggestions module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_query_suggestions.SearchQuerySuggestions(_from=None, suggestions=None)¶ Bases:
object-
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
-
property
suggestions¶ Gets the suggestions of this SearchQuerySuggestions.
The list of suggested replacements
- Returns
The suggestions of this SearchQuerySuggestions.
- Return type
list[SearchSuggestion]
-
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
-
flywheel.models.search_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_response.SearchResponse(return_type=None, project=None, group=None, session=None, acquisition=None, subject=None, file=None, collection=None, analysis=None, parent=None, permissions=None)¶ Bases:
flywheel.models.mixins.SearchResponseMixin-
property
acquisition¶ Gets the acquisition of this SearchResponse.
- Returns
The acquisition of this SearchResponse.
- Return type
-
property
analysis¶ Gets the analysis of this SearchResponse.
- Returns
The analysis of this SearchResponse.
- Return type
-
property
collection¶ Gets the collection of this SearchResponse.
- Returns
The collection of this SearchResponse.
- Return type
-
property
file¶ Gets the file of this SearchResponse.
- Returns
The file of this SearchResponse.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this SearchResponse.
- Returns
The group of this SearchResponse.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
parent¶ Gets the parent of this SearchResponse.
- Returns
The parent of this SearchResponse.
- Return type
-
property
permissions¶ Gets the permissions of this SearchResponse.
- Returns
The permissions of this SearchResponse.
- Return type
list[RolesRoleAssignment]
-
property
project¶ Gets the project of this SearchResponse.
- Returns
The project of this SearchResponse.
- Return type
-
property
return_type¶ Gets the return_type of this SearchResponse.
- Returns
The return_type of this SearchResponse.
- Return type
-
property
session¶ Gets the session of this SearchResponse.
- Returns
The session of this SearchResponse.
- Return type
-
property
subject¶ Gets the subject of this SearchResponse.
- Returns
The subject of this SearchResponse.
- Return type
-
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
-
property
flywheel.models.search_return_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.search_save_search module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_save_search.SearchSaveSearch(label=None, search=None, parent=None, id=None, created=None, modified=None)¶ Bases:
object-
property
created¶ Gets the created of this SearchSaveSearch.
Creation time (automatically set)
- Returns
The created of this SearchSaveSearch.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SearchSaveSearch.
Unique database ID
- Returns
The id of this SearchSaveSearch.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SearchSaveSearch.
Application-specific label
- Returns
The label of this SearchSaveSearch.
- Return type
str
-
property
modified¶ Gets the modified of this SearchSaveSearch.
Last modification time (automatically updated)
- Returns
The modified of this SearchSaveSearch.
- Return type
datetime
-
property
parent¶ Gets the parent of this SearchSaveSearch.
- Returns
The parent of this SearchSaveSearch.
- Return type
-
property
search¶ Gets the search of this SearchSaveSearch.
- Returns
The search of this SearchSaveSearch.
- Return type
-
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
-
property
flywheel.models.search_save_search_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_save_search_input.SearchSaveSearchInput(label=None, search=None, parent=None)¶ Bases:
object-
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
-
property
label¶ Gets the label of this SearchSaveSearchInput.
Application-specific label
- Returns
The label of this SearchSaveSearchInput.
- Return type
str
-
property
parent¶ Gets the parent of this SearchSaveSearchInput.
- Returns
The parent of this SearchSaveSearchInput.
- Return type
-
property
search¶ Gets the search of this SearchSaveSearchInput.
- Returns
The search of this SearchSaveSearchInput.
- Return type
-
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
-
flywheel.models.search_save_search_parent module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_save_search_parent.SearchSaveSearchParent(type=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SearchSaveSearchParent.
Unique database ID
- Returns
The id of this SearchSaveSearchParent.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this SearchSaveSearchParent.
- Returns
The type of this SearchSaveSearchParent.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.search_save_search_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_save_search_update.SearchSaveSearchUpdate(label=None, search=None)¶ Bases:
object-
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
-
property
label¶ Gets the label of this SearchSaveSearchUpdate.
Application-specific label
- Returns
The label of this SearchSaveSearchUpdate.
- Return type
str
-
property
search¶ Gets the search of this SearchSaveSearchUpdate.
- Returns
The search of this SearchSaveSearchUpdate.
- Return type
-
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
-
flywheel.models.search_session_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_session_response.SearchSessionResponse(id=None, label=None, timestamp=None, created=None)¶ Bases:
flywheel.models.mixins.SessionMixin-
property
created¶ Gets the created of this SearchSessionResponse.
Creation time (automatically set)
- Returns
The created of this SearchSessionResponse.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SearchSessionResponse.
Unique database ID
- Returns
The id of this SearchSessionResponse.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SearchSessionResponse.
Application-specific label
- Returns
The label of this SearchSessionResponse.
- Return type
str
-
property
timestamp¶ Gets the timestamp of this SearchSessionResponse.
- Returns
The timestamp of this SearchSessionResponse.
- Return type
datetime
-
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
-
property
flywheel.models.search_status module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_status.SearchStatus(status=None, last_seen=None)¶ Bases:
object-
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
-
property
last_seen¶ Gets the last_seen of this SearchStatus.
Last modification time (automatically updated)
- Returns
The last_seen of this SearchStatus.
- Return type
datetime
-
property
status¶ Gets the status of this SearchStatus.
- Returns
The status of this SearchStatus.
- Return type
str
-
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
-
flywheel.models.search_structured_search_query module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_structured_search_query.SearchStructuredSearchQuery(structured_query=None)¶ Bases:
object-
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
-
property
structured_query¶ Gets the structured_query of this SearchStructuredSearchQuery.
Represents structured query language search
- Returns
The structured_query of this SearchStructuredSearchQuery.
- Return type
str
-
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
-
flywheel.models.search_subject_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_subject_response.SearchSubjectResponse(code=None)¶ Bases:
flywheel.models.mixins.SubjectMixin-
property
code¶ Gets the code of this SearchSubjectResponse.
A unique identifier for the subject
- Returns
The code of this SearchSubjectResponse.
- Return type
str
-
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
-
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
-
property
flywheel.models.search_suggestion module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_suggestion.SearchSuggestion(display=None, value=None)¶ Bases:
object-
property
display¶ Gets the display of this SearchSuggestion.
The display value of the suggestion
- Returns
The display of this SearchSuggestion.
- Return type
str
-
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
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
value¶ Gets the value of this SearchSuggestion.
The value to use for replacement
- Returns
The value of this SearchSuggestion.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.session module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.session_container_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.session_embedded_subject module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.session_embedded_subject.SessionEmbeddedSubject(project=None, id=None, master_code=None, code=None, label=None, age=None)¶ Bases:
object-
property
age¶ Gets the age of this SessionEmbeddedSubject.
- Returns
The age of this SessionEmbeddedSubject.
- Return type
int
-
property
code¶ Gets the code of this SessionEmbeddedSubject.
- Returns
The code of this SessionEmbeddedSubject.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SessionEmbeddedSubject.
- Returns
The id of this SessionEmbeddedSubject.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SessionEmbeddedSubject.
- Returns
The label of this SessionEmbeddedSubject.
- Return type
str
-
property
master_code¶ Gets the master_code of this SessionEmbeddedSubject.
- Returns
The master_code of this SessionEmbeddedSubject.
- Return type
str
-
property
project¶ Gets the project of this SessionEmbeddedSubject.
- Returns
The project of this SessionEmbeddedSubject.
- Return type
str
-
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
-
property
flywheel.models.session_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.session_input.SessionInput(project=None, label=None, info=None, uid=None, timestamp=None, timezone=None, subject=None, age=None, weight=None, operator=None, project_has_template=False)¶ Bases:
object-
property
age¶ Gets the age of this SessionInput.
- Returns
The age of this SessionInput.
- Return type
int
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this SessionInput.
- Returns
The info of this SessionInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SessionInput.
- Returns
The label of this SessionInput.
- Return type
str
-
property
operator¶ Gets the operator of this SessionInput.
- Returns
The operator of this SessionInput.
- Return type
str
-
property
project¶ Gets the project of this SessionInput.
- Returns
The project of this SessionInput.
- Return type
str
-
property
project_has_template¶ Gets the project_has_template of this SessionInput.
- Returns
The project_has_template of this SessionInput.
- Return type
bool
-
property
subject¶ Gets the subject of this SessionInput.
- Returns
The subject of this SessionInput.
- Return type
union[SessionEmbeddedSubject,string]
-
property
timestamp¶ Gets the timestamp of this SessionInput.
- Returns
The timestamp of this SessionInput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this SessionInput.
- Returns
The timezone of this SessionInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this SessionInput.
- Returns
The uid of this SessionInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
weight¶ Gets the weight of this SessionInput.
- Returns
The weight of this SessionInput.
- Return type
float
-
property
flywheel.models.session_list_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.session_list_output.SessionListOutput(id=None, group=None, project=None, parents=None, label=None, uid=None, timestamp=None, timezone=None, permissions=None, tags=None, notes=None, subject=None, age=None, weight=None, operator=None, files=None, info=None, info_exists=None, created=None, modified=None, revision=None, satisfies_template=None, project_has_template=False, join_origin=None, analyses=None, copy_of=None, original_copy_of=None)¶ Bases:
flywheel.models.mixins.SessionMixin-
property
age¶ Gets the age of this SessionListOutput.
- Returns
The age of this SessionListOutput.
- Return type
int
-
property
analyses¶ Gets the analyses of this SessionListOutput.
- Returns
The analyses of this SessionListOutput.
- Return type
list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]
-
property
copy_of¶ Gets the copy_of of this SessionListOutput.
- Returns
The copy_of of this SessionListOutput.
- Return type
object
-
property
created¶ Gets the created of this SessionListOutput.
- Returns
The created of this SessionListOutput.
- Return type
datetime
-
property
files¶ Gets the files of this SessionListOutput.
- Returns
The files of this SessionListOutput.
- Return type
list[FileListOutput]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this SessionListOutput.
- Returns
The group of this SessionListOutput.
- Return type
str
-
property
id¶ Gets the id of this SessionListOutput.
- Returns
The id of this SessionListOutput.
- Return type
str
-
property
info¶ Gets the info of this SessionListOutput.
- Returns
The info of this SessionListOutput.
- Return type
object
-
property
info_exists¶ Gets the info_exists of this SessionListOutput.
- Returns
The info_exists of this SessionListOutput.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
property
join_origin¶ Gets the join_origin of this SessionListOutput.
- Returns
The join_origin of this SessionListOutput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SessionListOutput.
- Returns
The label of this SessionListOutput.
- Return type
str
-
property
modified¶ Gets the modified of this SessionListOutput.
- Returns
The modified of this SessionListOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this SessionListOutput.
- Returns
The notes of this SessionListOutput.
- Return type
list[Note]
-
property
operator¶ Gets the operator of this SessionListOutput.
- Returns
The operator of this SessionListOutput.
- Return type
str
-
property
original_copy_of¶ Gets the original_copy_of of this SessionListOutput.
- Returns
The original_copy_of of this SessionListOutput.
- Return type
object
-
property
parents¶ Gets the parents of this SessionListOutput.
- Returns
The parents of this SessionListOutput.
- Return type
-
property
permissions¶ Gets the permissions of this SessionListOutput.
- Returns
The permissions of this SessionListOutput.
- Return type
-
property
project¶ Gets the project of this SessionListOutput.
- Returns
The project of this SessionListOutput.
- Return type
str
-
property
project_has_template¶ Gets the project_has_template of this SessionListOutput.
- Returns
The project_has_template of this SessionListOutput.
- Return type
bool
-
property
revision¶ Gets the revision of this SessionListOutput.
- Returns
The revision of this SessionListOutput.
- Return type
int
-
property
satisfies_template¶ Gets the satisfies_template of this SessionListOutput.
- Returns
The satisfies_template of this SessionListOutput.
- Return type
bool
-
property
subject¶ Gets the subject of this SessionListOutput.
- Returns
The subject of this SessionListOutput.
- Return type
Gets the tags of this SessionListOutput.
- Returns
The tags of this SessionListOutput.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this SessionListOutput.
- Returns
The timestamp of this SessionListOutput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this SessionListOutput.
- Returns
The timezone of this SessionListOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this SessionListOutput.
- Returns
The uid of this SessionListOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
weight¶ Gets the weight of this SessionListOutput.
- Returns
The weight of this SessionListOutput.
- Return type
float
-
property
flywheel.models.session_metadata_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.session_metadata_input.SessionMetadataInput(label=None, info=None, operator=None, uid=None, timestamp=None, timezone=None, subject=None, tags=None, age=None, weight=None, files=None)¶ Bases:
object-
property
age¶ Gets the age of this SessionMetadataInput.
Subject age at time of session, in seconds
- Returns
The age of this SessionMetadataInput.
- Return type
int
-
property
files¶ Gets the files of this SessionMetadataInput.
- Returns
The files of this SessionMetadataInput.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this SessionMetadataInput.
- Returns
The info of this SessionMetadataInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SessionMetadataInput.
- Returns
The label of this SessionMetadataInput.
- Return type
str
-
property
operator¶ Gets the operator of this SessionMetadataInput.
- Returns
The operator of this SessionMetadataInput.
- Return type
str
-
property
subject¶ Gets the subject of this SessionMetadataInput.
- Returns
The subject of this SessionMetadataInput.
- Return type
Subject
Gets the tags of this SessionMetadataInput.
Array of application-specific tags
- Returns
The tags of this SessionMetadataInput.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this SessionMetadataInput.
- Returns
The timestamp of this SessionMetadataInput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this SessionMetadataInput.
- Returns
The timezone of this SessionMetadataInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this SessionMetadataInput.
- Returns
The uid of this SessionMetadataInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
weight¶ Gets the weight of this SessionMetadataInput.
Subject weight at time of session, in kilograms
- Returns
The weight of this SessionMetadataInput.
- Return type
float
-
property
flywheel.models.session_modify module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.session_modify.SessionModify(timestamp=None, project=None, subject=None, timezone=None, label=None, info=None, tags=None, permissions=None, age=None, weight=None, operator=None, project_has_template=False)¶ Bases:
object-
property
age¶ Gets the age of this SessionModify.
- Returns
The age of this SessionModify.
- Return type
int
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this SessionModify.
- Returns
The info of this SessionModify.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SessionModify.
- Returns
The label of this SessionModify.
- Return type
str
-
property
operator¶ Gets the operator of this SessionModify.
- Returns
The operator of this SessionModify.
- Return type
str
-
property
permissions¶ Gets the permissions of this SessionModify.
- Returns
The permissions of this SessionModify.
- Return type
list[RolePermission]
-
property
project¶ Gets the project of this SessionModify.
- Returns
The project of this SessionModify.
- Return type
str
-
property
project_has_template¶ Gets the project_has_template of this SessionModify.
- Returns
The project_has_template of this SessionModify.
- Return type
bool
-
property
subject¶ Gets the subject of this SessionModify.
- Returns
The subject of this SessionModify.
- Return type
union[string,SessionEmbeddedSubject]
Gets the tags of this SessionModify.
- Returns
The tags of this SessionModify.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this SessionModify.
- Returns
The timestamp of this SessionModify.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this SessionModify.
- Returns
The timezone of this SessionModify.
- Return type
str
-
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
-
property
weight¶ Gets the weight of this SessionModify.
- Returns
The weight of this SessionModify.
- Return type
float
-
property
flywheel.models.session_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.session_output.SessionOutput(id=None, group=None, project=None, parents=None, label=None, info=None, uid=None, timestamp=None, timezone=None, tags=None, notes=None, permissions=None, subject=None, age=None, weight=None, operator=None, files=None, created=None, modified=None, revision=None, satisfies_template=None, analyses=None, project_has_template=False, join_origin=None, copy_of=None, original_copy_of=None, info_exists=None)¶ Bases:
flywheel.models.mixins.SessionMixin-
property
age¶ Gets the age of this SessionOutput.
- Returns
The age of this SessionOutput.
- Return type
int
-
property
analyses¶ Gets the analyses of this SessionOutput.
- Returns
The analyses of this SessionOutput.
- Return type
list[union[AnalysisOutput,AnalysisOutputInflatedJob]]
-
property
copy_of¶ Gets the copy_of of this SessionOutput.
- Returns
The copy_of of this SessionOutput.
- Return type
str
-
property
created¶ Gets the created of this SessionOutput.
- Returns
The created of this SessionOutput.
- Return type
datetime
-
property
files¶ Gets the files of this SessionOutput.
- Returns
The files of this SessionOutput.
- Return type
list[FileOutput]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this SessionOutput.
- Returns
The group of this SessionOutput.
- Return type
str
-
property
id¶ Gets the id of this SessionOutput.
- Returns
The id of this SessionOutput.
- Return type
str
-
property
info¶ Gets the info of this SessionOutput.
- Returns
The info of this SessionOutput.
- Return type
object
-
property
info_exists¶ Gets the info_exists of this SessionOutput.
- Returns
The info_exists of this SessionOutput.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
property
join_origin¶ Gets the join_origin of this SessionOutput.
- Returns
The join_origin of this SessionOutput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SessionOutput.
- Returns
The label of this SessionOutput.
- Return type
str
-
property
modified¶ Gets the modified of this SessionOutput.
- Returns
The modified of this SessionOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this SessionOutput.
- Returns
The notes of this SessionOutput.
- Return type
list[Note]
-
property
operator¶ Gets the operator of this SessionOutput.
- Returns
The operator of this SessionOutput.
- Return type
str
-
property
original_copy_of¶ Gets the original_copy_of of this SessionOutput.
- Returns
The original_copy_of of this SessionOutput.
- Return type
str
-
property
parents¶ Gets the parents of this SessionOutput.
- Returns
The parents of this SessionOutput.
- Return type
-
property
permissions¶ Gets the permissions of this SessionOutput.
- Returns
The permissions of this SessionOutput.
- Return type
list[RolePermission]
-
property
project¶ Gets the project of this SessionOutput.
- Returns
The project of this SessionOutput.
- Return type
str
-
property
project_has_template¶ Gets the project_has_template of this SessionOutput.
- Returns
The project_has_template of this SessionOutput.
- Return type
bool
-
property
revision¶ Gets the revision of this SessionOutput.
- Returns
The revision of this SessionOutput.
- Return type
int
-
property
satisfies_template¶ Gets the satisfies_template of this SessionOutput.
- Returns
The satisfies_template of this SessionOutput.
- Return type
bool
-
property
subject¶ Gets the subject of this SessionOutput.
- Returns
The subject of this SessionOutput.
- Return type
Gets the tags of this SessionOutput.
- Returns
The tags of this SessionOutput.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this SessionOutput.
- Returns
The timestamp of this SessionOutput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this SessionOutput.
- Returns
The timezone of this SessionOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uid¶ Gets the uid of this SessionOutput.
- Returns
The uid of this SessionOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
weight¶ Gets the weight of this SessionOutput.
- Returns
The weight of this SessionOutput.
- Return type
float
-
property
flywheel.models.session_parents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.session_parents.SessionParents(group=None, subject=None, project=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this SessionParents.
- Returns
The group of this SessionParents.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this SessionParents.
- Returns
The project of this SessionParents.
- Return type
str
-
property
subject¶ Gets the subject of this SessionParents.
- Returns
The subject of this SessionParents.
- Return type
str
-
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
-
flywheel.models.session_template_options module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.session_template_options.SessionTemplateOptions(label=None, tags=None, subject=None)¶ Bases:
object-
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
-
property
label¶ Gets the label of this SessionTemplateOptions.
- Returns
The label of this SessionTemplateOptions.
- Return type
str
-
property
subject¶ Gets the subject of this SessionTemplateOptions.
- Returns
The subject of this SessionTemplateOptions.
- Return type
Gets the tags of this SessionTemplateOptions.
- Returns
The tags of this SessionTemplateOptions.
- Return type
str
-
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
-
flywheel.models.session_template_recalc_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.session_template_recalc_output.SessionTemplateRecalcOutput(sessions_changed=None)¶ Bases:
object-
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
-
property
sessions_changed¶ Gets the sessions_changed of this SessionTemplateRecalcOutput.
- Returns
The sessions_changed of this SessionTemplateRecalcOutput.
- Return type
list[str]
-
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
-
flywheel.models.sharing_filter_options module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.sharing_filter_options.SharingFilterOptions(therapeutic_areas=None, body_regions=None, organ_systems=None, age_groups=None, measurements=None, modalities=None, file_types=None, tags=None)¶ Bases:
object-
property
age_groups¶ Gets the age_groups of this SharingFilterOptions.
- Returns
The age_groups of this SharingFilterOptions.
- Return type
list[str]
-
property
body_regions¶ Gets the body_regions of this SharingFilterOptions.
- Returns
The body_regions of this SharingFilterOptions.
- Return type
list[str]
-
property
file_types¶ Gets the file_types of this SharingFilterOptions.
- Returns
The file_types of this SharingFilterOptions.
- Return type
list[str]
-
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
-
property
measurements¶ Gets the measurements of this SharingFilterOptions.
- Returns
The measurements of this SharingFilterOptions.
- Return type
list[str]
-
property
modalities¶ Gets the modalities of this SharingFilterOptions.
- Returns
The modalities of this SharingFilterOptions.
- Return type
list[str]
-
property
organ_systems¶ Gets the organ_systems of this SharingFilterOptions.
- Returns
The organ_systems of this SharingFilterOptions.
- Return type
list[str]
Gets the tags of this SharingFilterOptions.
- Returns
The tags of this SharingFilterOptions.
- Return type
list[str]
-
property
therapeutic_areas¶ Gets the therapeutic_areas of this SharingFilterOptions.
- Returns
The therapeutic_areas of this SharingFilterOptions.
- Return type
list[str]
-
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
-
property
flywheel.models.signed_url_upload_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.signed_url_upload_input.SignedUrlUploadInput(provider_id=None, size=None)¶ Bases:
object-
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
-
property
provider_id¶ Gets the provider_id of this SignedUrlUploadInput.
- Returns
The provider_id of this SignedUrlUploadInput.
- Return type
str
-
property
size¶ Gets the size of this SignedUrlUploadInput.
- Returns
The size of this SignedUrlUploadInput.
- Return type
int
-
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
-
flywheel.models.signed_url_upload_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.signed_url_upload_output.SignedUrlUploadOutput(provider_id=None, uuid=None, upload_urls=None, upload_headers=None, s3_multipart_upload_id=None, az_multipart_upload_id=None, note=None)¶ Bases:
object-
property
az_multipart_upload_id¶ Gets the az_multipart_upload_id of this SignedUrlUploadOutput.
- Returns
The az_multipart_upload_id of this SignedUrlUploadOutput.
- Return type
str
-
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
-
property
note¶ Gets the note of this SignedUrlUploadOutput.
- Returns
The note of this SignedUrlUploadOutput.
- Return type
str
-
property
provider_id¶ Gets the provider_id of this SignedUrlUploadOutput.
- Returns
The provider_id of this SignedUrlUploadOutput.
- Return type
str
-
property
s3_multipart_upload_id¶ Gets the s3_multipart_upload_id of this SignedUrlUploadOutput.
- Returns
The s3_multipart_upload_id of this SignedUrlUploadOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
upload_headers¶ Gets the upload_headers of this SignedUrlUploadOutput.
- Returns
The upload_headers of this SignedUrlUploadOutput.
- Return type
dict(str, str)
-
property
upload_urls¶ Gets the upload_urls of this SignedUrlUploadOutput.
- Returns
The upload_urls of this SignedUrlUploadOutput.
- Return type
list[str]
-
property
uuid¶ Gets the uuid of this SignedUrlUploadOutput.
- Returns
The uuid of this SignedUrlUploadOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.site module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.site.Site(id='local', api_url='https://localhost/api', central_url='https://sdmc.scitran.io/api', deid_log_url=None, dimse_host=None, dimse_port=None, mfa_code_length=6, inactivity_timeout=None, name='Local', redirect_url='https://local.flywheel.io', registered=False, ssl_cert=None, upload_maximum_bytes='10737418240', proxy_cdn=False, gravatar_address='https://gravatar.com')¶ Bases:
object-
property
api_url¶ Gets the api_url of this Site.
- Returns
The api_url of this Site.
- Return type
str
-
property
central_url¶ Gets the central_url of this Site.
- Returns
The central_url of this Site.
- Return type
str
-
property
deid_log_url¶ Gets the deid_log_url of this Site.
- Returns
The deid_log_url of this Site.
- Return type
str
-
property
dimse_host¶ Gets the dimse_host of this Site.
- Returns
The dimse_host of this Site.
- Return type
str
-
property
dimse_port¶ Gets the dimse_port of this Site.
- Returns
The dimse_port of this Site.
- Return type
int
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
gravatar_address¶ Gets the gravatar_address of this Site.
- Returns
The gravatar_address of this Site.
- Return type
str
-
property
id¶ Gets the id of this Site.
- Returns
The id of this Site.
- Return type
str
-
property
inactivity_timeout¶ Gets the inactivity_timeout of this Site.
- Returns
The inactivity_timeout of this Site.
- Return type
int
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
mfa_code_length¶ Gets the mfa_code_length of this Site.
- Returns
The mfa_code_length of this Site.
- Return type
int
-
property
name¶ Gets the name of this Site.
- Returns
The name of this Site.
- Return type
str
-
property
proxy_cdn¶ Gets the proxy_cdn of this Site.
- Returns
The proxy_cdn of this Site.
- Return type
bool
-
property
redirect_url¶ Gets the redirect_url of this Site.
- Returns
The redirect_url of this Site.
- Return type
str
-
property
registered¶ Gets the registered of this Site.
- Returns
The registered of this Site.
- Return type
bool
-
property
ssl_cert¶ Gets the ssl_cert of this Site.
- Returns
The ssl_cert of this Site.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
upload_maximum_bytes¶ Gets the upload_maximum_bytes of this Site.
- Returns
The upload_maximum_bytes of this Site.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.site_settings module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.site_settings.SiteSettings(id=None, created=None, modified=None, center_gears=None, providers=None, ldap_sync=None, viewer_apps=None, deid_profile=None)¶ Bases:
object-
property
center_gears¶ Gets the center_gears of this SiteSettings.
- Returns
The center_gears of this SiteSettings.
- Return type
list[str]
-
property
created¶ Gets the created of this SiteSettings.
- Returns
The created of this SiteSettings.
- Return type
datetime
-
property
deid_profile¶ Gets the deid_profile of this SiteSettings.
- Returns
The deid_profile of this SiteSettings.
- Return type
object
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SiteSettings.
- Returns
The id of this SiteSettings.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
ldap_sync¶ Gets the ldap_sync of this SiteSettings.
- Returns
The ldap_sync of this SiteSettings.
- Return type
-
property
modified¶ Gets the modified of this SiteSettings.
- Returns
The modified of this SiteSettings.
- Return type
datetime
-
property
providers¶ Gets the providers of this SiteSettings.
- Returns
The providers of this SiteSettings.
- Return type
-
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
-
property
flywheel.models.sort module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.sort.Sort(field=None, order=None)¶ Bases:
object-
property
field¶ Gets the field of this Sort.
- Returns
The field of this Sort.
- Return type
str
-
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
-
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
-
property
flywheel.models.static_compute module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.static_compute.StaticCompute(config_type=None, config_class=None, tags=None)¶ Bases:
object-
property
config_class¶ Gets the config_class of this StaticCompute.
- Returns
The config_class of this StaticCompute.
- Return type
str
-
property
config_type¶ Gets the config_type of this StaticCompute.
- Returns
The config_type of this StaticCompute.
- Return type
str
-
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
Gets the tags of this StaticCompute.
- Returns
The tags of this StaticCompute.
- Return type
object
-
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
-
property
flywheel.models.status_value module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.storage_strategy module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.storage_strategy_config module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.storage_strategy_config.StorageStrategyConfig(storage_strategy=None, provider=None)¶ Bases:
object-
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
-
property
provider¶ Gets the provider of this StorageStrategyConfig.
- Returns
The provider of this StorageStrategyConfig.
- Return type
str
-
property
storage_strategy¶ Gets the storage_strategy of this StorageStrategyConfig.
- Returns
The storage_strategy of this StorageStrategyConfig.
- Return type
-
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
-
flywheel.models.subject module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.subject_container_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.subject_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.subject_input.SubjectInput(firstname=None, lastname=None, sex=None, cohort=None, date_of_birth=None, mlset=None, type=None, race=None, ethnicity=None, species=None, strain=None, label=None, code=None, master_code=None, tags=None, info=None, state=None, project=None)¶ Bases:
object-
property
code¶ Gets the code of this SubjectInput.
- Returns
The code of this SubjectInput.
- Return type
str
-
property
cohort¶ Gets the cohort of this SubjectInput.
- Returns
The cohort of this SubjectInput.
- Return type
-
property
date_of_birth¶ Gets the date_of_birth of this SubjectInput.
- Returns
The date_of_birth of this SubjectInput.
- Return type
datetime
-
property
ethnicity¶ Gets the ethnicity of this SubjectInput.
- Returns
The ethnicity of this SubjectInput.
- Return type
str
-
property
firstname¶ Gets the firstname of this SubjectInput.
- Returns
The firstname of this SubjectInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this SubjectInput.
- Returns
The info of this SubjectInput.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SubjectInput.
- Returns
The label of this SubjectInput.
- Return type
str
-
property
lastname¶ Gets the lastname of this SubjectInput.
- Returns
The lastname of this SubjectInput.
- Return type
str
-
property
master_code¶ Gets the master_code of this SubjectInput.
- Returns
The master_code of this SubjectInput.
- Return type
str
-
property
mlset¶ Gets the mlset of this SubjectInput.
- Returns
The mlset of this SubjectInput.
- Return type
-
property
project¶ Gets the project of this SubjectInput.
- Returns
The project of this SubjectInput.
- Return type
str
-
property
race¶ Gets the race of this SubjectInput.
- Returns
The race of this SubjectInput.
- Return type
str
-
property
sex¶ Gets the sex of this SubjectInput.
- Returns
The sex of this SubjectInput.
- Return type
str
-
property
species¶ Gets the species of this SubjectInput.
- Returns
The species of this SubjectInput.
- Return type
str
-
property
state¶ Gets the state of this SubjectInput.
- Returns
The state of this SubjectInput.
- Return type
-
property
strain¶ Gets the strain of this SubjectInput.
- Returns
The strain of this SubjectInput.
- Return type
str
Gets the tags of this SubjectInput.
- Returns
The tags of this SubjectInput.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this SubjectInput.
- Returns
The type of this SubjectInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.subject_modify module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.subject_modify.SubjectModify(firstname=None, lastname=None, sex=None, cohort=None, date_of_birth=None, mlset=None, type=None, race=None, ethnicity=None, species=None, strain=None, label=None, code=None, master_code=None, tags=None, info=None, state=None, project=None, permissions=None, notes=None)¶ Bases:
object-
property
code¶ Gets the code of this SubjectModify.
- Returns
The code of this SubjectModify.
- Return type
str
-
property
cohort¶ Gets the cohort of this SubjectModify.
- Returns
The cohort of this SubjectModify.
- Return type
-
property
date_of_birth¶ Gets the date_of_birth of this SubjectModify.
- Returns
The date_of_birth of this SubjectModify.
- Return type
datetime
-
property
ethnicity¶ Gets the ethnicity of this SubjectModify.
- Returns
The ethnicity of this SubjectModify.
- Return type
str
-
property
firstname¶ Gets the firstname of this SubjectModify.
- Returns
The firstname of this SubjectModify.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
info¶ Gets the info of this SubjectModify.
- Returns
The info of this SubjectModify.
- Return type
object
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SubjectModify.
- Returns
The label of this SubjectModify.
- Return type
str
-
property
lastname¶ Gets the lastname of this SubjectModify.
- Returns
The lastname of this SubjectModify.
- Return type
str
-
property
master_code¶ Gets the master_code of this SubjectModify.
- Returns
The master_code of this SubjectModify.
- Return type
str
-
property
mlset¶ Gets the mlset of this SubjectModify.
- Returns
The mlset of this SubjectModify.
- Return type
-
property
notes¶ Gets the notes of this SubjectModify.
- Returns
The notes of this SubjectModify.
- Return type
list[Note]
-
property
permissions¶ Gets the permissions of this SubjectModify.
- Returns
The permissions of this SubjectModify.
- Return type
list[RolePermission]
-
property
project¶ Gets the project of this SubjectModify.
- Returns
The project of this SubjectModify.
- Return type
str
-
property
race¶ Gets the race of this SubjectModify.
- Returns
The race of this SubjectModify.
- Return type
str
-
property
sex¶ Gets the sex of this SubjectModify.
- Returns
The sex of this SubjectModify.
- Return type
str
-
property
species¶ Gets the species of this SubjectModify.
- Returns
The species of this SubjectModify.
- Return type
str
-
property
state¶ Gets the state of this SubjectModify.
- Returns
The state of this SubjectModify.
- Return type
-
property
strain¶ Gets the strain of this SubjectModify.
- Returns
The strain of this SubjectModify.
- Return type
str
Gets the tags of this SubjectModify.
- Returns
The tags of this SubjectModify.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this SubjectModify.
- Returns
The type of this SubjectModify.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.subject_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.subject_output.SubjectOutput(id=None, project=None, created=None, date_of_birth=None, modified=None, revision=None, parents=None, permissions=None, firstname=None, lastname=None, sex=None, age=None, cohort=None, mlset=None, type=None, race=None, ethnicity=None, species=None, strain=None, label=None, code=None, master_code=None, notes=None, tags=None, info=None, info_exists=None, state=None, files=None, analyses=None, join_origin=None, copy_of=None, original_copy_of=None)¶ Bases:
flywheel.models.mixins.SubjectMixin-
property
age¶ Gets the age of this SubjectOutput.
- Returns
The age of this SubjectOutput.
- Return type
int
-
property
analyses¶ Gets the analyses of this SubjectOutput.
- Returns
The analyses of this SubjectOutput.
- Return type
list[union[AnalysisOutput,AnalysisOutputInflatedJob]]
-
property
code¶ Gets the code of this SubjectOutput.
- Returns
The code of this SubjectOutput.
- Return type
str
-
property
cohort¶ Gets the cohort of this SubjectOutput.
- Returns
The cohort of this SubjectOutput.
- Return type
-
property
copy_of¶ Gets the copy_of of this SubjectOutput.
- Returns
The copy_of of this SubjectOutput.
- Return type
str
-
property
created¶ Gets the created of this SubjectOutput.
- Returns
The created of this SubjectOutput.
- Return type
datetime
-
property
date_of_birth¶ Gets the date_of_birth of this SubjectOutput.
- Returns
The date_of_birth of this SubjectOutput.
- Return type
datetime
-
property
ethnicity¶ Gets the ethnicity of this SubjectOutput.
- Returns
The ethnicity of this SubjectOutput.
- Return type
str
-
property
files¶ Gets the files of this SubjectOutput.
- Returns
The files of this SubjectOutput.
- Return type
list[FileOutput]
-
property
firstname¶ Gets the firstname of this SubjectOutput.
- Returns
The firstname of this SubjectOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SubjectOutput.
- Returns
The id of this SubjectOutput.
- Return type
str
-
property
info¶ Gets the info of this SubjectOutput.
- Returns
The info of this SubjectOutput.
- Return type
object
-
property
info_exists¶ Gets the info_exists of this SubjectOutput.
- Returns
The info_exists of this SubjectOutput.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
property
join_origin¶ Gets the join_origin of this SubjectOutput.
- Returns
The join_origin of this SubjectOutput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SubjectOutput.
- Returns
The label of this SubjectOutput.
- Return type
str
-
property
lastname¶ Gets the lastname of this SubjectOutput.
- Returns
The lastname of this SubjectOutput.
- Return type
str
-
property
master_code¶ Gets the master_code of this SubjectOutput.
- Returns
The master_code of this SubjectOutput.
- Return type
str
-
property
mlset¶ Gets the mlset of this SubjectOutput.
- Returns
The mlset of this SubjectOutput.
- Return type
-
property
modified¶ Gets the modified of this SubjectOutput.
- Returns
The modified of this SubjectOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this SubjectOutput.
- Returns
The notes of this SubjectOutput.
- Return type
list[Note]
-
property
original_copy_of¶ Gets the original_copy_of of this SubjectOutput.
- Returns
The original_copy_of of this SubjectOutput.
- Return type
str
-
property
parents¶ Gets the parents of this SubjectOutput.
- Returns
The parents of this SubjectOutput.
- Return type
-
property
permissions¶ Gets the permissions of this SubjectOutput.
- Returns
The permissions of this SubjectOutput.
- Return type
list[SubjectRolePermission]
-
property
project¶ Gets the project of this SubjectOutput.
- Returns
The project of this SubjectOutput.
- Return type
str
-
property
race¶ Gets the race of this SubjectOutput.
- Returns
The race of this SubjectOutput.
- Return type
str
-
property
revision¶ Gets the revision of this SubjectOutput.
- Returns
The revision of this SubjectOutput.
- Return type
int
-
property
sex¶ Gets the sex of this SubjectOutput.
- Returns
The sex of this SubjectOutput.
- Return type
str
-
property
species¶ Gets the species of this SubjectOutput.
- Returns
The species of this SubjectOutput.
- Return type
str
-
property
state¶ Gets the state of this SubjectOutput.
- Returns
The state of this SubjectOutput.
- Return type
-
property
strain¶ Gets the strain of this SubjectOutput.
- Returns
The strain of this SubjectOutput.
- Return type
str
Gets the tags of this SubjectOutput.
- Returns
The tags of this SubjectOutput.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this SubjectOutput.
- Returns
The type of this SubjectOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.subject_output_for_list module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.subject_output_for_list.SubjectOutputForList(id=None, project=None, created=None, date_of_birth=None, modified=None, revision=None, parents=None, permissions=None, cohort=None, mlset=None, type=None, species=None, strain=None, label=None, code=None, master_code=None, notes=None, tags=None, info=None, info_exists=None, state=None, files=None, analyses=None, join_origin=None, copy_of=None, original_copy_of=None, firstname=None, lastname=None, sex=None, age=None, race=None, ethnicity=None)¶ Bases:
flywheel.models.mixins.SubjectMixin-
property
age¶ Gets the age of this SubjectOutputForList.
- Returns
The age of this SubjectOutputForList.
- Return type
int
-
property
analyses¶ Gets the analyses of this SubjectOutputForList.
- Returns
The analyses of this SubjectOutputForList.
- Return type
list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]
-
property
code¶ Gets the code of this SubjectOutputForList.
- Returns
The code of this SubjectOutputForList.
- Return type
str
-
property
cohort¶ Gets the cohort of this SubjectOutputForList.
- Returns
The cohort of this SubjectOutputForList.
- Return type
-
property
copy_of¶ Gets the copy_of of this SubjectOutputForList.
- Returns
The copy_of of this SubjectOutputForList.
- Return type
str
-
property
created¶ Gets the created of this SubjectOutputForList.
- Returns
The created of this SubjectOutputForList.
- Return type
datetime
-
property
date_of_birth¶ Gets the date_of_birth of this SubjectOutputForList.
- Returns
The date_of_birth of this SubjectOutputForList.
- Return type
datetime
-
property
ethnicity¶ Gets the ethnicity of this SubjectOutputForList.
- Returns
The ethnicity of this SubjectOutputForList.
- Return type
str
-
property
files¶ Gets the files of this SubjectOutputForList.
- Returns
The files of this SubjectOutputForList.
- Return type
list[FileListOutput]
-
property
firstname¶ Gets the firstname of this SubjectOutputForList.
- Returns
The firstname of this SubjectOutputForList.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SubjectOutputForList.
- Returns
The id of this SubjectOutputForList.
- Return type
str
-
property
info¶ Gets the info of this SubjectOutputForList.
- Returns
The info of this SubjectOutputForList.
- Return type
object
-
property
info_exists¶ Gets the info_exists of this SubjectOutputForList.
- Returns
The info_exists of this SubjectOutputForList.
- Return type
bool
-
items()¶ Returns the list of json property to value mapping
-
property
join_origin¶ Gets the join_origin of this SubjectOutputForList.
- Returns
The join_origin of this SubjectOutputForList.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SubjectOutputForList.
- Returns
The label of this SubjectOutputForList.
- Return type
str
-
property
lastname¶ Gets the lastname of this SubjectOutputForList.
- Returns
The lastname of this SubjectOutputForList.
- Return type
str
-
property
master_code¶ Gets the master_code of this SubjectOutputForList.
- Returns
The master_code of this SubjectOutputForList.
- Return type
str
-
property
mlset¶ Gets the mlset of this SubjectOutputForList.
- Returns
The mlset of this SubjectOutputForList.
- Return type
-
property
modified¶ Gets the modified of this SubjectOutputForList.
- Returns
The modified of this SubjectOutputForList.
- Return type
datetime
-
property
notes¶ Gets the notes of this SubjectOutputForList.
- Returns
The notes of this SubjectOutputForList.
- Return type
list[Note]
-
property
original_copy_of¶ Gets the original_copy_of of this SubjectOutputForList.
- Returns
The original_copy_of of this SubjectOutputForList.
- Return type
str
-
property
parents¶ Gets the parents of this SubjectOutputForList.
- Returns
The parents of this SubjectOutputForList.
- Return type
-
property
permissions¶ Gets the permissions of this SubjectOutputForList.
- Returns
The permissions of this SubjectOutputForList.
- Return type
list[RolePermission]
-
property
project¶ Gets the project of this SubjectOutputForList.
- Returns
The project of this SubjectOutputForList.
- Return type
str
-
property
race¶ Gets the race of this SubjectOutputForList.
- Returns
The race of this SubjectOutputForList.
- Return type
str
-
property
revision¶ Gets the revision of this SubjectOutputForList.
- Returns
The revision of this SubjectOutputForList.
- Return type
int
-
property
sex¶ Gets the sex of this SubjectOutputForList.
- Returns
The sex of this SubjectOutputForList.
- Return type
str
-
property
species¶ Gets the species of this SubjectOutputForList.
- Returns
The species of this SubjectOutputForList.
- Return type
str
-
property
state¶ Gets the state of this SubjectOutputForList.
- Returns
The state of this SubjectOutputForList.
- Return type
-
property
strain¶ Gets the strain of this SubjectOutputForList.
- Returns
The strain of this SubjectOutputForList.
- Return type
str
Gets the tags of this SubjectOutputForList.
- Returns
The tags of this SubjectOutputForList.
- Return type
list[str]
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this SubjectOutputForList.
- Returns
The type of this SubjectOutputForList.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.subject_parents module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.subject_parents.SubjectParents(group=None, project=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this SubjectParents.
- Returns
The group of this SubjectParents.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
project¶ Gets the project of this SubjectParents.
- Returns
The project of this SubjectParents.
- Return type
str
-
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
-
flywheel.models.subject_role_permission module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.subject_role_permission.SubjectRolePermission(id=None, role_ids=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SubjectRolePermission.
- Returns
The id of this SubjectRolePermission.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
role_ids¶ Gets the role_ids of this SubjectRolePermission.
- Returns
The role_ids of this SubjectRolePermission.
- Return type
list[str]
-
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
-
flywheel.models.subject_state module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.subject_template_options module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.subject_template_options.SubjectTemplateOptions(code=None, tags=None)¶ Bases:
object-
property
code¶ Gets the code of this SubjectTemplateOptions.
- Returns
The code of this SubjectTemplateOptions.
- Return type
str
-
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
Gets the tags of this SubjectTemplateOptions.
- Returns
The tags of this SubjectTemplateOptions.
- Return type
str
-
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
-
property
flywheel.models.tag module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.tag.Tag(value=None)¶ Bases:
object-
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
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
value¶ Gets the value of this Tag.
- Returns
The value of this Tag.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.therapeutic_area module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.therapeutic_area.TherapeuticArea¶ Bases:
str,enum.EnumAn enumeration.
-
CARDIOLOGY_VASCULAR_DISEASE= 'Cardiology/Vascular Disease'¶
-
DENTAL_AND_ORAL_HEALTH= 'Dental and Oral Health'¶
-
DERMATOLOGY= 'Dermatology'¶
-
DEVICES= 'Devices'¶
-
ENDOCRINOLOGY= 'Endocrinology'¶
-
FAMILY_MEDICINE= 'Family Medicine'¶
-
GASTROENTEROLOGY= 'Gastroenterology'¶
-
GENETIC_DISEASE= 'Genetic Disease'¶
-
GENE_THERAPY= 'Gene Therapy'¶
-
HEMATOLOGY= 'Hematology'¶
-
HEPATOLOGY= 'Hepatology'¶
-
IMMUNOLOGY= 'Immunology'¶
-
INFECTIOUS_DISEASE= 'Infectious Disease'¶
-
INTERNAL_MEDICINE= 'Internal Medicine'¶
-
MUSCULOSKELETAL= 'Musculoskeletal'¶
-
NEPHROLOGY= 'Nephrology'¶
-
NEUROLOGY= 'Neurology'¶
-
NUTRITION_AND_WEIGHT_LOSS= 'Nutrition and Weight Loss'¶
-
OBSTETRICS_GYNECOLOGY= 'Obstetrics & Gynecology'¶
-
ONCOLOGY= 'Oncology'¶
-
OPHTHALMOLOGY= 'Ophthalmology'¶
-
ORTHOPEDICS= 'Orthopedics'¶
-
OTOLARYNGOLOGY= 'Otolaryngology'¶
-
PEDIATRICS_NEONATOLOGY= 'Pediatrics & Neonatology'¶
-
PHARMACOLOGY_TOXICOLOGY= 'Pharmacology & Toxicology'¶
-
PLASTIC_SURGERY= 'Plastic Surgery'¶
-
PODIATRY= 'Podiatry'¶
-
PSYCHIATRY_PSYCHOLOGY= 'Psychiatry/Psychology'¶
-
PULMONARY_RESPIRATORY_DISEASE= 'Pulmonary/Respiratory Disease'¶
-
RHEUMATOLOGY= 'Rheumatology'¶
-
SLEEP_MEDICINE= 'Sleep Medicine'¶
-
TRAUMA= 'Trauma'¶
-
UROLOGY= 'Urology'¶
-
flywheel.models.transitions module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.transitions.Transitions(pending=None, running=None, failed=None, complete=None, cancelled=None)¶ Bases:
object-
property
cancelled¶ Gets the cancelled of this Transitions.
- Returns
The cancelled of this Transitions.
- Return type
datetime
-
property
complete¶ Gets the complete of this Transitions.
- Returns
The complete of this Transitions.
- Return type
datetime
-
property
failed¶ Gets the failed of this Transitions.
- Returns
The failed of this Transitions.
- Return type
datetime
-
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
-
property
pending¶ Gets the pending of this Transitions.
- Returns
The pending of this Transitions.
- Return type
datetime
-
property
running¶ Gets the running of this Transitions.
- Returns
The running of this Transitions.
- Return type
datetime
-
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
-
property
flywheel.models.tree_container_request_spec module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.tree_container_request_spec.TreeContainerRequestSpec(fields=None, filter=None, limit=None, sort=None, join_origin=None)¶ Bases:
object-
property
fields¶ Gets the fields of this TreeContainerRequestSpec.
The list of fields to include
- Returns
The fields of this TreeContainerRequestSpec.
- Return type
list[str]
-
property
filter¶ Gets the filter of this TreeContainerRequestSpec.
The optional, comma-separated filter string
- Returns
The filter of this TreeContainerRequestSpec.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
join_origin¶ Gets the join_origin of this TreeContainerRequestSpec.
Whether or not to join file origins, default is false
- Returns
The join_origin of this TreeContainerRequestSpec.
- Return type
bool
-
keys()¶ Returns the list of json properties in the object
-
property
limit¶ Gets the limit of this TreeContainerRequestSpec.
The optional maximum number of children to include
- Returns
The limit of this TreeContainerRequestSpec.
- Return type
int
-
property
sort¶ Gets the sort of this TreeContainerRequestSpec.
The optional, comma-separated, sort specification
- Returns
The sort of this TreeContainerRequestSpec.
- Return type
str
-
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
-
property
flywheel.models.tree_graph module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.tree_graph.TreeGraph¶ Bases:
object-
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
-
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
-
flywheel.models.tree_graph_connection module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.tree_graph_connection.TreeGraphConnection(local=None, foreign=None, collection=None, order=None)¶ Bases:
object-
property
collection¶ Gets the collection of this TreeGraphConnection.
- Returns
The collection of this TreeGraphConnection.
- Return type
str
-
property
foreign¶ Gets the foreign of this TreeGraphConnection.
- Returns
The foreign of this TreeGraphConnection.
- Return type
str
-
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
-
property
local¶ Gets the local of this TreeGraphConnection.
- Returns
The local of this TreeGraphConnection.
- Return type
str
-
property
order¶ Gets the order of this TreeGraphConnection.
- Returns
The order of this TreeGraphConnection.
- Return type
str
-
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
-
property
flywheel.models.tree_graph_connections module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.tree_graph_connections.TreeGraphConnections¶ Bases:
object-
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
-
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
-
flywheel.models.tree_graph_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.tree_graph_node.TreeGraphNode(connections=None)¶ Bases:
object-
property
connections¶ Gets the connections of this TreeGraphNode.
- Returns
The connections of this TreeGraphNode.
- Return type
-
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
-
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
-
property
flywheel.models.tree_request module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.tree_request.TreeRequest(groups=None, projects=None, subjects=None, sessions=None, acquisitions=None, analyses=None, jobs=None)¶ Bases:
object-
property
acquisitions¶ Gets the acquisitions of this TreeRequest.
- Returns
The acquisitions of this TreeRequest.
- Return type
-
property
analyses¶ Gets the analyses of this TreeRequest.
- Returns
The analyses of this TreeRequest.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
groups¶ Gets the groups of this TreeRequest.
- Returns
The groups of this TreeRequest.
- Return type
-
items()¶ Returns the list of json property to value mapping
-
property
jobs¶ Gets the jobs of this TreeRequest.
- Returns
The jobs of this TreeRequest.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
projects¶ Gets the projects of this TreeRequest.
- Returns
The projects of this TreeRequest.
- Return type
-
property
sessions¶ Gets the sessions of this TreeRequest.
- Returns
The sessions of this TreeRequest.
- Return type
-
property
subjects¶ Gets the subjects of this TreeRequest.
- Returns
The subjects of this TreeRequest.
- Return type
-
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
-
property
flywheel.models.tree_response_item module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.tree_response_item.TreeResponseItem¶ Bases:
object-
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
-
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
-
flywheel.models.type_str module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.upload_complete_s3_multipart_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.upload_complete_s3_multipart_input.UploadCompleteS3MultipartInput(provider_id=None, uuid=None, upload_id=None, e_tags=None)¶ Bases:
objectGets the e_tags of this UploadCompleteS3MultipartInput.
- Returns
The e_tags of this UploadCompleteS3MultipartInput.
- Return type
list[str]
-
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
-
property
provider_id¶ Gets the provider_id of this UploadCompleteS3MultipartInput.
- Returns
The provider_id of this UploadCompleteS3MultipartInput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
upload_id¶ Gets the upload_id of this UploadCompleteS3MultipartInput.
- Returns
The upload_id of this UploadCompleteS3MultipartInput.
- Return type
str
-
property
uuid¶ Gets the uuid of this UploadCompleteS3MultipartInput.
- Returns
The uuid of this UploadCompleteS3MultipartInput.
- Return type
str
-
values()¶ Returns the list of values in the object
flywheel.models.upload_complete_s3_multipart_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.upload_complete_s3_multipart_output.UploadCompleteS3MultipartOutput(provider_id=None, uuid=None)¶ Bases:
object-
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
-
property
provider_id¶ Gets the provider_id of this UploadCompleteS3MultipartOutput.
- Returns
The provider_id of this UploadCompleteS3MultipartOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uuid¶ Gets the uuid of this UploadCompleteS3MultipartOutput.
- Returns
The uuid of this UploadCompleteS3MultipartOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.upload_signed_fs_file_upload_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.upload_signed_fs_file_upload_output.UploadSignedFsFileUploadOutput(provider_id=None, uuid=None)¶ Bases:
object-
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
-
property
provider_id¶ Gets the provider_id of this UploadSignedFsFileUploadOutput.
- Returns
The provider_id of this UploadSignedFsFileUploadOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
uuid¶ Gets the uuid of this UploadSignedFsFileUploadOutput.
- Returns
The uuid of this UploadSignedFsFileUploadOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.upload_signed_upload_url_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.upload_signed_upload_url_input.UploadSignedUploadUrlInput(provider_id=None, size=None)¶ Bases:
object-
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
-
property
provider_id¶ Gets the provider_id of this UploadSignedUploadUrlInput.
- Returns
The provider_id of this UploadSignedUploadUrlInput.
- Return type
str
-
property
size¶ Gets the size of this UploadSignedUploadUrlInput.
- Returns
The size of this UploadSignedUploadUrlInput.
- Return type
int
-
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
-
flywheel.models.upload_signed_upload_url_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.upload_signed_upload_url_output.UploadSignedUploadUrlOutput(provider_id=None, uuid=None, upload_urls=None, upload_headers=None, s3_multipart_upload_id=None, note=None)¶ Bases:
object-
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
-
property
note¶ Gets the note of this UploadSignedUploadUrlOutput.
- Returns
The note of this UploadSignedUploadUrlOutput.
- Return type
str
-
property
provider_id¶ Gets the provider_id of this UploadSignedUploadUrlOutput.
- Returns
The provider_id of this UploadSignedUploadUrlOutput.
- Return type
str
-
property
s3_multipart_upload_id¶ Gets the s3_multipart_upload_id of this UploadSignedUploadUrlOutput.
- Returns
The s3_multipart_upload_id of this UploadSignedUploadUrlOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
upload_headers¶ Gets the upload_headers of this UploadSignedUploadUrlOutput.
- Returns
The upload_headers of this UploadSignedUploadUrlOutput.
- Return type
dict(str, str)
-
property
upload_urls¶ Gets the upload_urls of this UploadSignedUploadUrlOutput.
- Returns
The upload_urls of this UploadSignedUploadUrlOutput.
- Return type
list[str]
-
property
uuid¶ Gets the uuid of this UploadSignedUploadUrlOutput.
- Returns
The uuid of this UploadSignedUploadUrlOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.upload_ticket_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.upload_ticket_output.UploadTicketOutput(ticket=None, urls=None, headers=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
headers¶ Gets the headers of this UploadTicketOutput.
- Returns
The headers of this UploadTicketOutput.
- Return type
dict(str, str)
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
ticket¶ Gets the ticket of this UploadTicketOutput.
- Returns
The ticket of this UploadTicketOutput.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
urls¶ Gets the urls of this UploadTicketOutput.
- Returns
The urls of this UploadTicketOutput.
- Return type
union[object,object]
-
values()¶ Returns the list of values in the object
-
flywheel.models.upload_token_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.upload_token_output.UploadTokenOutput(token=None)¶ Bases:
object-
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
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
token¶ Gets the token of this UploadTokenOutput.
- Returns
The token of this UploadTokenOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.user module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.user.User(id=None, firstname=None, lastname=None, email=None, avatar=None, avatars=None, roles=None, root=None, disabled=None, preferences=None, wechat=None, firstlogin=None, lastlogin=None, created=None, modified=None, deleted=None, api_key=None, api_keys=None)¶ Bases:
object-
property
api_key¶ Gets the api_key of this User.
- Returns
The api_key of this User.
- Return type
-
property
api_keys¶ Gets the api_keys of this User.
- Returns
The api_keys of this User.
- Return type
list[UserApiKey]
-
property
avatar¶ Gets the avatar of this User.
Avatar image URL
- Returns
The avatar of this User.
- Return type
str
-
property
avatars¶ Gets the avatars of this User.
- Returns
The avatars of this User.
- Return type
-
property
created¶ Gets the created of this User.
Creation time (automatically set)
- Returns
The created of this User.
- Return type
datetime
-
property
deleted¶ Gets the deleted of this User.
Deleted time (automatically set on delete)
- Returns
The deleted of this User.
- Return type
datetime
-
property
disabled¶ Gets the disabled of this User.
- Returns
The disabled of this User.
- Return type
bool
-
property
email¶ Gets the email of this User.
Email address
- Returns
The email of this User.
- Return type
str
-
property
firstlogin¶ Gets the firstlogin of this User.
- Returns
The firstlogin of this User.
- Return type
str
-
property
firstname¶ Gets the firstname of this User.
First name
- Returns
The firstname of this User.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this User.
Database ID of a user
- Returns
The id of this User.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
lastlogin¶ Gets the lastlogin of this User.
- Returns
The lastlogin of this User.
- Return type
str
-
property
lastname¶ Gets the lastname of this User.
Last name
- Returns
The lastname of this User.
- Return type
str
-
property
modified¶ Gets the modified of this User.
Last modification time (automatically updated)
- Returns
The modified of this User.
- Return type
datetime
-
property
preferences¶ Gets the preferences of this User.
- Returns
The preferences of this User.
- Return type
-
property
roles¶ Gets the roles of this User.
- Returns
The roles of this User.
- Return type
list[str]
-
property
root¶ Gets the root of this User.
Super admin flag
- Returns
The root of this User.
- Return type
bool
-
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
-
property
wechat¶ Gets the wechat of this User.
- Returns
The wechat of this User.
- Return type
-
property
flywheel.models.user_api_key module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.user_api_key.UserApiKey(key=None, created=None, last_used=None)¶ Bases:
object-
property
created¶ Gets the created of this UserApiKey.
Creation time (automatically set)
- Returns
The created of this UserApiKey.
- Return type
datetime
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
key¶ Gets the key of this UserApiKey.
- Returns
The key of this UserApiKey.
- Return type
str
-
keys()¶ Returns the list of json properties in the object
-
property
last_used¶ Gets the last_used of this UserApiKey.
- Returns
The last_used of this UserApiKey.
- Return type
datetime
-
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
-
property
flywheel.models.user_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.user_input.UserInput(id=None, firstname=None, lastname=None, email=None, password=None, roles=None, disabled=None, avatar=None, root=None)¶ Bases:
object-
property
avatar¶ Gets the avatar of this UserInput.
- Returns
The avatar of this UserInput.
- Return type
str
-
property
disabled¶ Gets the disabled of this UserInput.
- Returns
The disabled of this UserInput.
- Return type
bool
-
property
email¶ Gets the email of this UserInput.
- Returns
The email of this UserInput.
- Return type
str
-
property
firstname¶ Gets the firstname of this UserInput.
- Returns
The firstname of this UserInput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this UserInput.
- Returns
The id of this UserInput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
lastname¶ Gets the lastname of this UserInput.
- Returns
The lastname of this UserInput.
- Return type
str
-
property
password¶ Gets the password of this UserInput.
- Returns
The password of this UserInput.
- Return type
str
-
property
roles¶ Gets the roles of this UserInput.
- Returns
The roles of this UserInput.
- Return type
list[RoleType]
-
property
root¶ Gets the root of this UserInput.
- Returns
The root of this UserInput.
- Return type
bool
-
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
-
property
flywheel.models.user_jobs module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.user_jobs.UserJobs(total=None, jobs=None, stats=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
jobs¶ Gets the jobs of this UserJobs.
- Returns
The jobs of this UserJobs.
- Return type
list[Job]
-
keys()¶ Returns the list of json properties in the object
-
property
stats¶ Gets the stats of this UserJobs.
- Returns
The stats of this UserJobs.
- Return type
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
total¶ Gets the total of this UserJobs.
- Returns
The total of this UserJobs.
- Return type
int
-
values()¶ Returns the list of values in the object
-
flywheel.models.user_jobs_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.user_jobs_output.UserJobsOutput(stats=None, total=None, jobs=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
items()¶ Returns the list of json property to value mapping
-
property
jobs¶ Gets the jobs of this UserJobsOutput.
- Returns
The jobs of this UserJobsOutput.
- Return type
list[JobListEntry]
-
keys()¶ Returns the list of json properties in the object
-
property
stats¶ Gets the stats of this UserJobsOutput.
- Returns
The stats of this UserJobsOutput.
- Return type
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
total¶ Gets the total of this UserJobsOutput.
- Returns
The total of this UserJobsOutput.
- Return type
int
-
values()¶ Returns the list of values in the object
-
flywheel.models.user_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.user_output.UserOutput(id=None, firstname=None, lastname=None, email=None, roles=None, root=False, avatar=None, avatars=None, disabled=None, created=None, modified=None, deleted=None, firstlogin=None, lastlogin=None, wechat=None, preferences=None, api_key=None, api_keys=None)¶ Bases:
object-
property
api_key¶ Gets the api_key of this UserOutput.
- Returns
The api_key of this UserOutput.
- Return type
-
property
api_keys¶ Gets the api_keys of this UserOutput.
- Returns
The api_keys of this UserOutput.
- Return type
list[UserApiKey]
-
property
avatar¶ Gets the avatar of this UserOutput.
- Returns
The avatar of this UserOutput.
- Return type
str
-
property
avatars¶ Gets the avatars of this UserOutput.
- Returns
The avatars of this UserOutput.
- Return type
-
property
created¶ Gets the created of this UserOutput.
- Returns
The created of this UserOutput.
- Return type
datetime
-
property
deleted¶ Gets the deleted of this UserOutput.
- Returns
The deleted of this UserOutput.
- Return type
datetime
-
property
disabled¶ Gets the disabled of this UserOutput.
- Returns
The disabled of this UserOutput.
- Return type
bool
-
property
email¶ Gets the email of this UserOutput.
- Returns
The email of this UserOutput.
- Return type
str
-
property
firstlogin¶ Gets the firstlogin of this UserOutput.
- Returns
The firstlogin of this UserOutput.
- Return type
datetime
-
property
firstname¶ Gets the firstname of this UserOutput.
- Returns
The firstname of this UserOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this UserOutput.
- Returns
The id of this UserOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
lastlogin¶ Gets the lastlogin of this UserOutput.
- Returns
The lastlogin of this UserOutput.
- Return type
datetime
-
property
lastname¶ Gets the lastname of this UserOutput.
- Returns
The lastname of this UserOutput.
- Return type
str
-
property
modified¶ Gets the modified of this UserOutput.
- Returns
The modified of this UserOutput.
- Return type
datetime
-
property
preferences¶ Gets the preferences of this UserOutput.
- Returns
The preferences of this UserOutput.
- Return type
-
property
roles¶ Gets the roles of this UserOutput.
- Returns
The roles of this UserOutput.
- Return type
list[str]
-
property
root¶ Gets the root of this UserOutput.
- Returns
The root of this UserOutput.
- Return type
bool
-
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
-
property
wechat¶ Gets the wechat of this UserOutput.
- Returns
The wechat of this UserOutput.
- Return type
-
property
flywheel.models.user_output_id module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.user_output_id.UserOutputId(id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this UserOutputId.
- Returns
The id of this UserOutputId.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.user_preferences module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.user_preferences.UserPreferences¶ Bases:
object-
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
-
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
-
flywheel.models.user_wechat module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.user_wechat.UserWechat¶ Bases:
object-
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
-
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
-
flywheel.models.validation_error module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.validation_error.ValidationError(loc=None, msg=None, type=None)¶ Bases:
object-
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
-
property
loc¶ Gets the loc of this ValidationError.
- Returns
The loc of this ValidationError.
- Return type
list[str]
-
property
msg¶ Gets the msg of this ValidationError.
- Returns
The msg of this ValidationError.
- Return type
str
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this ValidationError.
- Returns
The type of this ValidationError.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.version_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.version_output.VersionOutput(id=None, applied_fixes=None, cli_version=None, database=None, flywheel_release=None, release=None)¶ Bases:
object-
property
applied_fixes¶ Gets the applied_fixes of this VersionOutput.
Collection of applied database fixes
- Returns
The applied_fixes of this VersionOutput.
- Return type
dict(str, str)
-
property
cli_version¶ Gets the cli_version of this VersionOutput.
Compatible CLI version for this server as informed by the installation recipe.env
- Returns
The cli_version of this VersionOutput.
- Return type
str
-
property
database¶ Gets the database of this VersionOutput.
Core database version
- Returns
The database of this VersionOutput.
- Return type
int
-
property
flywheel_release¶ Gets the flywheel_release of this VersionOutput.
Flywheel installer image tag as informed by the installation recipe.env
- Returns
The flywheel_release of this VersionOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this VersionOutput.
- Returns
The id of this VersionOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
release¶ Gets the release of this VersionOutput.
Core release version
- Returns
The release of this VersionOutput.
- Return type
str
-
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
-
property
flywheel.models.view_id_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.view_id_output.ViewIdOutput(id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ViewIdOutput.
- Returns
The id of this ViewIdOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
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
-
flywheel.models.viewer_app module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.viewer_app.ViewerApp(name=None, url=None, options=None, files=None, containers=None)¶ Bases:
object-
property
containers¶ Gets the containers of this ViewerApp.
Container types that are associated to this application
- Returns
The containers of this ViewerApp.
- Return type
dict(str, object)
-
property
files¶ Gets the files of this ViewerApp.
File types that are associated to this application
- Returns
The files of this ViewerApp.
- Return type
dict(str, object)
-
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
-
property
name¶ Gets the name of this ViewerApp.
Unique name of this application
- Returns
The name of this ViewerApp.
- Return type
str
-
property
options¶ Gets the options of this ViewerApp.
General properties passed to the application when it connects to Flywheel
- Returns
The options of this ViewerApp.
- Return type
object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
url¶ Gets the url of this ViewerApp.
URL that points to the location where the application is hosted
- Returns
The url of this ViewerApp.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.viewer_app_type module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.virus_scan module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.virus_scan.VirusScan(state=None)¶ Bases:
object-
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
-
property
state¶ Gets the state of this VirusScan.
- Returns
The state of this VirusScan.
- Return type
-
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
-
flywheel.models.virus_scan_state module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
flywheel.models.workspace module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.workspace.Workspace(id=None, project_id=None, label=None, created=None, modified=None, origin=None, last_modified_by=None, external_storage_id=None)¶ Bases:
object-
property
created¶ Gets the created of this Workspace.
Creation time (automatically set)
- Returns
The created of this Workspace.
- Return type
datetime
-
property
external_storage_id¶ Gets the external_storage_id of this Workspace.
- Returns
The external_storage_id of this Workspace.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this Workspace.
Unique database ID
- Returns
The id of this Workspace.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this Workspace.
- Returns
The label of this Workspace.
- Return type
str
-
property
last_modified_by¶ Gets the last_modified_by of this Workspace.
- Returns
The last_modified_by of this Workspace.
- Return type
-
property
modified¶ Gets the modified of this Workspace.
Last modification time (automatically updated)
- Returns
The modified of this Workspace.
- Return type
datetime
-
property
origin¶ Gets the origin of this Workspace.
- Returns
The origin of this Workspace.
- Return type
-
property
project_id¶ Gets the project_id of this Workspace.
Unique database ID
- Returns
The project_id of this Workspace.
- Return type
str
-
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
-
property
flywheel.models.workspace_origin module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.workspace_origin.WorkspaceOrigin(type=None, id=None)¶ Bases:
object-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this WorkspaceOrigin.
- Returns
The id of this WorkspaceOrigin.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
to_dict()¶ Returns the model properties as a dict
-
to_str()¶ Returns the string representation of the model
-
property
type¶ Gets the type of this WorkspaceOrigin.
- Returns
The type of this WorkspaceOrigin.
- Return type
str
-
values()¶ Returns the list of values in the object
-
flywheel.models.workspace_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.workspace_output.WorkspaceOutput(id=None, project_id=None, label=None, created=None, modified=None, origin=None, last_modified_by=None, external_storage_id=None)¶ Bases:
object-
property
created¶ Gets the created of this WorkspaceOutput.
Creation time (automatically set)
- Returns
The created of this WorkspaceOutput.
- Return type
datetime
-
property
external_storage_id¶ Gets the external_storage_id of this WorkspaceOutput.
- Returns
The external_storage_id of this WorkspaceOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this WorkspaceOutput.
Unique database ID
- Returns
The id of this WorkspaceOutput.
- Return type
str
-
items()¶ Returns the list of json property to value mapping
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this WorkspaceOutput.
- Returns
The label of this WorkspaceOutput.
- Return type
str
-
property
last_modified_by¶ Gets the last_modified_by of this WorkspaceOutput.
- Returns
The last_modified_by of this WorkspaceOutput.
- Return type
-
property
modified¶ Gets the modified of this WorkspaceOutput.
Last modification time (automatically updated)
- Returns
The modified of this WorkspaceOutput.
- Return type
datetime
-
property
origin¶ Gets the origin of this WorkspaceOutput.
- Returns
The origin of this WorkspaceOutput.
- Return type
-
property
project_id¶ Gets the project_id of this WorkspaceOutput.
Unique database ID
- Returns
The project_id of this WorkspaceOutput.
- Return type
str
-
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
-
property
flywheel.models.workspace_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.workspace_update.WorkspaceUpdate¶ Bases:
object-
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
-
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
-
flywheel.models.zipfile_info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.zipfile_info.ZipfileInfo(comment=None, members=None)¶ Bases:
object-
property
comment¶ Gets the comment of this ZipfileInfo.
- Returns
The comment of this ZipfileInfo.
- Return type
str
-
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
-
property
members¶ Gets the members of this ZipfileInfo.
- Returns
The members of this ZipfileInfo.
- Return type
list[ZipfileMemberInfo]
-
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
-
property
flywheel.models.zipfile_member_info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 0.0.1
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.zipfile_member_info.ZipfileMemberInfo(path=None, size=None, timestamp=None, comment=None)¶ Bases:
object-
property
comment¶ Gets the comment of this ZipfileMemberInfo.
- Returns
The comment of this ZipfileMemberInfo.
- Return type
str
-
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
-
property
path¶ Gets the path of this ZipfileMemberInfo.
- Returns
The path of this ZipfileMemberInfo.
- Return type
str
-
property
size¶ Gets the size of this ZipfileMemberInfo.
- Returns
The size of this ZipfileMemberInfo.
- Return type
int
-
property
timestamp¶ Gets the timestamp of this ZipfileMemberInfo.
- Returns
The timestamp of this ZipfileMemberInfo.
- Return type
datetime
-
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
-
property
Module contents¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 17.2.0
Generated by: https://github.com/swagger-api/swagger-codegen.git