flywheel.models package¶
Submodules¶
flywheel.models.acquisition module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.acquisition.Acquisition(label=None, info=None, session=None, uid=None, timestamp=None, timezone=None, id=None, parents=None, collections=None, files=None, created=None, modified=None, revision=None, info_exists=None, permissions=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.AcquisitionMixin-
property
analyses¶ Gets the analyses of this Acquisition.
- Returns
The analyses of this Acquisition.
- Return type
list[AnalysisOutput]
-
property
collections¶ Gets the collections of this Acquisition.
- Returns
The collections of this Acquisition.
- Return type
list[str]
-
property
created¶ Gets the created of this Acquisition.
Creation time (automatically set)
- Returns
The created of this Acquisition.
- Return type
datetime
-
property
files¶ Gets the files of this Acquisition.
- Returns
The files of this Acquisition.
- 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 Acquisition.
Unique database ID
- Returns
The id of this Acquisition.
- Return type
str
-
property
info¶ Gets the info of this Acquisition.
- Returns
The info of this Acquisition.
- Return type
-
property
info_exists¶ Gets the info_exists of this Acquisition.
- Returns
The info_exists of this Acquisition.
- 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 Acquisition.
Application-specific label
- Returns
The label of this Acquisition.
- Return type
str
-
property
modified¶ Gets the modified of this Acquisition.
Last modification time (automatically updated)
- Returns
The modified of this Acquisition.
- Return type
datetime
-
property
notes¶ Gets the notes of this Acquisition.
- Returns
The notes of this Acquisition.
- Return type
list[Note]
-
property
parents¶ Gets the parents of this Acquisition.
- Returns
The parents of this Acquisition.
- Return type
-
property
permissions¶ Gets the permissions of this Acquisition.
- Returns
The permissions of this Acquisition.
- Return type
-
property
revision¶ Gets the revision of this Acquisition.
An incremental document revision number
- Returns
The revision of this Acquisition.
- Return type
int
-
property
session¶ Gets the session of this Acquisition.
Unique database ID
- Returns
The session of this Acquisition.
- Return type
str
Gets the tags of this Acquisition.
Array of application-specific tags
- Returns
The tags of this Acquisition.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this Acquisition.
- Returns
The timestamp of this Acquisition.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this Acquisition.
- Returns
The timezone of this Acquisition.
- 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 Acquisition.
A user database ID
- Returns
The uid of this Acquisition.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.acquisition_metadata_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.acquisition_metadata_input.AcquisitionMetadataInput(label=None, info=None, metadata=None, measurement=None, instrument=None, uid=None, tags=None, timestamp=None, timezone=None, files=None)¶ Bases:
object-
property
files¶ Gets the files of this AcquisitionMetadataInput.
- Returns
The files of this AcquisitionMetadataInput.
- 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 AcquisitionMetadataInput.
- Returns
The info of this AcquisitionMetadataInput.
- Return type
object
-
property
instrument¶ Gets the instrument of this AcquisitionMetadataInput.
- Returns
The instrument of this AcquisitionMetadataInput.
- 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 AcquisitionMetadataInput.
- Returns
The label of this AcquisitionMetadataInput.
- Return type
str
-
property
measurement¶ Gets the measurement of this AcquisitionMetadataInput.
- Returns
The measurement of this AcquisitionMetadataInput.
- Return type
str
-
property
metadata¶ Gets the metadata of this AcquisitionMetadataInput.
- Returns
The metadata of this AcquisitionMetadataInput.
- Return type
object
Gets the tags of this AcquisitionMetadataInput.
Array of application-specific tags
- Returns
The tags of this AcquisitionMetadataInput.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this AcquisitionMetadataInput.
- Returns
The timestamp of this AcquisitionMetadataInput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this AcquisitionMetadataInput.
- Returns
The timezone of this AcquisitionMetadataInput.
- 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 AcquisitionMetadataInput.
- Returns
The uid of this AcquisitionMetadataInput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
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: 15.8.0
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: 15.8.0
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: 15.8.0
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_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_list_entry.AnalysisListEntry(id=None, inputs=None, files=None, job=None, gear_info=None, notes=None, description=None, label=None, parent=None, parents=None, created=None, modified=None, revision=None)¶ Bases:
flywheel.models.mixins.AnalysisMixin-
property
created¶ Gets the created of this AnalysisListEntry.
Creation time (automatically set)
- Returns
The created of this AnalysisListEntry.
- Return type
datetime
-
property
description¶ Gets the description of this AnalysisListEntry.
- Returns
The description of this AnalysisListEntry.
- Return type
str
-
property
files¶ Gets the files of this AnalysisListEntry.
- Returns
The files of this AnalysisListEntry.
- Return type
list[FileEntry]
-
property
gear_info¶ Gets the gear_info of this AnalysisListEntry.
- Returns
The gear_info of this AnalysisListEntry.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this AnalysisListEntry.
Unique database ID
- Returns
The id of this AnalysisListEntry.
- Return type
str
-
property
inputs¶ Gets the inputs of this AnalysisListEntry.
- Returns
The inputs of this AnalysisListEntry.
- Return type
list[FileEntry]
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this AnalysisListEntry.
Unique database ID
- Returns
The job of this AnalysisListEntry.
- Return type
str
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AnalysisListEntry.
Application-specific label
- Returns
The label of this AnalysisListEntry.
- Return type
str
-
property
modified¶ Gets the modified of this AnalysisListEntry.
Last modification time (automatically updated)
- Returns
The modified of this AnalysisListEntry.
- Return type
datetime
-
property
notes¶ Gets the notes of this AnalysisListEntry.
- Returns
The notes of this AnalysisListEntry.
- Return type
list[Note]
-
property
parent¶ Gets the parent of this AnalysisListEntry.
- Returns
The parent of this AnalysisListEntry.
- Return type
-
property
parents¶ Gets the parents of this AnalysisListEntry.
- Returns
The parents of this AnalysisListEntry.
- Return type
-
property
revision¶ Gets the revision of this AnalysisListEntry.
An incremental document revision number
- Returns
The revision of this AnalysisListEntry.
- 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.analysis_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.analysis_output.AnalysisOutput(id=None, inputs=None, files=None, job=None, gear_info=None, notes=None, tags=None, info=None, description=None, label=None, parent=None, parents=None, created=None, modified=None, revision=None)¶ Bases:
flywheel.models.mixins.AnalysisMixin-
property
created¶ Gets the created of this AnalysisOutput.
Creation time (automatically set)
- 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[FileEntry]
-
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.
Unique database ID
- 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
-
property
inputs¶ Gets the inputs of this AnalysisOutput.
- Returns
The inputs of this AnalysisOutput.
- Return type
list[FileEntry]
-
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
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this AnalysisOutput.
Application-specific label
- Returns
The label of this AnalysisOutput.
- Return type
str
-
property
modified¶ Gets the modified of this AnalysisOutput.
Last modification time (automatically updated)
- 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
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.
An incremental document revision number
- Returns
The revision of this AnalysisOutput.
- Return type
int
Gets the tags of this AnalysisOutput.
Array of application-specific tags
- Returns
The tags of this AnalysisOutput.
- 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_update module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.auth_login_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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.avatars module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.batch module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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, 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
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: 15.8.0
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_jobs_proposal_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.batch_jobs_proposal_input.BatchJobsProposalInput(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 BatchJobsProposalInput.
- Returns
The jobs of this BatchJobsProposalInput.
- Return type
list[Job]
-
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.batch_proposal module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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, 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
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: 15.8.0
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: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.batch_proposal_input.BatchProposalInput(gear_id=None, config=None, tags=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
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: 15.8.0
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.bulk_move_sessions module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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.classification_add_delete module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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.collection module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.collection.Collection(label=None, info=None, description=None, contents=None, id=None, info_exists=None, curator=None, created=None, modified=None, revision=None, permissions=None, files=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.CollectionMixin-
property
analyses¶ Gets the analyses of this Collection.
- Returns
The analyses of this Collection.
- Return type
list[AnalysisOutput]
-
property
contents¶ Gets the contents of this Collection.
- Returns
The contents of this Collection.
- Return type
-
property
created¶ Gets the created of this Collection.
Creation time (automatically set)
- Returns
The created of this Collection.
- Return type
datetime
-
property
curator¶ Gets the curator of this Collection.
Database ID of a user
- Returns
The curator of this Collection.
- Return type
str
-
property
description¶ Gets the description of this Collection.
- Returns
The description of this Collection.
- Return type
str
-
property
files¶ Gets the files of this Collection.
- Returns
The files of this Collection.
- 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 Collection.
Unique database ID
- Returns
The id of this Collection.
- Return type
str
-
property
info¶ Gets the info of this Collection.
- Returns
The info of this Collection.
- Return type
-
property
info_exists¶ Gets the info_exists of this Collection.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this Collection.
- 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 Collection.
Application-specific label
- Returns
The label of this Collection.
- Return type
str
-
property
modified¶ Gets the modified of this Collection.
Last modification time (automatically updated)
- Returns
The modified of this Collection.
- Return type
datetime
-
property
notes¶ Gets the notes of this Collection.
- Returns
The notes of this Collection.
- Return type
list[Note]
-
property
permissions¶ Gets the permissions of this Collection.
- Returns
The permissions of this Collection.
- Return type
list[RolesRoleAssignment]
-
property
revision¶ Gets the revision of this Collection.
An incremental document revision number
- Returns
The revision of this Collection.
- Return type
int
Gets the tags of this Collection.
Array of application-specific tags
- Returns
The tags of this Collection.
- 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_new_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.collection_new_output.CollectionNewOutput(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 CollectionNewOutput.
Unique database ID
- Returns
The id of this CollectionNewOutput.
- 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.collection_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.
Unique database ID
- 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
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.collection_operation module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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
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.common_classification module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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_key module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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.config_auth_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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)¶ 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
-
to_dict()¶ Returns 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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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_acquisition_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_acquisition_output.ContainerAcquisitionOutput(label=None, info=None, session=None, uid=None, timestamp=None, timezone=None, id=None, parents=None, collections=None, files=None, created=None, modified=None, revision=None, info_exists=None, permissions=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.AcquisitionMixin-
property
analyses¶ Gets the analyses of this ContainerAcquisitionOutput.
- Returns
The analyses of this ContainerAcquisitionOutput.
- Return type
list[AnalysisOutput]
-
property
collections¶ Gets the collections of this ContainerAcquisitionOutput.
- Returns
The collections of this ContainerAcquisitionOutput.
- Return type
list[str]
-
property
created¶ Gets the created of this ContainerAcquisitionOutput.
Creation time (automatically set)
- Returns
The created of this ContainerAcquisitionOutput.
- Return type
datetime
-
property
files¶ Gets the files of this ContainerAcquisitionOutput.
- Returns
The files of this ContainerAcquisitionOutput.
- 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 ContainerAcquisitionOutput.
Unique database ID
- Returns
The id of this ContainerAcquisitionOutput.
- Return type
str
-
property
info¶ Gets the info of this ContainerAcquisitionOutput.
- Returns
The info of this ContainerAcquisitionOutput.
- Return type
-
property
info_exists¶ Gets the info_exists of this ContainerAcquisitionOutput.
- Returns
The info_exists of this ContainerAcquisitionOutput.
- 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 ContainerAcquisitionOutput.
Application-specific label
- Returns
The label of this ContainerAcquisitionOutput.
- Return type
str
-
property
modified¶ Gets the modified of this ContainerAcquisitionOutput.
Last modification time (automatically updated)
- Returns
The modified of this ContainerAcquisitionOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this ContainerAcquisitionOutput.
- Returns
The notes of this ContainerAcquisitionOutput.
- Return type
list[Note]
-
property
parents¶ Gets the parents of this ContainerAcquisitionOutput.
- Returns
The parents of this ContainerAcquisitionOutput.
- Return type
-
property
permissions¶ Gets the permissions of this ContainerAcquisitionOutput.
- Returns
The permissions of this ContainerAcquisitionOutput.
- Return type
-
property
revision¶ Gets the revision of this ContainerAcquisitionOutput.
An incremental document revision number
- Returns
The revision of this ContainerAcquisitionOutput.
- Return type
int
-
property
session¶ Gets the session of this ContainerAcquisitionOutput.
Unique database ID
- Returns
The session of this ContainerAcquisitionOutput.
- Return type
str
Gets the tags of this ContainerAcquisitionOutput.
Array of application-specific tags
- Returns
The tags of this ContainerAcquisitionOutput.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this ContainerAcquisitionOutput.
- Returns
The timestamp of this ContainerAcquisitionOutput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this ContainerAcquisitionOutput.
- Returns
The timezone of this ContainerAcquisitionOutput.
- 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 ContainerAcquisitionOutput.
A user database ID
- Returns
The uid of this ContainerAcquisitionOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.container_analysis_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_analysis_output.ContainerAnalysisOutput(id=None, inputs=None, files=None, job=None, gear_info=None, notes=None, tags=None, info=None, description=None, label=None, parent=None, parents=None, created=None, modified=None, revision=None)¶ Bases:
flywheel.models.mixins.AnalysisMixin-
property
created¶ Gets the created of this ContainerAnalysisOutput.
Creation time (automatically set)
- Returns
The created of this ContainerAnalysisOutput.
- Return type
datetime
-
property
description¶ Gets the description of this ContainerAnalysisOutput.
- Returns
The description of this ContainerAnalysisOutput.
- Return type
str
-
property
files¶ Gets the files of this ContainerAnalysisOutput.
- Returns
The files of this ContainerAnalysisOutput.
- Return type
list[FileEntry]
-
property
gear_info¶ Gets the gear_info of this ContainerAnalysisOutput.
- Returns
The gear_info of this ContainerAnalysisOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ContainerAnalysisOutput.
Unique database ID
- Returns
The id of this ContainerAnalysisOutput.
- Return type
str
-
property
info¶ Gets the info of this ContainerAnalysisOutput.
- Returns
The info of this ContainerAnalysisOutput.
- Return type
-
property
inputs¶ Gets the inputs of this ContainerAnalysisOutput.
- Returns
The inputs of this ContainerAnalysisOutput.
- Return type
list[FileEntry]
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this ContainerAnalysisOutput.
- Returns
The job of this ContainerAnalysisOutput.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ContainerAnalysisOutput.
Application-specific label
- Returns
The label of this ContainerAnalysisOutput.
- Return type
str
-
property
modified¶ Gets the modified of this ContainerAnalysisOutput.
Last modification time (automatically updated)
- Returns
The modified of this ContainerAnalysisOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this ContainerAnalysisOutput.
- Returns
The notes of this ContainerAnalysisOutput.
- Return type
list[Note]
-
property
parent¶ Gets the parent of this ContainerAnalysisOutput.
- Returns
The parent of this ContainerAnalysisOutput.
- Return type
-
property
parents¶ Gets the parents of this ContainerAnalysisOutput.
- Returns
The parents of this ContainerAnalysisOutput.
- Return type
-
property
revision¶ Gets the revision of this ContainerAnalysisOutput.
An incremental document revision number
- Returns
The revision of this ContainerAnalysisOutput.
- Return type
int
Gets the tags of this ContainerAnalysisOutput.
Array of application-specific tags
- Returns
The tags of this ContainerAnalysisOutput.
- 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_collection_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_collection_output.ContainerCollectionOutput(label=None, info=None, description=None, contents=None, id=None, info_exists=None, curator=None, created=None, modified=None, revision=None, permissions=None, files=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.CollectionMixin-
property
analyses¶ Gets the analyses of this ContainerCollectionOutput.
- Returns
The analyses of this ContainerCollectionOutput.
- Return type
list[AnalysisOutput]
-
property
contents¶ Gets the contents of this ContainerCollectionOutput.
- Returns
The contents of this ContainerCollectionOutput.
- Return type
-
property
created¶ Gets the created of this ContainerCollectionOutput.
Creation time (automatically set)
- Returns
The created of this ContainerCollectionOutput.
- Return type
datetime
-
property
curator¶ Gets the curator of this ContainerCollectionOutput.
Database ID of a user
- Returns
The curator of this ContainerCollectionOutput.
- Return type
str
-
property
description¶ Gets the description of this ContainerCollectionOutput.
- Returns
The description of this ContainerCollectionOutput.
- Return type
str
-
property
files¶ Gets the files of this ContainerCollectionOutput.
- Returns
The files of this ContainerCollectionOutput.
- 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 ContainerCollectionOutput.
Unique database ID
- Returns
The id of this ContainerCollectionOutput.
- Return type
str
-
property
info¶ Gets the info of this ContainerCollectionOutput.
- Returns
The info of this ContainerCollectionOutput.
- Return type
-
property
info_exists¶ Gets the info_exists of this ContainerCollectionOutput.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this ContainerCollectionOutput.
- 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 ContainerCollectionOutput.
Application-specific label
- Returns
The label of this ContainerCollectionOutput.
- Return type
str
-
property
modified¶ Gets the modified of this ContainerCollectionOutput.
Last modification time (automatically updated)
- Returns
The modified of this ContainerCollectionOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this ContainerCollectionOutput.
- Returns
The notes of this ContainerCollectionOutput.
- Return type
list[Note]
-
property
permissions¶ Gets the permissions of this ContainerCollectionOutput.
- Returns
The permissions of this ContainerCollectionOutput.
- Return type
list[RolesRoleAssignment]
-
property
revision¶ Gets the revision of this ContainerCollectionOutput.
An incremental document revision number
- Returns
The revision of this ContainerCollectionOutput.
- Return type
int
Gets the tags of this ContainerCollectionOutput.
Array of application-specific tags
- Returns
The tags of this ContainerCollectionOutput.
- 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_file_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_file_output.ContainerFileOutput(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, provider_id=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 ContainerFileOutput.
- Returns
The classification of this ContainerFileOutput.
- Return type
-
property
created¶ Gets the created of this ContainerFileOutput.
Creation time (automatically set)
- Returns
The created of this ContainerFileOutput.
- Return type
datetime
-
property
deid_log_id¶ Gets the deid_log_id of this ContainerFileOutput.
The UUID of the de-id log
- Returns
The deid_log_id of this ContainerFileOutput.
- Return type
str
-
property
file_id¶ Gets the file_id of this ContainerFileOutput.
Unique database ID
- Returns
The file_id of this ContainerFileOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
hash¶ Gets the hash of this ContainerFileOutput.
Cryptographic hash of the file
- Returns
The hash of this ContainerFileOutput.
- Return type
str
-
property
id¶ Gets the id of this ContainerFileOutput.
- Returns
The id of this ContainerFileOutput.
- Return type
str
-
property
info¶ Gets the info of this ContainerFileOutput.
- Returns
The info of this ContainerFileOutput.
- Return type
-
property
info_exists¶ Gets the info_exists of this ContainerFileOutput.
- Returns
The info_exists of this ContainerFileOutput.
- 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 ContainerFileOutput.
A MIME Content-Type of the file
- Returns
The mimetype of this ContainerFileOutput.
- Return type
str
-
property
modality¶ Gets the modality of this ContainerFileOutput.
The type of instrument that originated the file (e.g. MR, CT, …)
- Returns
The modality of this ContainerFileOutput.
- Return type
str
-
property
modified¶ Gets the modified of this ContainerFileOutput.
Last modification time (automatically updated)
- Returns
The modified of this ContainerFileOutput.
- Return type
datetime
-
property
name¶ Gets the name of this ContainerFileOutput.
The name of the file on disk
- Returns
The name of this ContainerFileOutput.
- Return type
str
-
property
origin¶ Gets the origin of this ContainerFileOutput.
- Returns
The origin of this ContainerFileOutput.
- Return type
-
property
parent_ref¶ Gets the parent_ref of this ContainerFileOutput.
- Returns
The parent_ref of this ContainerFileOutput.
- Return type
-
property
parents¶ Gets the parents of this ContainerFileOutput.
- Returns
The parents of this ContainerFileOutput.
- Return type
-
property
provider_id¶ Gets the provider_id of this ContainerFileOutput.
Unique database ID
- Returns
The provider_id of this ContainerFileOutput.
- Return type
str
-
property
replaced¶ Gets the replaced of this ContainerFileOutput.
Last replaced time (automatically updated)
- Returns
The replaced of this ContainerFileOutput.
- Return type
datetime
-
property
size¶ Gets the size of this ContainerFileOutput.
Size of the file, in bytes
- Returns
The size of this ContainerFileOutput.
- Return type
int
Gets the tags of this ContainerFileOutput.
Array of application-specific tags
- Returns
The tags of this ContainerFileOutput.
- 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 ContainerFileOutput.
A descriptive file type (e.g. dicom, image, document, …)
- Returns
The type of this ContainerFileOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
version¶ Gets the version of this ContainerFileOutput.
Version of the file
- Returns
The version of this ContainerFileOutput.
- Return type
int
-
property
zip_member_count¶ Gets the zip_member_count of this ContainerFileOutput.
Number of entries in the zip archive
- Returns
The zip_member_count of this ContainerFileOutput.
- Return type
int
-
property
flywheel.models.container_group_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_group_output.ContainerGroupOutput(id=None, label=None, permissions_template=None, roles=None, permissions=None, created=None, modified=None, revision=None, tags=None, providers=None, editions=None)¶ Bases:
flywheel.models.mixins.GroupMixin-
property
created¶ Gets the created of this ContainerGroupOutput.
Creation time (automatically set)
- Returns
The created of this ContainerGroupOutput.
- Return type
datetime
-
property
editions¶ Gets the editions of this ContainerGroupOutput.
- Returns
The editions of this ContainerGroupOutput.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ContainerGroupOutput.
- Returns
The id of this ContainerGroupOutput.
- 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 ContainerGroupOutput.
The group label
- Returns
The label of this ContainerGroupOutput.
- Return type
str
-
property
modified¶ Gets the modified of this ContainerGroupOutput.
Last modification time (automatically updated)
- Returns
The modified of this ContainerGroupOutput.
- Return type
datetime
-
property
permissions¶ Gets the permissions of this ContainerGroupOutput.
- Returns
The permissions of this ContainerGroupOutput.
- Return type
-
property
permissions_template¶ Gets the permissions_template of this ContainerGroupOutput.
- Returns
The permissions_template of this ContainerGroupOutput.
- Return type
list[RolesRoleAssignment]
-
property
providers¶ Gets the providers of this ContainerGroupOutput.
- Returns
The providers of this ContainerGroupOutput.
- Return type
-
property
revision¶ Gets the revision of this ContainerGroupOutput.
An incremental document revision number
- Returns
The revision of this ContainerGroupOutput.
- Return type
int
-
property
roles¶ Gets the roles of this ContainerGroupOutput.
- Returns
The roles of this ContainerGroupOutput.
- Return type
list[str]
Gets the tags of this ContainerGroupOutput.
Array of application-specific tags
- Returns
The tags of this ContainerGroupOutput.
- 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_new_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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= {'acquisition': 'ContainerAcquisitionOutput', 'analysis': 'ContainerAnalysisOutput', 'collection': 'ContainerCollectionOutput', 'file': 'ContainerFileOutput', 'group': 'ContainerGroupOutput', 'project': 'ContainerProjectOutput', 'session': 'ContainerSessionOutput', 'subject': 'ContainerSubjectOutput'}¶
-
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: 15.8.0
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: 15.8.0
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_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_project_output.ContainerProjectOutput(label=None, info=None, description=None, group=None, providers=None, editions=None, ldap_sync=None, id=None, parents=None, info_exists=None, created=None, modified=None, revision=None, templates=None, permissions=None, files=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.ProjectMixin-
property
analyses¶ Gets the analyses of this ContainerProjectOutput.
- Returns
The analyses of this ContainerProjectOutput.
- Return type
list[AnalysisOutput]
-
property
created¶ Gets the created of this ContainerProjectOutput.
Creation time (automatically set)
- Returns
The created of this ContainerProjectOutput.
- Return type
datetime
-
property
description¶ Gets the description of this ContainerProjectOutput.
- Returns
The description of this ContainerProjectOutput.
- Return type
str
-
property
editions¶ Gets the editions of this ContainerProjectOutput.
- Returns
The editions of this ContainerProjectOutput.
- Return type
-
property
files¶ Gets the files of this ContainerProjectOutput.
- Returns
The files of this ContainerProjectOutput.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ContainerProjectOutput.
- Returns
The group of this ContainerProjectOutput.
- Return type
str
-
property
id¶ Gets the id of this ContainerProjectOutput.
Unique database ID
- Returns
The id of this ContainerProjectOutput.
- Return type
str
-
property
info¶ Gets the info of this ContainerProjectOutput.
- Returns
The info of this ContainerProjectOutput.
- Return type
-
property
info_exists¶ Gets the info_exists of this ContainerProjectOutput.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this ContainerProjectOutput.
- 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 ContainerProjectOutput.
Application-specific label
- Returns
The label of this ContainerProjectOutput.
- Return type
str
-
property
ldap_sync¶ Gets the ldap_sync of this ContainerProjectOutput.
- Returns
The ldap_sync of this ContainerProjectOutput.
- Return type
-
property
modified¶ Gets the modified of this ContainerProjectOutput.
Last modification time (automatically updated)
- Returns
The modified of this ContainerProjectOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this ContainerProjectOutput.
- Returns
The notes of this ContainerProjectOutput.
- Return type
list[Note]
-
property
parents¶ Gets the parents of this ContainerProjectOutput.
- Returns
The parents of this ContainerProjectOutput.
- Return type
-
property
permissions¶ Gets the permissions of this ContainerProjectOutput.
- Returns
The permissions of this ContainerProjectOutput.
- Return type
-
property
providers¶ Gets the providers of this ContainerProjectOutput.
- Returns
The providers of this ContainerProjectOutput.
- Return type
-
property
revision¶ Gets the revision of this ContainerProjectOutput.
An incremental document revision number
- Returns
The revision of this ContainerProjectOutput.
- Return type
int
Gets the tags of this ContainerProjectOutput.
Array of application-specific tags
- Returns
The tags of this ContainerProjectOutput.
- Return type
list[str]
-
property
templates¶ Gets the templates of this ContainerProjectOutput.
- Returns
The templates of this ContainerProjectOutput.
- 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.container_reference module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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_session_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_session_output.ContainerSessionOutput(operator=None, label=None, info=None, project=None, uid=None, timestamp=None, timezone=None, subject=None, age=None, weight=None, id=None, info_exists=None, parents=None, created=None, modified=None, revision=None, permissions=None, group=None, project_has_template=None, satisfies_template=None, files=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.SessionMixin-
property
age¶ Gets the age of this ContainerSessionOutput.
Subject age at time of session, in seconds
- Returns
The age of this ContainerSessionOutput.
- Return type
int
-
property
analyses¶ Gets the analyses of this ContainerSessionOutput.
- Returns
The analyses of this ContainerSessionOutput.
- Return type
list[AnalysisOutput]
-
property
created¶ Gets the created of this ContainerSessionOutput.
Creation time (automatically set)
- Returns
The created of this ContainerSessionOutput.
- Return type
datetime
-
property
files¶ Gets the files of this ContainerSessionOutput.
- Returns
The files of this ContainerSessionOutput.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ContainerSessionOutput.
- Returns
The group of this ContainerSessionOutput.
- Return type
str
-
property
id¶ Gets the id of this ContainerSessionOutput.
Unique database ID
- Returns
The id of this ContainerSessionOutput.
- Return type
str
-
property
info¶ Gets the info of this ContainerSessionOutput.
- Returns
The info of this ContainerSessionOutput.
- Return type
-
property
info_exists¶ Gets the info_exists of this ContainerSessionOutput.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this ContainerSessionOutput.
- 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 ContainerSessionOutput.
Application-specific label
- Returns
The label of this ContainerSessionOutput.
- Return type
str
-
property
modified¶ Gets the modified of this ContainerSessionOutput.
Last modification time (automatically updated)
- Returns
The modified of this ContainerSessionOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this ContainerSessionOutput.
- Returns
The notes of this ContainerSessionOutput.
- Return type
list[Note]
-
property
operator¶ Gets the operator of this ContainerSessionOutput.
The name of the operator
- Returns
The operator of this ContainerSessionOutput.
- Return type
str
-
property
parents¶ Gets the parents of this ContainerSessionOutput.
- Returns
The parents of this ContainerSessionOutput.
- Return type
-
property
permissions¶ Gets the permissions of this ContainerSessionOutput.
- Returns
The permissions of this ContainerSessionOutput.
- Return type
-
property
project¶ Gets the project of this ContainerSessionOutput.
Unique database ID
- Returns
The project of this ContainerSessionOutput.
- Return type
str
-
property
project_has_template¶ Gets the project_has_template of this ContainerSessionOutput.
- Returns
The project_has_template of this ContainerSessionOutput.
- Return type
bool
-
property
revision¶ Gets the revision of this ContainerSessionOutput.
An incremental document revision number
- Returns
The revision of this ContainerSessionOutput.
- Return type
int
-
property
satisfies_template¶ Gets the satisfies_template of this ContainerSessionOutput.
- Returns
The satisfies_template of this ContainerSessionOutput.
- Return type
bool
-
property
subject¶ Gets the subject of this ContainerSessionOutput.
- Returns
The subject of this ContainerSessionOutput.
- Return type
Gets the tags of this ContainerSessionOutput.
Array of application-specific tags
- Returns
The tags of this ContainerSessionOutput.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this ContainerSessionOutput.
- Returns
The timestamp of this ContainerSessionOutput.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this ContainerSessionOutput.
- Returns
The timezone of this ContainerSessionOutput.
- 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 ContainerSessionOutput.
A user database ID
- Returns
The uid of this ContainerSessionOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
weight¶ Gets the weight of this ContainerSessionOutput.
Subject weight at time of session, in kilograms
- Returns
The weight of this ContainerSessionOutput.
- Return type
float
-
property
flywheel.models.container_subject_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.container_subject_output.ContainerSubjectOutput(id=None, project=None, firstname=None, lastname=None, age=None, sex=None, cohort=None, mlset=None, type=None, race=None, ethnicity=None, species=None, strain=None, label=None, code=None, master_code=None, tags=None, info=None, files=None, parents=None, created=None, modified=None, revision=None, permissions=None, notes=None, info_exists=None, analyses=None)¶ Bases:
flywheel.models.mixins.SubjectMixin-
property
age¶ Gets the age of this ContainerSubjectOutput.
Age at time of session, in seconds
- Returns
The age of this ContainerSubjectOutput.
- Return type
int
-
property
analyses¶ Gets the analyses of this ContainerSubjectOutput.
- Returns
The analyses of this ContainerSubjectOutput.
- Return type
list[AnalysisOutput]
-
property
code¶ Gets the code of this ContainerSubjectOutput.
A unique identifier for the subject
- Returns
The code of this ContainerSubjectOutput.
- Return type
str
-
property
cohort¶ Gets the cohort of this ContainerSubjectOutput.
- Returns
The cohort of this ContainerSubjectOutput.
- Return type
str
-
property
created¶ Gets the created of this ContainerSubjectOutput.
Creation time (automatically set)
- Returns
The created of this ContainerSubjectOutput.
- Return type
datetime
-
property
ethnicity¶ Gets the ethnicity of this ContainerSubjectOutput.
- Returns
The ethnicity of this ContainerSubjectOutput.
- Return type
str
-
property
files¶ Gets the files of this ContainerSubjectOutput.
- Returns
The files of this ContainerSubjectOutput.
- Return type
list[FileEntry]
-
property
firstname¶ Gets the firstname of this ContainerSubjectOutput.
First name
- Returns
The firstname of this ContainerSubjectOutput.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ContainerSubjectOutput.
Unique database ID
- Returns
The id of this ContainerSubjectOutput.
- Return type
str
-
property
info¶ Gets the info of this ContainerSubjectOutput.
- Returns
The info of this ContainerSubjectOutput.
- Return type
-
property
info_exists¶ Gets the info_exists of this ContainerSubjectOutput.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this ContainerSubjectOutput.
- 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 ContainerSubjectOutput.
A unique identifier for the subject
- Returns
The label of this ContainerSubjectOutput.
- Return type
str
-
property
lastname¶ Gets the lastname of this ContainerSubjectOutput.
Last name
- Returns
The lastname of this ContainerSubjectOutput.
- Return type
str
-
property
master_code¶ Gets the master_code of this ContainerSubjectOutput.
A unique identifier for the subject
- Returns
The master_code of this ContainerSubjectOutput.
- Return type
str
-
property
mlset¶ Gets the mlset of this ContainerSubjectOutput.
- Returns
The mlset of this ContainerSubjectOutput.
- Return type
str
-
property
modified¶ Gets the modified of this ContainerSubjectOutput.
Last modification time (automatically updated)
- Returns
The modified of this ContainerSubjectOutput.
- Return type
datetime
-
property
notes¶ Gets the notes of this ContainerSubjectOutput.
- Returns
The notes of this ContainerSubjectOutput.
- Return type
list[Note]
-
property
parents¶ Gets the parents of this ContainerSubjectOutput.
- Returns
The parents of this ContainerSubjectOutput.
- Return type
-
property
permissions¶ Gets the permissions of this ContainerSubjectOutput.
- Returns
The permissions of this ContainerSubjectOutput.
- Return type
-
property
project¶ Gets the project of this ContainerSubjectOutput.
Unique database ID
- Returns
The project of this ContainerSubjectOutput.
- Return type
str
-
property
race¶ Gets the race of this ContainerSubjectOutput.
- Returns
The race of this ContainerSubjectOutput.
- Return type
str
-
property
revision¶ Gets the revision of this ContainerSubjectOutput.
An incremental document revision number
- Returns
The revision of this ContainerSubjectOutput.
- Return type
int
-
property
sex¶ Gets the sex of this ContainerSubjectOutput.
- Returns
The sex of this ContainerSubjectOutput.
- Return type
str
-
property
species¶ Gets the species of this ContainerSubjectOutput.
- Returns
The species of this ContainerSubjectOutput.
- Return type
str
-
property
strain¶ Gets the strain of this ContainerSubjectOutput.
- Returns
The strain of this ContainerSubjectOutput.
- Return type
str
Gets the tags of this ContainerSubjectOutput.
Array of application-specific tags
- Returns
The tags of this ContainerSubjectOutput.
- 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 ContainerSubjectOutput.
- Returns
The type of this ContainerSubjectOutput.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
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: 15.8.0
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: 15.8.0
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.data_view module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.data_view.DataView(parent=None, label=None, description=None, columns=None, file_spec=None, include_ids=None, include_labels=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
file_spec¶ Gets the file_spec of this DataView.
- Returns
The file_spec of this DataView.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
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.
What to do if missing data are encountered. Default is none, which is to say replace with an empty or null value.
- 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: 15.8.0
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: 15.8.0
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: 15.8.0
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)¶ Bases:
object-
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_file_spec module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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_name_filter_spec module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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.device module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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)¶ 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
-
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_status module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.device_status.DeviceStatus¶ 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.device_status_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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
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_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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_with_summary module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.enginemetadata_engine_upload_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.enginemetadata_engine_upload_input.EnginemetadataEngineUploadInput(project=None, subject=None, session=None, acquisition=None)¶ Bases:
object-
property
acquisition¶ Gets the acquisition of this EnginemetadataEngineUploadInput.
- Returns
The acquisition of this EnginemetadataEngineUploadInput.
- 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 EnginemetadataEngineUploadInput.
- Returns
The project of this EnginemetadataEngineUploadInput.
- Return type
-
property
session¶ Gets the session of this EnginemetadataEngineUploadInput.
- Returns
The session of this EnginemetadataEngineUploadInput.
- Return type
-
property
subject¶ Gets the subject of this EnginemetadataEngineUploadInput.
- Returns
The subject of this EnginemetadataEngineUploadInput.
- 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_label_upload_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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.file_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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, provider_id=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
provider_id¶ Gets the provider_id of this FileEntry.
Unique database ID
- Returns
The provider_id of this FileEntry.
- Return type
str
-
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_origin module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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_reference module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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_version_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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.gear module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.gear.Gear(author=None, maintainer=None, cite=None, config=None, custom=None, description=None, environment=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
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
-
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_config module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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_lookup module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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_custom module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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)¶ 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
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_environment module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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_info module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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
-
update_config(*args, **kwargs)¶ Update configuration values
-
flywheel.models.gear_mixin module¶
Provides gear mixin
-
class
flywheel.models.gear_mixin.GearMixin¶ Bases:
objectGear mixin that provides additional functionality
-
create_invocation()¶ Create a job invocation object
-
get_default_config()¶ Get the default configuration for gear
-
is_analysis_gear()¶ Check if this is an analysis gear
-
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, 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.
optional_input_policy (str) – The optional input policy, default is ‘ignored’
- Returns
The batch proposal, which can be started with proposal.run()
-
run(config=None, analysis_label=None, tags=None, destination=None, inputs=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
-
flywheel.models.group module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.group.Group(id=None, label=None, permissions_template=None, roles=None, permissions=None, created=None, modified=None, revision=None, tags=None, providers=None, editions=None)¶ Bases:
flywheel.models.mixins.GroupMixin-
property
created¶ Gets the created of this Group.
Creation time (automatically set)
- Returns
The created of this Group.
- Return type
datetime
-
property
editions¶ Gets the editions of this Group.
- Returns
The editions of this Group.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this Group.
- Returns
The id of this Group.
- 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 Group.
The group label
- Returns
The label of this Group.
- Return type
str
-
property
modified¶ Gets the modified of this Group.
Last modification time (automatically updated)
- Returns
The modified of this Group.
- Return type
datetime
-
property
permissions¶ Gets the permissions of this Group.
- Returns
The permissions of this Group.
- Return type
-
property
permissions_template¶ Gets the permissions_template of this Group.
- Returns
The permissions_template of this Group.
- Return type
list[RolesRoleAssignment]
-
property
providers¶ Gets the providers of this Group.
- Returns
The providers of this Group.
- Return type
-
property
revision¶ Gets the revision of this Group.
An incremental document revision number
- Returns
The revision of this Group.
- Return type
int
-
property
roles¶ Gets the roles of this Group.
- Returns
The roles of this Group.
- Return type
list[str]
Gets the tags of this Group.
Array of application-specific tags
- Returns
The tags of this Group.
- 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_metadata_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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_new_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.group_new_output.GroupNewOutput(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 GroupNewOutput.
- Returns
The id of this GroupNewOutput.
- 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.info_add_remove module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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.inline_response200 module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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_response2004 module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.inline_response2004.InlineResponse2004(firstname=None, lastname=None, id=None)¶ Bases:
object-
property
firstname¶ Gets the firstname of this InlineResponse2004.
First name
- Returns
The firstname of this InlineResponse2004.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this InlineResponse2004.
Database ID of a user
- Returns
The id of this InlineResponse2004.
- 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 InlineResponse2004.
Last name
- Returns
The lastname of this InlineResponse2004.
- 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_response2005 module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.job module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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, 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
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_ask module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_ask.JobAsk(whitelist=None, blacklist=None, capabilities=None, _return=None)¶ Bases:
object-
property
blacklist¶ Gets the blacklist of this JobAsk.
Properties that must NOT match against jobs
- 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
-
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.
Properties that must match against jobs
- 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: 15.8.0
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_return module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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_state module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.
Properties that must NOT match against jobs
- 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.
Properties that must match against jobs
- 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: 15.8.0
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_completion_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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_inputs module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_config_inputs.JobConfigInputs¶ 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_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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, 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
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_file_entry module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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_gear_match module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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_log module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_log.JobLog(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 JobLog.
Unique database ID
- Returns
The id of this JobLog.
- 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 JobLog.
- Returns
The logs of this JobLog.
- Return type
list[JobLogStatement]
-
to_dict()¶ Returns 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_log_statement module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.job_log_statement.JobLogStatement(fd=None, msg=None)¶ Bases:
object-
property
fd¶ Gets the fd of this JobLogStatement.
- Returns
The fd of this JobLogStatement.
- 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 JobLogStatement.
- Returns
The msg of this JobLogStatement.
- 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_origin module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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_profile module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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_state_counts module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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_transition_times module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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.ldap_sync module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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_data module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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.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: 15.8.0
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: 15.8.0
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: 15.8.0
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
-
-
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)
-
-
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.modality module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.note module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.note.Note(text=None, id=None, created=None, modified=None, user=None)¶ Bases:
object-
property
created¶ Gets the created of this Note.
Creation time (automatically set)
- Returns
The created of this Note.
- Return type
datetime
-
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
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
-
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.origin module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.packfile module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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
-
to_dict()¶ Returns 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: 15.8.0
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.permission_access_permission module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.project module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.project.Project(label=None, info=None, description=None, group=None, providers=None, editions=None, ldap_sync=None, id=None, parents=None, info_exists=None, created=None, modified=None, revision=None, templates=None, permissions=None, files=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.ProjectMixin-
property
analyses¶ Gets the analyses of this Project.
- Returns
The analyses of this Project.
- Return type
list[AnalysisOutput]
-
property
created¶ Gets the created of this Project.
Creation time (automatically set)
- Returns
The created of this Project.
- Return type
datetime
-
property
description¶ Gets the description of this Project.
- Returns
The description of this Project.
- Return type
str
-
property
editions¶ Gets the editions of this Project.
- Returns
The editions of this Project.
- Return type
-
property
files¶ Gets the files of this Project.
- Returns
The files of this Project.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this Project.
- Returns
The group of this Project.
- Return type
str
-
property
id¶ Gets the id of this Project.
Unique database ID
- Returns
The id of this Project.
- Return type
str
-
property
info¶ Gets the info of this Project.
- Returns
The info of this Project.
- Return type
-
property
info_exists¶ Gets the info_exists of this Project.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this Project.
- 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 Project.
Application-specific label
- Returns
The label of this Project.
- Return type
str
-
property
ldap_sync¶ Gets the ldap_sync of this Project.
- Returns
The ldap_sync of this Project.
- Return type
-
property
modified¶ Gets the modified of this Project.
Last modification time (automatically updated)
- Returns
The modified of this Project.
- Return type
datetime
-
property
notes¶ Gets the notes of this Project.
- Returns
The notes of this Project.
- Return type
list[Note]
-
property
parents¶ Gets the parents of this Project.
- Returns
The parents of this Project.
- Return type
-
property
permissions¶ Gets the permissions of this Project.
- Returns
The permissions of this Project.
- Return type
-
property
providers¶ Gets the providers of this Project.
- Returns
The providers of this Project.
- Return type
-
property
revision¶ Gets the revision of this Project.
An incremental document revision number
- Returns
The revision of this Project.
- Return type
int
Gets the tags of this Project.
Array of application-specific tags
- Returns
The tags of this Project.
- Return type
list[str]
-
property
templates¶ Gets the templates of this Project.
- Returns
The templates of this Project.
- 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_metadata_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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_template_requirement module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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.provider module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.provider.Provider(id=None, provider_class=None, provider_type=None, label=None, origin=None, created=None, modified=None, config=None, creds=None)¶ Bases:
object-
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_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.provider_input.ProviderInput(provider_class=None, provider_type=None, label=None, config=None, creds=None)¶ Bases:
object-
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: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.provider_links.ProviderLinks(compute=None, storage=None)¶ Bases:
object-
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
-
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.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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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 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 jobs that completed during the time frame that are 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 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 report row 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 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 jobs that completed during the time frame that are 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 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 report row 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 report row 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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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 of jobs completed during the time frame, 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 jobs that completed during the time frame that are 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 total storage used, in byte-days, billable to the center
- Returns
The center_storage_byte_day of this ReportUsageEntry.
- Return type
int
-
property
days¶ Gets the days of this ReportUsageEntry.
The number of days collected in this report
- 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 of jobs completed during the time frame, 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 jobs that completed during the time frame that are 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 total storage used, in byte-days, 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, or null if this is a group summary row
- Returns
The project of this ReportUsageEntry.
- Return type
str
-
property
project_label¶ Gets the project_label of this ReportUsageEntry.
The project label, or null if this is a group summary row
- Returns
The project_label of this ReportUsageEntry.
- Return type
str
-
property
session_count¶ Gets the session_count of this ReportUsageEntry.
The number of sessions that existed at the last collection time
- 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 of jobs completed during the time frame
- 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 jobs completed during the time frame
- 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 used, in byte-days
- 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: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.resolver_acquisition_node.ResolverAcquisitionNode(label=None, info=None, session=None, uid=None, timestamp=None, timezone=None, id=None, parents=None, collections=None, files=None, created=None, modified=None, revision=None, info_exists=None, permissions=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.AcquisitionMixin-
property
analyses¶ Gets the analyses of this ResolverAcquisitionNode.
- Returns
The analyses of this ResolverAcquisitionNode.
- Return type
list[AnalysisOutput]
-
property
collections¶ Gets the collections of this ResolverAcquisitionNode.
- Returns
The collections of this ResolverAcquisitionNode.
- Return type
list[str]
-
property
created¶ Gets the created of this ResolverAcquisitionNode.
Creation time (automatically set)
- Returns
The created of this ResolverAcquisitionNode.
- Return type
datetime
-
property
files¶ Gets the files of this ResolverAcquisitionNode.
- Returns
The files of this ResolverAcquisitionNode.
- 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 ResolverAcquisitionNode.
Unique database ID
- Returns
The id of this ResolverAcquisitionNode.
- Return type
str
-
property
info¶ Gets the info of this ResolverAcquisitionNode.
- Returns
The info of this ResolverAcquisitionNode.
- Return type
-
property
info_exists¶ Gets the info_exists of this ResolverAcquisitionNode.
- Returns
The info_exists of this ResolverAcquisitionNode.
- 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 ResolverAcquisitionNode.
Application-specific label
- Returns
The label of this ResolverAcquisitionNode.
- Return type
str
-
property
modified¶ Gets the modified of this ResolverAcquisitionNode.
Last modification time (automatically updated)
- Returns
The modified of this ResolverAcquisitionNode.
- Return type
datetime
-
property
notes¶ Gets the notes of this ResolverAcquisitionNode.
- Returns
The notes of this ResolverAcquisitionNode.
- Return type
list[Note]
-
property
parents¶ Gets the parents of this ResolverAcquisitionNode.
- Returns
The parents of this ResolverAcquisitionNode.
- Return type
-
property
permissions¶ Gets the permissions of this ResolverAcquisitionNode.
- Returns
The permissions of this ResolverAcquisitionNode.
- Return type
-
property
revision¶ Gets the revision of this ResolverAcquisitionNode.
An incremental document revision number
- Returns
The revision of this ResolverAcquisitionNode.
- Return type
int
-
property
session¶ Gets the session of this ResolverAcquisitionNode.
Unique database ID
- Returns
The session of this ResolverAcquisitionNode.
- Return type
str
Gets the tags of this ResolverAcquisitionNode.
Array of application-specific tags
- Returns
The tags of this ResolverAcquisitionNode.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this ResolverAcquisitionNode.
- Returns
The timestamp of this ResolverAcquisitionNode.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this ResolverAcquisitionNode.
- Returns
The timezone of this ResolverAcquisitionNode.
- 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 ResolverAcquisitionNode.
A user database ID
- Returns
The uid of this ResolverAcquisitionNode.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
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: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.resolver_analysis_node.ResolverAnalysisNode(id=None, inputs=None, files=None, job=None, gear_info=None, notes=None, tags=None, info=None, description=None, label=None, parent=None, parents=None, created=None, modified=None, revision=None)¶ Bases:
flywheel.models.mixins.AnalysisMixin-
property
created¶ Gets the created of this ResolverAnalysisNode.
Creation time (automatically set)
- Returns
The created of this ResolverAnalysisNode.
- Return type
datetime
-
property
description¶ Gets the description of this ResolverAnalysisNode.
- Returns
The description of this ResolverAnalysisNode.
- Return type
str
-
property
files¶ Gets the files of this ResolverAnalysisNode.
- Returns
The files of this ResolverAnalysisNode.
- Return type
list[FileEntry]
-
property
gear_info¶ Gets the gear_info of this ResolverAnalysisNode.
- Returns
The gear_info of this ResolverAnalysisNode.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ResolverAnalysisNode.
Unique database ID
- Returns
The id of this ResolverAnalysisNode.
- Return type
str
-
property
info¶ Gets the info of this ResolverAnalysisNode.
- Returns
The info of this ResolverAnalysisNode.
- Return type
-
property
inputs¶ Gets the inputs of this ResolverAnalysisNode.
- Returns
The inputs of this ResolverAnalysisNode.
- Return type
list[FileEntry]
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this ResolverAnalysisNode.
- Returns
The job of this ResolverAnalysisNode.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this ResolverAnalysisNode.
Application-specific label
- Returns
The label of this ResolverAnalysisNode.
- Return type
str
-
property
modified¶ Gets the modified of this ResolverAnalysisNode.
Last modification time (automatically updated)
- Returns
The modified of this ResolverAnalysisNode.
- Return type
datetime
-
property
notes¶ Gets the notes of this ResolverAnalysisNode.
- Returns
The notes of this ResolverAnalysisNode.
- Return type
list[Note]
-
property
parent¶ Gets the parent of this ResolverAnalysisNode.
- Returns
The parent of this ResolverAnalysisNode.
- Return type
-
property
parents¶ Gets the parents of this ResolverAnalysisNode.
- Returns
The parents of this ResolverAnalysisNode.
- Return type
-
property
revision¶ Gets the revision of this ResolverAnalysisNode.
An incremental document revision number
- Returns
The revision of this ResolverAnalysisNode.
- Return type
int
Gets the tags of this ResolverAnalysisNode.
Array of application-specific tags
- Returns
The tags of this ResolverAnalysisNode.
- 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.resolver_file_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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, provider_id=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
provider_id¶ Gets the provider_id of this ResolverFileNode.
Unique database ID
- Returns
The provider_id of this ResolverFileNode.
- Return type
str
-
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: 15.8.0
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)¶ 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
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: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.resolver_group_node.ResolverGroupNode(id=None, label=None, permissions_template=None, roles=None, permissions=None, created=None, modified=None, revision=None, tags=None, providers=None, editions=None)¶ Bases:
flywheel.models.mixins.GroupMixin-
property
created¶ Gets the created of this ResolverGroupNode.
Creation time (automatically set)
- Returns
The created of this ResolverGroupNode.
- Return type
datetime
-
property
editions¶ Gets the editions of this ResolverGroupNode.
- Returns
The editions of this ResolverGroupNode.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ResolverGroupNode.
- Returns
The id of this ResolverGroupNode.
- 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 ResolverGroupNode.
The group label
- Returns
The label of this ResolverGroupNode.
- Return type
str
-
property
modified¶ Gets the modified of this ResolverGroupNode.
Last modification time (automatically updated)
- Returns
The modified of this ResolverGroupNode.
- Return type
datetime
-
property
permissions¶ Gets the permissions of this ResolverGroupNode.
- Returns
The permissions of this ResolverGroupNode.
- Return type
-
property
permissions_template¶ Gets the permissions_template of this ResolverGroupNode.
- Returns
The permissions_template of this ResolverGroupNode.
- Return type
list[RolesRoleAssignment]
-
property
providers¶ Gets the providers of this ResolverGroupNode.
- Returns
The providers of this ResolverGroupNode.
- Return type
-
property
revision¶ Gets the revision of this ResolverGroupNode.
An incremental document revision number
- Returns
The revision of this ResolverGroupNode.
- Return type
int
-
property
roles¶ Gets the roles of this ResolverGroupNode.
- Returns
The roles of this ResolverGroupNode.
- Return type
list[str]
Gets the tags of this ResolverGroupNode.
Array of application-specific tags
- Returns
The tags of this ResolverGroupNode.
- 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.resolver_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.resolver_project_node.ResolverProjectNode(label=None, info=None, description=None, group=None, providers=None, editions=None, ldap_sync=None, id=None, parents=None, info_exists=None, created=None, modified=None, revision=None, templates=None, permissions=None, files=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.ProjectMixin-
property
analyses¶ Gets the analyses of this ResolverProjectNode.
- Returns
The analyses of this ResolverProjectNode.
- Return type
list[AnalysisOutput]
-
property
created¶ Gets the created of this ResolverProjectNode.
Creation time (automatically set)
- Returns
The created of this ResolverProjectNode.
- Return type
datetime
-
property
description¶ Gets the description of this ResolverProjectNode.
- Returns
The description of this ResolverProjectNode.
- Return type
str
-
property
editions¶ Gets the editions of this ResolverProjectNode.
- Returns
The editions of this ResolverProjectNode.
- Return type
-
property
files¶ Gets the files of this ResolverProjectNode.
- Returns
The files of this ResolverProjectNode.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ResolverProjectNode.
- Returns
The group of this ResolverProjectNode.
- Return type
str
-
property
id¶ Gets the id of this ResolverProjectNode.
Unique database ID
- Returns
The id of this ResolverProjectNode.
- Return type
str
-
property
info¶ Gets the info of this ResolverProjectNode.
- Returns
The info of this ResolverProjectNode.
- Return type
-
property
info_exists¶ Gets the info_exists of this ResolverProjectNode.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this ResolverProjectNode.
- 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 ResolverProjectNode.
Application-specific label
- Returns
The label of this ResolverProjectNode.
- Return type
str
-
property
ldap_sync¶ Gets the ldap_sync of this ResolverProjectNode.
- Returns
The ldap_sync of this ResolverProjectNode.
- Return type
-
property
modified¶ Gets the modified of this ResolverProjectNode.
Last modification time (automatically updated)
- Returns
The modified of this ResolverProjectNode.
- Return type
datetime
-
property
notes¶ Gets the notes of this ResolverProjectNode.
- Returns
The notes of this ResolverProjectNode.
- Return type
list[Note]
-
property
parents¶ Gets the parents of this ResolverProjectNode.
- Returns
The parents of this ResolverProjectNode.
- Return type
-
property
permissions¶ Gets the permissions of this ResolverProjectNode.
- Returns
The permissions of this ResolverProjectNode.
- Return type
-
property
providers¶ Gets the providers of this ResolverProjectNode.
- Returns
The providers of this ResolverProjectNode.
- Return type
-
property
revision¶ Gets the revision of this ResolverProjectNode.
An incremental document revision number
- Returns
The revision of this ResolverProjectNode.
- Return type
int
Gets the tags of this ResolverProjectNode.
Array of application-specific tags
- Returns
The tags of this ResolverProjectNode.
- Return type
list[str]
-
property
templates¶ Gets the templates of this ResolverProjectNode.
- Returns
The templates of this ResolverProjectNode.
- 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.resolver_session_node module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.resolver_session_node.ResolverSessionNode(operator=None, label=None, info=None, project=None, uid=None, timestamp=None, timezone=None, subject=None, age=None, weight=None, id=None, info_exists=None, parents=None, created=None, modified=None, revision=None, permissions=None, group=None, project_has_template=None, satisfies_template=None, files=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.SessionMixin-
property
age¶ Gets the age of this ResolverSessionNode.
Subject age at time of session, in seconds
- Returns
The age of this ResolverSessionNode.
- Return type
int
-
property
analyses¶ Gets the analyses of this ResolverSessionNode.
- Returns
The analyses of this ResolverSessionNode.
- Return type
list[AnalysisOutput]
-
property
created¶ Gets the created of this ResolverSessionNode.
Creation time (automatically set)
- Returns
The created of this ResolverSessionNode.
- Return type
datetime
-
property
files¶ Gets the files of this ResolverSessionNode.
- Returns
The files of this ResolverSessionNode.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this ResolverSessionNode.
- Returns
The group of this ResolverSessionNode.
- Return type
str
-
property
id¶ Gets the id of this ResolverSessionNode.
Unique database ID
- Returns
The id of this ResolverSessionNode.
- Return type
str
-
property
info¶ Gets the info of this ResolverSessionNode.
- Returns
The info of this ResolverSessionNode.
- Return type
-
property
info_exists¶ Gets the info_exists of this ResolverSessionNode.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this ResolverSessionNode.
- 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 ResolverSessionNode.
Application-specific label
- Returns
The label of this ResolverSessionNode.
- Return type
str
-
property
modified¶ Gets the modified of this ResolverSessionNode.
Last modification time (automatically updated)
- Returns
The modified of this ResolverSessionNode.
- Return type
datetime
-
property
notes¶ Gets the notes of this ResolverSessionNode.
- Returns
The notes of this ResolverSessionNode.
- Return type
list[Note]
-
property
operator¶ Gets the operator of this ResolverSessionNode.
The name of the operator
- Returns
The operator of this ResolverSessionNode.
- Return type
str
-
property
parents¶ Gets the parents of this ResolverSessionNode.
- Returns
The parents of this ResolverSessionNode.
- Return type
-
property
permissions¶ Gets the permissions of this ResolverSessionNode.
- Returns
The permissions of this ResolverSessionNode.
- Return type
-
property
project¶ Gets the project of this ResolverSessionNode.
Unique database ID
- Returns
The project of this ResolverSessionNode.
- Return type
str
-
property
project_has_template¶ Gets the project_has_template of this ResolverSessionNode.
- Returns
The project_has_template of this ResolverSessionNode.
- Return type
bool
-
property
revision¶ Gets the revision of this ResolverSessionNode.
An incremental document revision number
- Returns
The revision of this ResolverSessionNode.
- Return type
int
-
property
satisfies_template¶ Gets the satisfies_template of this ResolverSessionNode.
- Returns
The satisfies_template of this ResolverSessionNode.
- Return type
bool
-
property
subject¶ Gets the subject of this ResolverSessionNode.
- Returns
The subject of this ResolverSessionNode.
- Return type
Gets the tags of this ResolverSessionNode.
Array of application-specific tags
- Returns
The tags of this ResolverSessionNode.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this ResolverSessionNode.
- Returns
The timestamp of this ResolverSessionNode.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this ResolverSessionNode.
- Returns
The timezone of this ResolverSessionNode.
- 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 ResolverSessionNode.
A user database ID
- Returns
The uid of this ResolverSessionNode.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
weight¶ Gets the weight of this ResolverSessionNode.
Subject weight at time of session, in kilograms
- Returns
The weight of this ResolverSessionNode.
- Return type
float
-
property
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: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.resolver_subject_node.ResolverSubjectNode(id=None, project=None, firstname=None, lastname=None, age=None, sex=None, cohort=None, mlset=None, type=None, race=None, ethnicity=None, species=None, strain=None, label=None, code=None, master_code=None, tags=None, info=None, files=None, parents=None, created=None, modified=None, revision=None, permissions=None, notes=None, info_exists=None, analyses=None)¶ Bases:
flywheel.models.mixins.SubjectMixin-
property
age¶ Gets the age of this ResolverSubjectNode.
Age at time of session, in seconds
- Returns
The age of this ResolverSubjectNode.
- Return type
int
-
property
analyses¶ Gets the analyses of this ResolverSubjectNode.
- Returns
The analyses of this ResolverSubjectNode.
- Return type
list[AnalysisOutput]
-
property
code¶ Gets the code of this ResolverSubjectNode.
A unique identifier for the subject
- Returns
The code of this ResolverSubjectNode.
- Return type
str
-
property
cohort¶ Gets the cohort of this ResolverSubjectNode.
- Returns
The cohort of this ResolverSubjectNode.
- Return type
str
-
property
created¶ Gets the created of this ResolverSubjectNode.
Creation time (automatically set)
- Returns
The created of this ResolverSubjectNode.
- Return type
datetime
-
property
ethnicity¶ Gets the ethnicity of this ResolverSubjectNode.
- Returns
The ethnicity of this ResolverSubjectNode.
- Return type
str
-
property
files¶ Gets the files of this ResolverSubjectNode.
- Returns
The files of this ResolverSubjectNode.
- Return type
list[FileEntry]
-
property
firstname¶ Gets the firstname of this ResolverSubjectNode.
First name
- Returns
The firstname of this ResolverSubjectNode.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this ResolverSubjectNode.
Unique database ID
- Returns
The id of this ResolverSubjectNode.
- Return type
str
-
property
info¶ Gets the info of this ResolverSubjectNode.
- Returns
The info of this ResolverSubjectNode.
- Return type
-
property
info_exists¶ Gets the info_exists of this ResolverSubjectNode.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this ResolverSubjectNode.
- 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 ResolverSubjectNode.
A unique identifier for the subject
- Returns
The label of this ResolverSubjectNode.
- Return type
str
-
property
lastname¶ Gets the lastname of this ResolverSubjectNode.
Last name
- Returns
The lastname of this ResolverSubjectNode.
- Return type
str
-
property
master_code¶ Gets the master_code of this ResolverSubjectNode.
A unique identifier for the subject
- Returns
The master_code of this ResolverSubjectNode.
- Return type
str
-
property
mlset¶ Gets the mlset of this ResolverSubjectNode.
- Returns
The mlset of this ResolverSubjectNode.
- Return type
str
-
property
modified¶ Gets the modified of this ResolverSubjectNode.
Last modification time (automatically updated)
- Returns
The modified of this ResolverSubjectNode.
- Return type
datetime
-
property
notes¶ Gets the notes of this ResolverSubjectNode.
- Returns
The notes of this ResolverSubjectNode.
- Return type
list[Note]
-
property
parents¶ Gets the parents of this ResolverSubjectNode.
- Returns
The parents of this ResolverSubjectNode.
- Return type
-
property
permissions¶ Gets the permissions of this ResolverSubjectNode.
- Returns
The permissions of this ResolverSubjectNode.
- Return type
-
property
project¶ Gets the project of this ResolverSubjectNode.
Unique database ID
- Returns
The project of this ResolverSubjectNode.
- Return type
str
-
property
race¶ Gets the race of this ResolverSubjectNode.
- Returns
The race of this ResolverSubjectNode.
- Return type
str
-
property
revision¶ Gets the revision of this ResolverSubjectNode.
An incremental document revision number
- Returns
The revision of this ResolverSubjectNode.
- Return type
int
-
property
sex¶ Gets the sex of this ResolverSubjectNode.
- Returns
The sex of this ResolverSubjectNode.
- Return type
str
-
property
species¶ Gets the species of this ResolverSubjectNode.
- Returns
The species of this ResolverSubjectNode.
- Return type
str
-
property
strain¶ Gets the strain of this ResolverSubjectNode.
- Returns
The strain of this ResolverSubjectNode.
- Return type
str
Gets the tags of this ResolverSubjectNode.
Array of application-specific tags
- Returns
The tags of this ResolverSubjectNode.
- 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 ResolverSubjectNode.
- Returns
The type of this ResolverSubjectNode.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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
str
-
values()¶ Returns the list of values in the object
-
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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_acquisition module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_parent_acquisition.SearchParentAcquisition(label=None, info=None, session=None, uid=None, timestamp=None, timezone=None, id=None, parents=None, collections=None, files=None, created=None, modified=None, revision=None, info_exists=None, permissions=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.AcquisitionMixin-
property
analyses¶ Gets the analyses of this SearchParentAcquisition.
- Returns
The analyses of this SearchParentAcquisition.
- Return type
list[AnalysisOutput]
-
property
collections¶ Gets the collections of this SearchParentAcquisition.
- Returns
The collections of this SearchParentAcquisition.
- Return type
list[str]
-
property
created¶ Gets the created of this SearchParentAcquisition.
Creation time (automatically set)
- Returns
The created of this SearchParentAcquisition.
- Return type
datetime
-
property
files¶ Gets the files of this SearchParentAcquisition.
- Returns
The files of this SearchParentAcquisition.
- 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 SearchParentAcquisition.
Unique database ID
- Returns
The id of this SearchParentAcquisition.
- Return type
str
-
property
info¶ Gets the info of this SearchParentAcquisition.
- Returns
The info of this SearchParentAcquisition.
- Return type
-
property
info_exists¶ Gets the info_exists of this SearchParentAcquisition.
- Returns
The info_exists of this SearchParentAcquisition.
- 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 SearchParentAcquisition.
Application-specific label
- Returns
The label of this SearchParentAcquisition.
- Return type
str
-
property
modified¶ Gets the modified of this SearchParentAcquisition.
Last modification time (automatically updated)
- Returns
The modified of this SearchParentAcquisition.
- Return type
datetime
-
property
notes¶ Gets the notes of this SearchParentAcquisition.
- Returns
The notes of this SearchParentAcquisition.
- Return type
list[Note]
-
property
parents¶ Gets the parents of this SearchParentAcquisition.
- Returns
The parents of this SearchParentAcquisition.
- Return type
-
property
permissions¶ Gets the permissions of this SearchParentAcquisition.
- Returns
The permissions of this SearchParentAcquisition.
- Return type
-
property
revision¶ Gets the revision of this SearchParentAcquisition.
An incremental document revision number
- Returns
The revision of this SearchParentAcquisition.
- Return type
int
-
property
session¶ Gets the session of this SearchParentAcquisition.
Unique database ID
- Returns
The session of this SearchParentAcquisition.
- Return type
str
Gets the tags of this SearchParentAcquisition.
Array of application-specific tags
- Returns
The tags of this SearchParentAcquisition.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this SearchParentAcquisition.
- Returns
The timestamp of this SearchParentAcquisition.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this SearchParentAcquisition.
- Returns
The timezone of this SearchParentAcquisition.
- 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 SearchParentAcquisition.
A user database ID
- Returns
The uid of this SearchParentAcquisition.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
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: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_parent_analysis.SearchParentAnalysis(id=None, inputs=None, files=None, job=None, gear_info=None, notes=None, tags=None, info=None, description=None, label=None, parent=None, parents=None, created=None, modified=None, revision=None)¶ Bases:
flywheel.models.mixins.AnalysisMixin-
property
created¶ Gets the created of this SearchParentAnalysis.
Creation time (automatically set)
- Returns
The created of this SearchParentAnalysis.
- Return type
datetime
-
property
description¶ Gets the description of this SearchParentAnalysis.
- Returns
The description of this SearchParentAnalysis.
- Return type
str
-
property
files¶ Gets the files of this SearchParentAnalysis.
- Returns
The files of this SearchParentAnalysis.
- Return type
list[FileEntry]
-
property
gear_info¶ Gets the gear_info of this SearchParentAnalysis.
- Returns
The gear_info of this SearchParentAnalysis.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SearchParentAnalysis.
Unique database ID
- Returns
The id of this SearchParentAnalysis.
- Return type
str
-
property
info¶ Gets the info of this SearchParentAnalysis.
- Returns
The info of this SearchParentAnalysis.
- Return type
-
property
inputs¶ Gets the inputs of this SearchParentAnalysis.
- Returns
The inputs of this SearchParentAnalysis.
- Return type
list[FileEntry]
-
items()¶ Returns the list of json property to value mapping
-
property
job¶ Gets the job of this SearchParentAnalysis.
- Returns
The job of this SearchParentAnalysis.
- Return type
-
keys()¶ Returns the list of json properties in the object
-
property
label¶ Gets the label of this SearchParentAnalysis.
Application-specific label
- Returns
The label of this SearchParentAnalysis.
- Return type
str
-
property
modified¶ Gets the modified of this SearchParentAnalysis.
Last modification time (automatically updated)
- Returns
The modified of this SearchParentAnalysis.
- Return type
datetime
-
property
notes¶ Gets the notes of this SearchParentAnalysis.
- Returns
The notes of this SearchParentAnalysis.
- Return type
list[Note]
-
property
parent¶ Gets the parent of this SearchParentAnalysis.
- Returns
The parent of this SearchParentAnalysis.
- Return type
-
property
parents¶ Gets the parents of this SearchParentAnalysis.
- Returns
The parents of this SearchParentAnalysis.
- Return type
-
property
revision¶ Gets the revision of this SearchParentAnalysis.
An incremental document revision number
- Returns
The revision of this SearchParentAnalysis.
- Return type
int
Gets the tags of this SearchParentAnalysis.
Array of application-specific tags
- Returns
The tags of this SearchParentAnalysis.
- 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.search_parent_collection module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_parent_collection.SearchParentCollection(label=None, info=None, description=None, contents=None, id=None, info_exists=None, curator=None, created=None, modified=None, revision=None, permissions=None, files=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.CollectionMixin-
property
analyses¶ Gets the analyses of this SearchParentCollection.
- Returns
The analyses of this SearchParentCollection.
- Return type
list[AnalysisOutput]
-
property
contents¶ Gets the contents of this SearchParentCollection.
- Returns
The contents of this SearchParentCollection.
- Return type
-
property
created¶ Gets the created of this SearchParentCollection.
Creation time (automatically set)
- Returns
The created of this SearchParentCollection.
- Return type
datetime
-
property
curator¶ Gets the curator of this SearchParentCollection.
Database ID of a user
- Returns
The curator of this SearchParentCollection.
- Return type
str
-
property
description¶ Gets the description of this SearchParentCollection.
- Returns
The description of this SearchParentCollection.
- Return type
str
-
property
files¶ Gets the files of this SearchParentCollection.
- Returns
The files of this SearchParentCollection.
- 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 SearchParentCollection.
Unique database ID
- Returns
The id of this SearchParentCollection.
- Return type
str
-
property
info¶ Gets the info of this SearchParentCollection.
- Returns
The info of this SearchParentCollection.
- Return type
-
property
info_exists¶ Gets the info_exists of this SearchParentCollection.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this SearchParentCollection.
- 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 SearchParentCollection.
Application-specific label
- Returns
The label of this SearchParentCollection.
- Return type
str
-
property
modified¶ Gets the modified of this SearchParentCollection.
Last modification time (automatically updated)
- Returns
The modified of this SearchParentCollection.
- Return type
datetime
-
property
notes¶ Gets the notes of this SearchParentCollection.
- Returns
The notes of this SearchParentCollection.
- Return type
list[Note]
-
property
permissions¶ Gets the permissions of this SearchParentCollection.
- Returns
The permissions of this SearchParentCollection.
- Return type
list[RolesRoleAssignment]
-
property
revision¶ Gets the revision of this SearchParentCollection.
An incremental document revision number
- Returns
The revision of this SearchParentCollection.
- Return type
int
Gets the tags of this SearchParentCollection.
Array of application-specific tags
- Returns
The tags of this SearchParentCollection.
- 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.search_parent_group module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_parent_group.SearchParentGroup(id=None, label=None, permissions_template=None, roles=None, permissions=None, created=None, modified=None, revision=None, tags=None, providers=None, editions=None)¶ Bases:
flywheel.models.mixins.GroupMixin-
property
created¶ Gets the created of this SearchParentGroup.
Creation time (automatically set)
- Returns
The created of this SearchParentGroup.
- Return type
datetime
-
property
editions¶ Gets the editions of this SearchParentGroup.
- Returns
The editions of this SearchParentGroup.
- Return type
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this SearchParentGroup.
- Returns
The id of this SearchParentGroup.
- 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 SearchParentGroup.
The group label
- Returns
The label of this SearchParentGroup.
- Return type
str
-
property
modified¶ Gets the modified of this SearchParentGroup.
Last modification time (automatically updated)
- Returns
The modified of this SearchParentGroup.
- Return type
datetime
-
property
permissions¶ Gets the permissions of this SearchParentGroup.
- Returns
The permissions of this SearchParentGroup.
- Return type
-
property
permissions_template¶ Gets the permissions_template of this SearchParentGroup.
- Returns
The permissions_template of this SearchParentGroup.
- Return type
list[RolesRoleAssignment]
-
property
providers¶ Gets the providers of this SearchParentGroup.
- Returns
The providers of this SearchParentGroup.
- Return type
-
property
revision¶ Gets the revision of this SearchParentGroup.
An incremental document revision number
- Returns
The revision of this SearchParentGroup.
- Return type
int
-
property
roles¶ Gets the roles of this SearchParentGroup.
- Returns
The roles of this SearchParentGroup.
- Return type
list[str]
Gets the tags of this SearchParentGroup.
Array of application-specific tags
- Returns
The tags of this SearchParentGroup.
- 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.search_parent_project module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_parent_project.SearchParentProject(label=None, info=None, description=None, group=None, providers=None, editions=None, ldap_sync=None, id=None, parents=None, info_exists=None, created=None, modified=None, revision=None, templates=None, permissions=None, files=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.ProjectMixin-
property
analyses¶ Gets the analyses of this SearchParentProject.
- Returns
The analyses of this SearchParentProject.
- Return type
list[AnalysisOutput]
-
property
created¶ Gets the created of this SearchParentProject.
Creation time (automatically set)
- Returns
The created of this SearchParentProject.
- Return type
datetime
-
property
description¶ Gets the description of this SearchParentProject.
- Returns
The description of this SearchParentProject.
- Return type
str
-
property
editions¶ Gets the editions of this SearchParentProject.
- Returns
The editions of this SearchParentProject.
- Return type
-
property
files¶ Gets the files of this SearchParentProject.
- Returns
The files of this SearchParentProject.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this SearchParentProject.
- Returns
The group of this SearchParentProject.
- Return type
str
-
property
id¶ Gets the id of this SearchParentProject.
Unique database ID
- Returns
The id of this SearchParentProject.
- Return type
str
-
property
info¶ Gets the info of this SearchParentProject.
- Returns
The info of this SearchParentProject.
- Return type
-
property
info_exists¶ Gets the info_exists of this SearchParentProject.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this SearchParentProject.
- 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 SearchParentProject.
Application-specific label
- Returns
The label of this SearchParentProject.
- Return type
str
-
property
ldap_sync¶ Gets the ldap_sync of this SearchParentProject.
- Returns
The ldap_sync of this SearchParentProject.
- Return type
-
property
modified¶ Gets the modified of this SearchParentProject.
Last modification time (automatically updated)
- Returns
The modified of this SearchParentProject.
- Return type
datetime
-
property
notes¶ Gets the notes of this SearchParentProject.
- Returns
The notes of this SearchParentProject.
- Return type
list[Note]
-
property
parents¶ Gets the parents of this SearchParentProject.
- Returns
The parents of this SearchParentProject.
- Return type
-
property
permissions¶ Gets the permissions of this SearchParentProject.
- Returns
The permissions of this SearchParentProject.
- Return type
-
property
providers¶ Gets the providers of this SearchParentProject.
- Returns
The providers of this SearchParentProject.
- Return type
-
property
revision¶ Gets the revision of this SearchParentProject.
An incremental document revision number
- Returns
The revision of this SearchParentProject.
- Return type
int
Gets the tags of this SearchParentProject.
Array of application-specific tags
- Returns
The tags of this SearchParentProject.
- Return type
list[str]
-
property
templates¶ Gets the templates of this SearchParentProject.
- Returns
The templates of this SearchParentProject.
- 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.search_parent_response module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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= {'acquisition': 'SearchParentAcquisition', 'analysis': 'SearchParentAnalysis', 'collection': 'SearchParentCollection', 'group': 'SearchParentGroup', '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: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.search_parent_session.SearchParentSession(operator=None, label=None, info=None, project=None, uid=None, timestamp=None, timezone=None, subject=None, age=None, weight=None, id=None, info_exists=None, parents=None, created=None, modified=None, revision=None, permissions=None, group=None, project_has_template=None, satisfies_template=None, files=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.ProjectMixin-
property
age¶ Gets the age of this SearchParentSession.
Subject age at time of session, in seconds
- Returns
The age of this SearchParentSession.
- Return type
int
-
property
analyses¶ Gets the analyses of this SearchParentSession.
- Returns
The analyses of this SearchParentSession.
- Return type
list[AnalysisOutput]
-
property
created¶ Gets the created of this SearchParentSession.
Creation time (automatically set)
- Returns
The created of this SearchParentSession.
- Return type
datetime
-
property
files¶ Gets the files of this SearchParentSession.
- Returns
The files of this SearchParentSession.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this SearchParentSession.
- Returns
The group of this SearchParentSession.
- Return type
str
-
property
id¶ Gets the id of this SearchParentSession.
Unique database ID
- Returns
The id of this SearchParentSession.
- Return type
str
-
property
info¶ Gets the info of this SearchParentSession.
- Returns
The info of this SearchParentSession.
- Return type
-
property
info_exists¶ Gets the info_exists of this SearchParentSession.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this SearchParentSession.
- 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 SearchParentSession.
Application-specific label
- Returns
The label of this SearchParentSession.
- Return type
str
-
property
modified¶ Gets the modified of this SearchParentSession.
Last modification time (automatically updated)
- Returns
The modified of this SearchParentSession.
- Return type
datetime
-
property
notes¶ Gets the notes of this SearchParentSession.
- Returns
The notes of this SearchParentSession.
- Return type
list[Note]
-
property
operator¶ Gets the operator of this SearchParentSession.
The name of the operator
- Returns
The operator of this SearchParentSession.
- Return type
str
-
property
parents¶ Gets the parents of this SearchParentSession.
- Returns
The parents of this SearchParentSession.
- Return type
-
property
permissions¶ Gets the permissions of this SearchParentSession.
- Returns
The permissions of this SearchParentSession.
- Return type
-
property
project¶ Gets the project of this SearchParentSession.
Unique database ID
- Returns
The project of this SearchParentSession.
- Return type
str
-
property
project_has_template¶ Gets the project_has_template of this SearchParentSession.
- Returns
The project_has_template of this SearchParentSession.
- Return type
bool
-
property
revision¶ Gets the revision of this SearchParentSession.
An incremental document revision number
- Returns
The revision of this SearchParentSession.
- Return type
int
-
property
satisfies_template¶ Gets the satisfies_template of this SearchParentSession.
- Returns
The satisfies_template of this SearchParentSession.
- Return type
bool
-
property
subject¶ Gets the subject of this SearchParentSession.
- Returns
The subject of this SearchParentSession.
- Return type
Gets the tags of this SearchParentSession.
Array of application-specific tags
- Returns
The tags of this SearchParentSession.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this SearchParentSession.
- Returns
The timestamp of this SearchParentSession.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this SearchParentSession.
- Returns
The timezone of this SearchParentSession.
- 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 SearchParentSession.
A user database ID
- Returns
The uid of this SearchParentSession.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
weight¶ Gets the weight of this SearchParentSession.
Subject weight at time of session, in kilograms
- Returns
The weight of this SearchParentSession.
- Return type
float
-
property
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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.
Sets the type of search results to return
- Returns
The return_type of this SearchResponse.
- Return type
str
-
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_save_search module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.session.Session(operator=None, label=None, info=None, project=None, uid=None, timestamp=None, timezone=None, subject=None, age=None, weight=None, id=None, info_exists=None, parents=None, created=None, modified=None, revision=None, permissions=None, group=None, project_has_template=None, satisfies_template=None, files=None, notes=None, tags=None, analyses=None)¶ Bases:
flywheel.models.mixins.SessionMixin-
property
age¶ Gets the age of this Session.
Subject age at time of session, in seconds
- Returns
The age of this Session.
- Return type
int
-
property
analyses¶ Gets the analyses of this Session.
- Returns
The analyses of this Session.
- Return type
list[AnalysisOutput]
-
property
created¶ Gets the created of this Session.
Creation time (automatically set)
- Returns
The created of this Session.
- Return type
datetime
-
property
files¶ Gets the files of this Session.
- Returns
The files of this Session.
- Return type
list[FileEntry]
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
group¶ Gets the group of this Session.
- Returns
The group of this Session.
- Return type
str
-
property
id¶ Gets the id of this Session.
Unique database ID
- Returns
The id of this Session.
- Return type
str
-
property
info¶ Gets the info of this Session.
- Returns
The info of this Session.
- Return type
-
property
info_exists¶ Gets the info_exists of this Session.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this Session.
- 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 Session.
Application-specific label
- Returns
The label of this Session.
- Return type
str
-
property
modified¶ Gets the modified of this Session.
Last modification time (automatically updated)
- Returns
The modified of this Session.
- Return type
datetime
-
property
notes¶ Gets the notes of this Session.
- Returns
The notes of this Session.
- Return type
list[Note]
-
property
operator¶ Gets the operator of this Session.
The name of the operator
- Returns
The operator of this Session.
- Return type
str
-
property
parents¶ Gets the parents of this Session.
- Returns
The parents of this Session.
- Return type
-
property
permissions¶ Gets the permissions of this Session.
- Returns
The permissions of this Session.
- Return type
-
property
project¶ Gets the project of this Session.
Unique database ID
- Returns
The project of this Session.
- Return type
str
-
property
project_has_template¶ Gets the project_has_template of this Session.
- Returns
The project_has_template of this Session.
- Return type
bool
-
property
revision¶ Gets the revision of this Session.
An incremental document revision number
- Returns
The revision of this Session.
- Return type
int
-
property
satisfies_template¶ Gets the satisfies_template of this Session.
- Returns
The satisfies_template of this Session.
- Return type
bool
-
property
subject¶ Gets the subject of this Session.
- Returns
The subject of this Session.
- Return type
Gets the tags of this Session.
Array of application-specific tags
- Returns
The tags of this Session.
- Return type
list[str]
-
property
timestamp¶ Gets the timestamp of this Session.
- Returns
The timestamp of this Session.
- Return type
datetime
-
property
timezone¶ Gets the timezone of this Session.
- Returns
The timezone of this Session.
- 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 Session.
A user database ID
- Returns
The uid of this Session.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
weight¶ Gets the weight of this Session.
Subject weight at time of session, in kilograms
- Returns
The weight of this Session.
- Return type
float
-
property
flywheel.models.session_jobs_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.session_jobs_output.SessionJobsOutput(jobs=None, containers=None)¶ Bases:
object-
property
containers¶ Gets the containers of this SessionJobsOutput.
- Returns
The containers of this SessionJobsOutput.
- 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
-
property
jobs¶ Gets the jobs of this SessionJobsOutput.
- Returns
The jobs of this SessionJobsOutput.
- Return type
list[Job]
-
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.session_metadata_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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
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_template_recalc_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.signedurlmetadata_signed_url_metadata_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.signedurlmetadata_signed_url_metadata_input.SignedurlmetadataSignedUrlMetadataInput(metadata=None, filename=None)¶ Bases:
object-
property
filename¶ Gets the filename of this SignedurlmetadataSignedUrlMetadataInput.
- Returns
The filename of this SignedurlmetadataSignedUrlMetadataInput.
- 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
metadata¶ Gets the metadata of this SignedurlmetadataSignedUrlMetadataInput.
- Returns
The metadata of this SignedurlmetadataSignedUrlMetadataInput.
- 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.subject module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.subject.Subject(id=None, project=None, firstname=None, lastname=None, age=None, sex=None, cohort=None, mlset=None, type=None, race=None, ethnicity=None, species=None, strain=None, label=None, code=None, master_code=None, tags=None, info=None, files=None, parents=None, created=None, modified=None, revision=None, permissions=None, notes=None, info_exists=None, analyses=None)¶ Bases:
flywheel.models.mixins.SubjectMixin-
property
age¶ Gets the age of this Subject.
Age at time of session, in seconds
- Returns
The age of this Subject.
- Return type
int
-
property
analyses¶ Gets the analyses of this Subject.
- Returns
The analyses of this Subject.
- Return type
list[AnalysisOutput]
-
property
code¶ Gets the code of this Subject.
A unique identifier for the subject
- Returns
The code of this Subject.
- Return type
str
-
property
cohort¶ Gets the cohort of this Subject.
- Returns
The cohort of this Subject.
- Return type
str
-
property
created¶ Gets the created of this Subject.
Creation time (automatically set)
- Returns
The created of this Subject.
- Return type
datetime
-
property
ethnicity¶ Gets the ethnicity of this Subject.
- Returns
The ethnicity of this Subject.
- Return type
str
-
property
files¶ Gets the files of this Subject.
- Returns
The files of this Subject.
- Return type
list[FileEntry]
-
property
firstname¶ Gets the firstname of this Subject.
First name
- Returns
The firstname of this Subject.
- Return type
str
-
get(key, default=None)¶ Get the value of the provided json property, or default
-
property
id¶ Gets the id of this Subject.
Unique database ID
- Returns
The id of this Subject.
- Return type
str
-
property
info¶ Gets the info of this Subject.
- Returns
The info of this Subject.
- Return type
-
property
info_exists¶ Gets the info_exists of this Subject.
Flag that indicates whether or not info exists on this container
- Returns
The info_exists of this Subject.
- 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 Subject.
A unique identifier for the subject
- Returns
The label of this Subject.
- Return type
str
-
property
lastname¶ Gets the lastname of this Subject.
Last name
- Returns
The lastname of this Subject.
- Return type
str
-
property
master_code¶ Gets the master_code of this Subject.
A unique identifier for the subject
- Returns
The master_code of this Subject.
- Return type
str
-
property
mlset¶ Gets the mlset of this Subject.
- Returns
The mlset of this Subject.
- Return type
str
-
property
modified¶ Gets the modified of this Subject.
Last modification time (automatically updated)
- Returns
The modified of this Subject.
- Return type
datetime
-
property
notes¶ Gets the notes of this Subject.
- Returns
The notes of this Subject.
- Return type
list[Note]
-
property
parents¶ Gets the parents of this Subject.
- Returns
The parents of this Subject.
- Return type
-
property
permissions¶ Gets the permissions of this Subject.
- Returns
The permissions of this Subject.
- Return type
-
property
project¶ Gets the project of this Subject.
Unique database ID
- Returns
The project of this Subject.
- Return type
str
-
property
race¶ Gets the race of this Subject.
- Returns
The race of this Subject.
- Return type
str
-
property
revision¶ Gets the revision of this Subject.
An incremental document revision number
- Returns
The revision of this Subject.
- Return type
int
-
property
sex¶ Gets the sex of this Subject.
- Returns
The sex of this Subject.
- Return type
str
-
property
species¶ Gets the species of this Subject.
- Returns
The species of this Subject.
- Return type
str
-
property
strain¶ Gets the strain of this Subject.
- Returns
The strain of this Subject.
- Return type
str
Gets the tags of this Subject.
Array of application-specific tags
- Returns
The tags of this Subject.
- 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 Subject.
- Returns
The type of this Subject.
- Return type
str
-
values()¶ Returns the list of values in the object
-
property
flywheel.models.subject_metadata_input module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
flywheel.models.subject_metadata_input.SubjectMetadataInput(label=None, code=None, master_code=None, info=None, tags=None, files=None)¶ Bases:
object-
property
code¶ Gets the code of this SubjectMetadataInput.
- Returns
The code of this SubjectMetadataInput.
- Return type
str
-
property
files¶ Gets the files of this SubjectMetadataInput.
- Returns
The files of this SubjectMetadataInput.
- 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 SubjectMetadataInput.
- Returns
The info of this SubjectMetadataInput.
- 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 SubjectMetadataInput.
A unique identifier for the subject
- Returns
The label of this SubjectMetadataInput.
- Return type
str
-
property
master_code¶ Gets the master_code of this SubjectMetadataInput.
- Returns
The master_code of this SubjectMetadataInput.
- Return type
str
Gets the tags of this SubjectMetadataInput.
Array of application-specific tags
- Returns
The tags of this SubjectMetadataInput.
- 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.tag module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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: 15.8.0
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.user module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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, api_key=None)¶ Bases:
object-
property
api_key¶ Gets the api_key of this User.
- Returns
The api_key of this User.
- Return type
-
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
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: 15.8.0
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_jobs_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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_preferences module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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: 15.8.0
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.version_output module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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.viewer_app module¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
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
Module contents¶
Flywheel
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
OpenAPI spec version: 15.8.0
Generated by: https://github.com/swagger-api/swagger-codegen.git