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: master/ebfcbb85

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

CommonInfo

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

ContainerParents

property permissions

Gets the permissions of this Acquisition.

Returns

The permissions of this Acquisition.

Return type

list[RolesBackwardsCompatibleRoleAssignment]

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

property tags

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

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: master/ebfcbb85

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

property tags

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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

CommonInfo

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

Job

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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

GearInfo

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

ContainerReference

property parents

Gets the parents of this AnalysisListEntry.

Returns

The parents of this AnalysisListEntry.

Return type

ContainerParents

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

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: master/ebfcbb85

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

GearInfo

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

CommonInfo

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

Job

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

ContainerReference

property parents

Gets the parents of this AnalysisOutput.

Returns

The parents of this AnalysisOutput.

Return type

ContainerParents

property revision

Gets the revision of this AnalysisOutput.

An incremental document revision number

Returns

The revision of this AnalysisOutput.

Return type

int

property tags

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

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

ReportAccessLogOrigin

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: master/ebfcbb85

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: master/ebfcbb85

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

flywheel.models.batch module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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

JobConfig

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

JobOrigin

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

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

JobConfig

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

JobOrigin

property proposal

Gets the proposal of this BatchProposal.

Returns

The proposal of this BatchProposal.

Return type

BatchProposalDetail

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

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: master/ebfcbb85

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

AnalysisInput

get(key, default=None)

Get the value of the provided json property, or default

items()

Returns the list of json property to value mapping

keys()

Returns the list of json properties in the object

property tags

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

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: master/ebfcbb85

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

AnalysisInput

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

JobConfig

property gear_id

Gets the gear_id of this BatchProposalInput.

Returns

The gear_id of this BatchProposalInput.

Return type

str

get(key, default=None)

Get the value of the provided json property, or default

items()

Returns the list of json property to value mapping

keys()

Returns the list of json properties in the object

property optional_input_policy

Gets the optional_input_policy of this BatchProposalInput.

ignored: Ignore all optional inputs, flexible: match a file if it’s there, otherwise still match the container, required: treat all optional inputs as required inputs.

Returns

The optional_input_policy of this BatchProposalInput.

Return type

str

property tags

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

flywheel.models.body module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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: master/ebfcbb85

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

CommonClassification

property delete

Gets the delete of this ClassificationAddDelete.

Returns

The delete of this ClassificationAddDelete.

Return type

CommonClassification

get(key, default=None)

Get the value of the provided 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.classification_replace module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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: master/ebfcbb85

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

CommonClassification

property delete

Gets the delete of this ClassificationUpdateInput.

Returns

The delete of this ClassificationUpdateInput.

Return type

CommonClassification

get(key, default=None)

Get the value of the provided json 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

flywheel.models.collection module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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

CollectionOperation

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

CommonInfo

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

property tags

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

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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

ConfigFeatureMap

get(key, default=None)

Get the value of the provided json 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

ConfigSiteConfigOutput

to_dict()

Returns 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_site_config_output module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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

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: master/ebfcbb85

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)

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 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

ProviderLinks

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

values()

Returns the list of values in the object

property viewer_apps

Gets the viewer_apps of this ConfigSiteSettings.

A list of viewer app associations for files and container

Returns

The viewer_apps of this ConfigSiteSettings.

Return type

list[ViewerApp]

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: master/ebfcbb85

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)

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 providers

Gets the providers of this ConfigSiteSettingsInput.

Returns

The providers of this ConfigSiteSettingsInput.

Return type

ProviderLinks

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

values()

Returns the list of values in the object

property viewer_apps

Gets the viewer_apps of this ConfigSiteSettingsInput.

A list of viewer app associations for files and container

Returns

The viewer_apps of this ConfigSiteSettingsInput.

Return type

list[ViewerApp]

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: master/ebfcbb85

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

CommonInfo

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

ContainerParents

property permissions

Gets the permissions of this ContainerAcquisitionOutput.

Returns

The permissions of this ContainerAcquisitionOutput.

Return type

list[RolesBackwardsCompatibleRoleAssignment]

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

property tags

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

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: master/ebfcbb85

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

GearInfo

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

CommonInfo

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

Job

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

ContainerReference

property parents

Gets the parents of this ContainerAnalysisOutput.

Returns

The parents of this ContainerAnalysisOutput.

Return type

ContainerParents

property revision

Gets the revision of this ContainerAnalysisOutput.

An incremental document revision number

Returns

The revision of this ContainerAnalysisOutput.

Return type

int

property tags

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

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: master/ebfcbb85

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

CollectionOperation

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

CommonInfo

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

property tags

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

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: master/ebfcbb85

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.models.container_file_output.ContainerFileOutput(id=None, name=None, type=None, mimetype=None, modality=None, classification=None, tags=None, info=None, origin=None, hash=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

CommonClassification

property created

Gets the created of this ContainerFileOutput.

Creation time (automatically set)

Returns

The created of this ContainerFileOutput.

Return type

datetime

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

CommonInfo

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

FileOrigin

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

property tags

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 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

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: master/ebfcbb85

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

CommonEditions

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

list[PermissionAccessPermission]

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

ProviderLinks

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]

property tags

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

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: master/ebfcbb85

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: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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, 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

CommonEditions

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

CommonInfo

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 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

ContainerParents

property permissions

Gets the permissions of this ContainerProjectOutput.

Returns

The permissions of this ContainerProjectOutput.

Return type

list[RolesBackwardsCompatibleRoleAssignment]

property providers

Gets the providers of this ContainerProjectOutput.

Returns

The providers of this ContainerProjectOutput.

Return type

ProviderLinks

property revision

Gets the revision of this ContainerProjectOutput.

An incremental document revision number

Returns

The revision of this ContainerProjectOutput.

Return type

int

property tags

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

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: master/ebfcbb85

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: master/ebfcbb85

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

CommonInfo

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

ContainerParents

property permissions

Gets the permissions of this ContainerSessionOutput.

Returns

The permissions of this ContainerSessionOutput.

Return type

list[RolesBackwardsCompatibleRoleAssignment]

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

Subject

property tags

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

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: master/ebfcbb85

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, 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

CommonInfo

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 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

ContainerParents

property permissions

Gets the permissions of this ContainerSubjectOutput.

Returns

The permissions of this ContainerSubjectOutput.

Return type

list[RolesBackwardsCompatibleRoleAssignment]

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

property tags

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

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: master/ebfcbb85

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.models.container_uidcheck.ContainerUidcheck(sessions=None, acquisitions=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 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

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: master/ebfcbb85

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: master/ebfcbb85

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

DataViewFileSpec

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

Origin

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

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: master/ebfcbb85

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

DataViewNameFilterSpec

property gear_version

Gets the gear_version of this DataViewAnalysisFilterSpec.

Returns

The gear_version of this DataViewAnalysisFilterSpec.

Return type

DataViewNameFilterSpec

get(key, default=None)

Get the value of the provided json 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

DataViewNameFilterSpec

to_dict()

Returns 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_column_alias module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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

DataViewAnalysisFilterSpec

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

DataViewNameFilterSpec

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

DataViewNameFilterSpec

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: master/ebfcbb85

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: master/ebfcbb85

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

DataView

property view_id

Gets the view_id of this DataViewSaveDataViewInput.

Unique database ID

Returns

The view_id of this DataViewSaveDataViewInput.

Return type

str

flywheel.models.device module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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

CommonInfo

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

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: master/ebfcbb85

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: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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

flywheel.models.download module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.models.download.Download(optional=None, nodes=None, filters=None)

Bases: object

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

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: master/ebfcbb85

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

property tags

Gets the tags of this DownloadFilter.

Returns

The tags of this DownloadFilter.

Return type

DownloadFilterDefinition

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

DownloadFilterDefinition

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: master/ebfcbb85

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: master/ebfcbb85

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.models.download_input.DownloadInput(optional=None, nodes=None, filters=None)

Bases: object

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

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

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: master/ebfcbb85

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

AcquisitionMetadataInput

get(key, default=None)

Get the value of the provided json 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

ProjectMetadataInput

property session

Gets the session of this EnginemetadataEngineUploadInput.

Returns

The session of this EnginemetadataEngineUploadInput.

Return type

SessionMetadataInput

property subject

Gets the subject of this EnginemetadataEngineUploadInput.

Returns

The subject of this EnginemetadataEngineUploadInput.

Return type

SubjectMetadataInput

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

values()

Returns the list of values in the object

flywheel.models.enginemetadata_label_upload_input module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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

EnginemetadataUploadAcquisitionMetadataInput

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

GroupMetadataInput

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

ProjectMetadataInput

property session

Gets the session of this EnginemetadataLabelUploadInput.

Returns

The session of this EnginemetadataLabelUploadInput.

Return type

SessionMetadataInput

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

values()

Returns the list of values in the object

flywheel.models.enginemetadata_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: master/ebfcbb85

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

EnginemetadataUploadAcquisitionMetadataInput

get(key, default=None)

Get the value of the provided json 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

ProjectMetadataInput

property session

Gets the session of this EnginemetadataUidMatchUploadInput.

Returns

The session of this EnginemetadataUidMatchUploadInput.

Return type

SessionMetadataInput

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

values()

Returns the list of values in the object

flywheel.models.enginemetadata_uid_upload_input module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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

EnginemetadataUploadAcquisitionMetadataInput

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

GroupMetadataInput

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

ProjectMetadataInput

property session

Gets the session of this EnginemetadataUidUploadInput.

Returns

The session of this EnginemetadataUidUploadInput.

Return type

SessionMetadataInput

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

values()

Returns the list of values in the object

flywheel.models.enginemetadata_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: master/ebfcbb85

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

property tags

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

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: master/ebfcbb85

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.models.file_entry.FileEntry(id=None, name=None, type=None, mimetype=None, modality=None, classification=None, tags=None, info=None, origin=None, hash=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

CommonClassification

property created

Gets the created of this FileEntry.

Creation time (automatically set)

Returns

The created of this FileEntry.

Return type

datetime

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

CommonInfo

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

FileOrigin

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

property tags

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 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

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: master/ebfcbb85

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

property via

Gets the via of this FileOrigin.

Returns

The via of this FileOrigin.

Return type

FileVia

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: master/ebfcbb85

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_via module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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: master/ebfcbb85

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

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: master/ebfcbb85

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

flywheel.models.gear module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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: object

property author

Gets 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

GearConfig

property custom

Gets the custom of this Gear.

Returns

The custom of this Gear.

Return type

GearCustom

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

GearEnvironment

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

GearInputs

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

GearExchange

property gear

Gets the gear of this GearDoc.

Returns

The gear of this GearDoc.

Return type

Gear

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

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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: object

Represents the details necessary to execute a gear as a job

add_tag(tag)

Add a tag to the job

add_tags(tags)

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: object

Gear 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: master/ebfcbb85

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

CommonEditions

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

list[PermissionAccessPermission]

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

ProviderLinks

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]

property tags

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

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

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: master/ebfcbb85

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: master/ebfcbb85

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

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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: master/ebfcbb85

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 config

Gets the config of this Job.

Returns

The config of this Job.

Return type

JobConfig

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

JobDestination

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

GearInfo

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

JobInputsObject

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 origin

Gets the origin of this Job.

Returns

The origin of this Job.

Return type

JobOrigin

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

JobProfile

property project

Gets the project of this Job.

Unique database ID

Returns

The project of this Job.

Return type

str

property related_container_ids

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

JobRequest

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

property tags

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

JobTransitionTimes

values()

Returns the list of values in the object

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: master/ebfcbb85

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

JobConfigInputs

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

JobConfigInputs

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: master/ebfcbb85

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

JobStateCounts

to_dict()

Returns 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: master/ebfcbb85

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.models.job_ask_return.JobAskReturn(jobs=None, peek=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 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

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: master/ebfcbb85

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

JobProfileInput

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

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

JobConfig

property destination

Gets the destination of this JobConfigOutput.

Returns

The destination of this JobConfigOutput.

Return type

JobDestination

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

JobConfigInputs

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_container_detail module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

JobConfig

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

JobDestination

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

GearInfo

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

JobDetailInputsObject

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

JobOrigin

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

JobDetailParentInfo

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

JobRequest

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

property tags

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

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: master/ebfcbb85

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

FileEntry

property ref

Gets the ref of this JobDetailFileEntry.

Returns

The ref of this JobDetailFileEntry.

Return type

FileReference

to_dict()

Returns 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: master/ebfcbb85

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: master/ebfcbb85

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

JobContainerDetail

property analysis

Gets the analysis of this JobDetailParentInfo.

Returns

The analysis of this JobDetailParentInfo.

Return type

JobContainerDetail

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

JobContainerDetail

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

JobContainerDetail

property session

Gets the session of this JobDetailParentInfo.

Returns

The session of this JobDetailParentInfo.

Return type

JobContainerDetail

property subject

Gets the subject of this JobDetailParentInfo.

Returns

The subject of this JobDetailParentInfo.

Return type

JobContainerDetail

to_dict()

Returns 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_executor_info module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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

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: master/ebfcbb85

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: master/ebfcbb85

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: master/ebfcbb85

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

JobConfig

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

JobDestination

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

GearInfo

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

JobOrigin

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

JobRequest

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

property tags

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

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: master/ebfcbb85

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: master/ebfcbb85

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

flywheel.models.job_origin module