flywheel.flywheel.model package¶

AccessLevel¶

An enumeration.

class AccessLevel¶: An enumeration.

AccessPermission¶

Model for an access permission Attributes: id: The id of the user access: The access level the user has on the resource

class AccessPermission¶

Model for an access permission Attributes: id: The id of the user access: The access level the user has on the resource

id¶

Gets the id of this AccessPermission.

Returns: The id of this AccessPermission.
Return type: char

access¶

Gets the access of this AccessPermission.

Returns: The access of this AccessPermission.
Return type: AccessLevel

AccessPermissionOutput¶

class AccessPermissionOutput¶

id¶

Gets the id of this AccessPermissionOutput.

Returns: The id of this AccessPermissionOutput.
Return type: char

access¶

Gets the access of this AccessPermissionOutput.

Returns: The access of this AccessPermissionOutput.
Return type: AccessLevel

AccessPermissionUpdate¶

class AccessPermissionUpdate¶

access¶

Gets the access of this AccessPermissionUpdate.

Returns: The access of this AccessPermissionUpdate.
Return type: AccessLevel

AccessType¶

An enumeration.

class AccessType¶: An enumeration.

Accumulator¶

An enumeration.

class Accumulator¶: An enumeration.

Acquisition¶

class Acquisition¶

AcquisitionContainerOutput¶

Representation of the acquisition to be returned Attributes: id (str): The id of the acquisition parents (AcquisitionParents): The mapping of parents to parent id for the acquisition label (str): The label of the acquisition session (str): The parent session info_exists (bool): Boolean value of info info (Optional[dict]): The custom info object of the acquisition uid (Optional[str]): The optional universal identification for the acquisition files (List[FileOutput]): The list of files attached to the acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp created (datetime.datetime): The time the acquisition was created in flywheel modified (datetime.datetime): The last modified time of the acquisition revision (int): The revision number of the acquisition permissions (List[RolePermission]): The list of permissions on the acquisition tags (List[str]): The list of tags notes (List[Note]): The list of notes analyses (List[Analysis]): The list of analyses children of the collections (List[str]): The collections the acquisition is a part of acquisition join_origin (Optional[JoinOrigins]): TODO: description copy_of (Optional[str]): Contains the id of the direct container copied from original_copy_of (Optional[str]): Contains the original ancestor container copied from

class AcquisitionContainerOutput¶

Representation of the acquisition to be returned Attributes: id (str): The id of the acquisition parents (AcquisitionParents): The mapping of parents to parent id for the acquisition label (str): The label of the acquisition session (str): The parent session info_exists (bool): Boolean value of info info (Optional[dict]): The custom info object of the acquisition uid (Optional[str]): The optional universal identification for the acquisition files (List[FileOutput]): The list of files attached to the acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp created (datetime.datetime): The time the acquisition was created in flywheel modified (datetime.datetime): The last modified time of the acquisition revision (int): The revision number of the acquisition permissions (List[RolePermission]): The list of permissions on the acquisition tags (List[str]): The list of tags notes (List[Note]): The list of notes analyses (List[Analysis]): The list of analyses children of the collections (List[str]): The collections the acquisition is a part of acquisition join_origin (Optional[JoinOrigins]): TODO: description copy_of (Optional[str]): Contains the id of the direct container copied from original_copy_of (Optional[str]): Contains the original ancestor container copied from

id¶

Gets the id of this AcquisitionContainerOutput.

Returns: The id of this AcquisitionContainerOutput.
Return type: char

parents¶

Gets the parents of this AcquisitionContainerOutput.

Returns: The parents of this AcquisitionContainerOutput.
Return type: AcquisitionParents

label¶

Gets the label of this AcquisitionContainerOutput.

Returns: The label of this AcquisitionContainerOutput.
Return type: char

session¶

Gets the session of this AcquisitionContainerOutput.

Returns: The session of this AcquisitionContainerOutput.
Return type: char

infoExists¶

Gets the infoExists of this AcquisitionContainerOutput.

Returns: The infoExists of this AcquisitionContainerOutput.
Return type: logical

info¶

Gets the info of this AcquisitionContainerOutput.

Returns: The info of this AcquisitionContainerOutput.
Return type: containers.Map

metadata¶

Gets the metadata of this AcquisitionContainerOutput.

Returns: The metadata of this AcquisitionContainerOutput.
Return type: containers.Map

uid¶

Gets the uid of this AcquisitionContainerOutput.

Returns: The uid of this AcquisitionContainerOutput.
Return type: char

timestamp¶

Gets the timestamp of this AcquisitionContainerOutput.

Returns: The timestamp of this AcquisitionContainerOutput.
Return type: datetime

timezone¶

Gets the timezone of this AcquisitionContainerOutput.

Returns: The timezone of this AcquisitionContainerOutput.
Return type: char

created¶

Gets the created of this AcquisitionContainerOutput.

Returns: The created of this AcquisitionContainerOutput.
Return type: datetime

modified¶

Gets the modified of this AcquisitionContainerOutput.

Returns: The modified of this AcquisitionContainerOutput.
Return type: datetime

revision¶

Gets the revision of this AcquisitionContainerOutput.

Returns: The revision of this AcquisitionContainerOutput.
Return type: integer

permissions¶

Gets the permissions of this AcquisitionContainerOutput.

Returns: The permissions of this AcquisitionContainerOutput.
Return type: RolePermission

tags¶

Gets the tags of this AcquisitionContainerOutput.

Returns: The tags of this AcquisitionContainerOutput.
Return type: vector[char]

notes¶

Gets the notes of this AcquisitionContainerOutput.

Returns: The notes of this AcquisitionContainerOutput.
Return type: Note

analyses¶

Gets the analyses of this AcquisitionContainerOutput.

Returns: The analyses of this AcquisitionContainerOutput.
Return type: Object

collections¶

Gets the collections of this AcquisitionContainerOutput.

Returns: The collections of this AcquisitionContainerOutput.
Return type: vector[char]

joinOrigin¶

Gets the joinOrigin of this AcquisitionContainerOutput.

Returns: The joinOrigin of this AcquisitionContainerOutput.
Return type: JoinOrigins

files¶

Gets the files of this AcquisitionContainerOutput.

Returns: The files of this AcquisitionContainerOutput.
Return type: FileOutput

copyOf¶

Gets the copyOf of this AcquisitionContainerOutput.

Returns: The copyOf of this AcquisitionContainerOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this AcquisitionContainerOutput.

Returns: The originalCopyOf of this AcquisitionContainerOutput.
Return type: char

containerType¶

Gets the containerType of this AcquisitionContainerOutput.

Returns: The containerType of this AcquisitionContainerOutput.
Return type: AllOfAcquisitionContainerOutputContainerType

AcquisitionInput¶

Input model for acquisition Attributes: label (str): The label of the acquisition session (str): The parent session info (Optional[dict]): The custom info object of the acquisition uid (Optional[str]): The optional universal identification for the acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp

class AcquisitionInput¶

Input model for acquisition Attributes: label (str): The label of the acquisition session (str): The parent session info (Optional[dict]): The custom info object of the acquisition uid (Optional[str]): The optional universal identification for the acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp

label¶

Gets the label of this AcquisitionInput.

Returns: The label of this AcquisitionInput.
Return type: char

session¶

Gets the session of this AcquisitionInput.

Returns: The session of this AcquisitionInput.
Return type: char

uid¶

Gets the uid of this AcquisitionInput.

Returns: The uid of this AcquisitionInput.
Return type: char

timestamp¶

Gets the timestamp of this AcquisitionInput.

Returns: The timestamp of this AcquisitionInput.
Return type: datetime

timezone¶

Gets the timezone of this AcquisitionInput.

Returns: The timezone of this AcquisitionInput.
Return type: char

info¶

Gets the info of this AcquisitionInput.

Returns: The info of this AcquisitionInput.
Return type: containers.Map

AcquisitionListOutput¶

Representation of the acquisition to be returned Attributes: id (str): The id of the acquisition parents (AcquisitionParents): The mapping of parents to parent id for the acquisition label (str): The label of the acquisition session (str): The parent session info (Optional[dict]): The custom info object of the acquisition info_exists (bool): Boolean value of info metadata (Optional[dict]): TODO: description uid (Optional[str]): The optional universal identification for the acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp created (datetime.datetime): The time the acquisition was created in flywheel modified (datetime.datetime): The last modified time of the acquisition revision (int): The revision number of the acquisition permissions (List[RolePermission]): The list of permissions on the acquisition notes (List[Note]): The list of notes analyses (List[Analysis]): The list of analyses children of the collections (List[str]): The collections the acquisition is a part of join_origin (Optional[JoinOrigins]): TODO: description files (List[FileListOutput]): The list of files attached to the acquisition copy_of (Optional[str]): Contains the id of the container copied from original_copy_of (Optional[str]): Contains the original ancestor container copied from

class AcquisitionListOutput¶

Representation of the acquisition to be returned Attributes: id (str): The id of the acquisition parents (AcquisitionParents): The mapping of parents to parent id for the acquisition label (str): The label of the acquisition session (str): The parent session info (Optional[dict]): The custom info object of the acquisition info_exists (bool): Boolean value of info metadata (Optional[dict]): TODO: description uid (Optional[str]): The optional universal identification for the acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp created (datetime.datetime): The time the acquisition was created in flywheel modified (datetime.datetime): The last modified time of the acquisition revision (int): The revision number of the acquisition permissions (List[RolePermission]): The list of permissions on the acquisition notes (List[Note]): The list of notes analyses (List[Analysis]): The list of analyses children of the collections (List[str]): The collections the acquisition is a part of join_origin (Optional[JoinOrigins]): TODO: description files (List[FileListOutput]): The list of files attached to the acquisition copy_of (Optional[str]): Contains the id of the container copied from original_copy_of (Optional[str]): Contains the original ancestor container copied from

id¶

Gets the id of this AcquisitionListOutput.

Returns: The id of this AcquisitionListOutput.
Return type: char

parents¶

Gets the parents of this AcquisitionListOutput.

Returns: The parents of this AcquisitionListOutput.
Return type: AcquisitionParents

label¶

Gets the label of this AcquisitionListOutput.

Returns: The label of this AcquisitionListOutput.
Return type: char

session¶

Gets the session of this AcquisitionListOutput.

Returns: The session of this AcquisitionListOutput.
Return type: char

info¶

Gets the info of this AcquisitionListOutput.

Returns: The info of this AcquisitionListOutput.
Return type: containers.Map

infoExists¶

Gets the infoExists of this AcquisitionListOutput.

Returns: The infoExists of this AcquisitionListOutput.
Return type: logical

metadata¶

Gets the metadata of this AcquisitionListOutput.

Returns: The metadata of this AcquisitionListOutput.
Return type: containers.Map

uid¶

Gets the uid of this AcquisitionListOutput.

Returns: The uid of this AcquisitionListOutput.
Return type: char

timestamp¶

Gets the timestamp of this AcquisitionListOutput.

Returns: The timestamp of this AcquisitionListOutput.
Return type: datetime

timezone¶

Gets the timezone of this AcquisitionListOutput.

Returns: The timezone of this AcquisitionListOutput.
Return type: char

created¶

Gets the created of this AcquisitionListOutput.

Returns: The created of this AcquisitionListOutput.
Return type: datetime

tags¶

Gets the tags of this AcquisitionListOutput.

Returns: The tags of this AcquisitionListOutput.
Return type: vector[char]

modified¶

Gets the modified of this AcquisitionListOutput.

Returns: The modified of this AcquisitionListOutput.
Return type: datetime

revision¶

Gets the revision of this AcquisitionListOutput.

Returns: The revision of this AcquisitionListOutput.
Return type: integer

permissions¶

Gets the permissions of this AcquisitionListOutput.

Returns: The permissions of this AcquisitionListOutput.
Return type: RolePermission

notes¶

Gets the notes of this AcquisitionListOutput.

Returns: The notes of this AcquisitionListOutput.
Return type: Note

analyses¶

Gets the analyses of this AcquisitionListOutput.

Returns: The analyses of this AcquisitionListOutput.
Return type: Object

collections¶

Gets the collections of this AcquisitionListOutput.

Returns: The collections of this AcquisitionListOutput.
Return type: vector[char]

joinOrigin¶

Gets the joinOrigin of this AcquisitionListOutput.

Returns: The joinOrigin of this AcquisitionListOutput.
Return type: JoinOrigins

files¶

Gets the files of this AcquisitionListOutput.

Returns: The files of this AcquisitionListOutput.
Return type: FileListOutput

copyOf¶

Gets the copyOf of this AcquisitionListOutput.

Returns: The copyOf of this AcquisitionListOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this AcquisitionListOutput.

Returns: The originalCopyOf of this AcquisitionListOutput.
Return type: char

AcquisitionModifyInput¶

Input model for acquisition modifications Attributes: label (Optional[str]): The label of the acquisition session (Optional[str]): The parent session info (Optional[dict]): The custom info object of the acquisition uid (Optional[str]): The optional universal identification for the acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp

class AcquisitionModifyInput¶

Input model for acquisition modifications Attributes: label (Optional[str]): The label of the acquisition session (Optional[str]): The parent session info (Optional[dict]): The custom info object of the acquisition uid (Optional[str]): The optional universal identification for the acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp

label¶

Gets the label of this AcquisitionModifyInput.

Returns: The label of this AcquisitionModifyInput.
Return type: char

session¶

Gets the session of this AcquisitionModifyInput.

Returns: The session of this AcquisitionModifyInput.
Return type: char

info¶

Gets the info of this AcquisitionModifyInput.

Returns: The info of this AcquisitionModifyInput.
Return type: containers.Map

uid¶

Gets the uid of this AcquisitionModifyInput.

Returns: The uid of this AcquisitionModifyInput.
Return type: char

timestamp¶

Gets the timestamp of this AcquisitionModifyInput.

Returns: The timestamp of this AcquisitionModifyInput.
Return type: datetime

timezone¶

Gets the timezone of this AcquisitionModifyInput.

Returns: The timezone of this AcquisitionModifyInput.
Return type: char

AcquisitionNode¶

class AcquisitionNode¶

id¶

Gets the id of this AcquisitionNode.

Returns: The id of this AcquisitionNode.
Return type: char

parents¶

Gets the parents of this AcquisitionNode.

Returns: The parents of this AcquisitionNode.
Return type: AcquisitionParents

label¶

Gets the label of this AcquisitionNode.

Returns: The label of this AcquisitionNode.
Return type: char

session¶

Gets the session of this AcquisitionNode.

Returns: The session of this AcquisitionNode.
Return type: char

infoExists¶

Gets the infoExists of this AcquisitionNode.

Returns: The infoExists of this AcquisitionNode.
Return type: logical

info¶

Gets the info of this AcquisitionNode.

Returns: The info of this AcquisitionNode.
Return type: containers.Map

metadata¶

Gets the metadata of this AcquisitionNode.

Returns: The metadata of this AcquisitionNode.
Return type: containers.Map

uid¶

Gets the uid of this AcquisitionNode.

Returns: The uid of this AcquisitionNode.
Return type: char

timestamp¶

Gets the timestamp of this AcquisitionNode.

Returns: The timestamp of this AcquisitionNode.
Return type: datetime

timezone¶

Gets the timezone of this AcquisitionNode.

Returns: The timezone of this AcquisitionNode.
Return type: char

created¶

Gets the created of this AcquisitionNode.

Returns: The created of this AcquisitionNode.
Return type: datetime

modified¶

Gets the modified of this AcquisitionNode.

Returns: The modified of this AcquisitionNode.
Return type: datetime

revision¶

Gets the revision of this AcquisitionNode.

Returns: The revision of this AcquisitionNode.
Return type: integer

permissions¶

Gets the permissions of this AcquisitionNode.

Returns: The permissions of this AcquisitionNode.
Return type: RolePermission

tags¶

Gets the tags of this AcquisitionNode.

Returns: The tags of this AcquisitionNode.
Return type: vector[char]

notes¶

Gets the notes of this AcquisitionNode.

Returns: The notes of this AcquisitionNode.
Return type: Note

analyses¶

Gets the analyses of this AcquisitionNode.

Returns: The analyses of this AcquisitionNode.
Return type: Object

collections¶

Gets the collections of this AcquisitionNode.

Returns: The collections of this AcquisitionNode.
Return type: vector[char]

joinOrigin¶

Gets the joinOrigin of this AcquisitionNode.

Returns: The joinOrigin of this AcquisitionNode.
Return type: JoinOrigins

files¶

Gets the files of this AcquisitionNode.

Returns: The files of this AcquisitionNode.
Return type: FileOutput

copyOf¶

Gets the copyOf of this AcquisitionNode.

Returns: The copyOf of this AcquisitionNode.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this AcquisitionNode.

Returns: The originalCopyOf of this AcquisitionNode.
Return type: char

AcquisitionOutput¶

Representation of the acquisition to be returned Attributes: id (str): The id of the acquisition parents (AcquisitionParents): The mapping of parents to parent id for the acquisition label (str): The label of the acquisition session (str): The parent session info_exists (bool): Boolean value of info info (Optional[dict]): The custom info object of the acquisition uid (Optional[str]): The optional universal identification for the acquisition files (List[FileOutput]): The list of files attached to the acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp created (datetime.datetime): The time the acquisition was created in flywheel modified (datetime.datetime): The last modified time of the acquisition revision (int): The revision number of the acquisition permissions (List[RolePermission]): The list of permissions on the acquisition tags (List[str]): The list of tags notes (List[Note]): The list of notes analyses (List[Analysis]): The list of analyses children of the collections (List[str]): The collections the acquisition is a part of acquisition join_origin (Optional[JoinOrigins]): TODO: description copy_of (Optional[str]): Contains the id of the direct container copied from original_copy_of (Optional[str]): Contains the original ancestor container copied from

class AcquisitionOutput¶

Representation of the acquisition to be returned Attributes: id (str): The id of the acquisition parents (AcquisitionParents): The mapping of parents to parent id for the acquisition label (str): The label of the acquisition session (str): The parent session info_exists (bool): Boolean value of info info (Optional[dict]): The custom info object of the acquisition uid (Optional[str]): The optional universal identification for the acquisition files (List[FileOutput]): The list of files attached to the acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp created (datetime.datetime): The time the acquisition was created in flywheel modified (datetime.datetime): The last modified time of the acquisition revision (int): The revision number of the acquisition permissions (List[RolePermission]): The list of permissions on the acquisition tags (List[str]): The list of tags notes (List[Note]): The list of notes analyses (List[Analysis]): The list of analyses children of the collections (List[str]): The collections the acquisition is a part of acquisition join_origin (Optional[JoinOrigins]): TODO: description copy_of (Optional[str]): Contains the id of the direct container copied from original_copy_of (Optional[str]): Contains the original ancestor container copied from

id¶

Gets the id of this AcquisitionOutput.

Returns: The id of this AcquisitionOutput.
Return type: char

parents¶

Gets the parents of this AcquisitionOutput.

Returns: The parents of this AcquisitionOutput.
Return type: AcquisitionParents

label¶

Gets the label of this AcquisitionOutput.

Returns: The label of this AcquisitionOutput.
Return type: char

session¶

Gets the session of this AcquisitionOutput.

Returns: The session of this AcquisitionOutput.
Return type: char

infoExists¶

Gets the infoExists of this AcquisitionOutput.

Returns: The infoExists of this AcquisitionOutput.
Return type: logical

info¶

Gets the info of this AcquisitionOutput.

Returns: The info of this AcquisitionOutput.
Return type: containers.Map

metadata¶

Gets the metadata of this AcquisitionOutput.

Returns: The metadata of this AcquisitionOutput.
Return type: containers.Map

uid¶

Gets the uid of this AcquisitionOutput.

Returns: The uid of this AcquisitionOutput.
Return type: char

timestamp¶

Gets the timestamp of this AcquisitionOutput.

Returns: The timestamp of this AcquisitionOutput.
Return type: datetime

timezone¶

Gets the timezone of this AcquisitionOutput.

Returns: The timezone of this AcquisitionOutput.
Return type: char

created¶

Gets the created of this AcquisitionOutput.

Returns: The created of this AcquisitionOutput.
Return type: datetime

modified¶

Gets the modified of this AcquisitionOutput.

Returns: The modified of this AcquisitionOutput.
Return type: datetime

revision¶

Gets the revision of this AcquisitionOutput.

Returns: The revision of this AcquisitionOutput.
Return type: integer

permissions¶

Gets the permissions of this AcquisitionOutput.

Returns: The permissions of this AcquisitionOutput.
Return type: RolePermission

tags¶

Gets the tags of this AcquisitionOutput.

Returns: The tags of this AcquisitionOutput.
Return type: vector[char]

notes¶

Gets the notes of this AcquisitionOutput.

Returns: The notes of this AcquisitionOutput.
Return type: Note

analyses¶

Gets the analyses of this AcquisitionOutput.

Returns: The analyses of this AcquisitionOutput.
Return type: Object

collections¶

Gets the collections of this AcquisitionOutput.

Returns: The collections of this AcquisitionOutput.
Return type: vector[char]

joinOrigin¶

Gets the joinOrigin of this AcquisitionOutput.

Returns: The joinOrigin of this AcquisitionOutput.
Return type: JoinOrigins

files¶

Gets the files of this AcquisitionOutput.

Returns: The files of this AcquisitionOutput.
Return type: FileOutput

copyOf¶

Gets the copyOf of this AcquisitionOutput.

Returns: The copyOf of this AcquisitionOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this AcquisitionOutput.

Returns: The originalCopyOf of this AcquisitionOutput.
Return type: char

AcquisitionParents¶

class AcquisitionParents¶

group¶

Gets the group of this AcquisitionParents.

Returns: The group of this AcquisitionParents.
Return type: char

project¶

Gets the project of this AcquisitionParents.

Returns: The project of this AcquisitionParents.
Return type: char

subject¶

Gets the subject of this AcquisitionParents.

Returns: The subject of this AcquisitionParents.
Return type: char

session¶

Gets the session of this AcquisitionParents.

Returns: The session of this AcquisitionParents.
Return type: char

AcquisitionTemplateOptions¶

class AcquisitionTemplateOptions¶

minimum¶

Gets the minimum of this AcquisitionTemplateOptions.

Returns: The minimum of this AcquisitionTemplateOptions.
Return type: integer

maximum¶

Gets the maximum of this AcquisitionTemplateOptions.

Returns: The maximum of this AcquisitionTemplateOptions.
Return type: integer

files¶

Gets the files of this AcquisitionTemplateOptions.

Returns: The files of this AcquisitionTemplateOptions.
Return type: FileTemplateOptions

label¶

Gets the label of this AcquisitionTemplateOptions.

Returns: The label of this AcquisitionTemplateOptions.
Return type: char

tags¶

Gets the tags of this AcquisitionTemplateOptions.

Returns: The tags of this AcquisitionTemplateOptions.
Return type: char

AcquisitionUpsertInput¶

class AcquisitionUpsertInput¶

id¶

Gets the id of this AcquisitionUpsertInput.

Returns: The id of this AcquisitionUpsertInput.
Return type: char

uid¶

Gets the uid of this AcquisitionUpsertInput.

Returns: The uid of this AcquisitionUpsertInput.
Return type: char

routingField¶

Gets the routingField of this AcquisitionUpsertInput.

Returns: The routingField of this AcquisitionUpsertInput.
Return type: char

label¶

Gets the label of this AcquisitionUpsertInput.

Returns: The label of this AcquisitionUpsertInput.
Return type: char

timestamp¶

Gets the timestamp of this AcquisitionUpsertInput.

Returns: The timestamp of this AcquisitionUpsertInput.
Return type: datetime

timezone¶

Gets the timezone of this AcquisitionUpsertInput.

Returns: The timezone of this AcquisitionUpsertInput.
Return type: char

info¶

Gets the info of this AcquisitionUpsertInput.

Returns: The info of this AcquisitionUpsertInput.
Return type: containers.Map

AcquisitionUpsertOutput¶

class AcquisitionUpsertOutput¶

id¶

Gets the id of this AcquisitionUpsertOutput.

Returns: The id of this AcquisitionUpsertOutput.
Return type: char

uid¶

Gets the uid of this AcquisitionUpsertOutput.

Returns: The uid of this AcquisitionUpsertOutput.
Return type: char

label¶

Gets the label of this AcquisitionUpsertOutput.

Returns: The label of this AcquisitionUpsertOutput.
Return type: char

upsertResult¶

Gets the upsertResult of this AcquisitionUpsertOutput.

Returns: The upsertResult of this AcquisitionUpsertOutput.
Return type: char

Action¶

An enumeration.

class Action¶: An enumeration.

AdhocAnalysisInput¶

class AdhocAnalysisInput¶

label¶

Gets the label of this AdhocAnalysisInput.

Returns: The label of this AdhocAnalysisInput.
Return type: char

inputs¶

Gets the inputs of this AdhocAnalysisInput.

Returns: The inputs of this AdhocAnalysisInput.
Return type: FileReference

description¶

Gets the description of this AdhocAnalysisInput.

Returns: The description of this AdhocAnalysisInput.
Return type: char

info¶

Gets the info of this AdhocAnalysisInput.

Returns: The info of this AdhocAnalysisInput.
Return type: containers.Map

AllOfAcquisitionContainerOutputContainerType¶

class AllOfAcquisitionContainerOutputContainerType¶

AllOfAnalysisContainerOutputContainerType¶

class AllOfAnalysisContainerOutputContainerType¶

AllOfClassicBatchProposalInputOptionalInputPolicy¶

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.

class AllOfClassicBatchProposalInputOptionalInputPolicy¶: 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.

AllOfClassicBatchProposalInputPriority¶

class AllOfClassicBatchProposalInputPriority¶

AllOfClassicBatchProposalOutputOptionalInputPolicy¶

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.

class AllOfClassicBatchProposalOutputOptionalInputPolicy¶: 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.

AllOfColumnAccumulator¶

Accumulation operator for an a group by aggregation

class AllOfColumnAccumulator¶: Accumulation operator for an a group by aggregation

AllOfColumnType¶

The type that this value should be translated to (for typed output)

class AllOfColumnType¶: The type that this value should be translated to (for typed output)

AllOfConfigOutFeatures¶

class AllOfConfigOutFeatures¶

AllOfConfigOutWipFeatures¶

class AllOfConfigOutWipFeatures¶

AllOfContainerIdViewInputExecuteAndSaveContainerType¶

The type of container (e.g. session)

class AllOfContainerIdViewInputExecuteAndSaveContainerType¶: The type of container (e.g. session)

AllOfContainerPipelineInputMissingDataStrategy¶

What to do if missing data are encountered. Default is none, which is to say replace with an empty or null value.

class AllOfContainerPipelineInputMissingDataStrategy¶: What to do if missing data are encountered. Default is none, which is to say replace with an empty or null value.

AllOfCreateReportInputStatus¶

class AllOfCreateReportInputStatus¶

AllOfCurrentUserOutputAvatars¶

class AllOfCurrentUserOutputAvatars¶

AllOfDataViewColumnAliasType¶

The type that this value should be translated to (for typed output)

class AllOfDataViewColumnAliasType¶: The type that this value should be translated to (for typed output)

AllOfFileFileGroup¶

class AllOfFileFileGroup¶

AllOfGearDocumentCategory¶

class AllOfGearDocumentCategory¶

AllOfGearDocumentInputCategory¶

class AllOfGearDocumentInputCategory¶

AllOfGearDocumentLegacyInputCategory¶

class AllOfGearDocumentLegacyInputCategory¶

AllOfGearRuleInputPriority¶

class AllOfGearRuleInputPriority¶

AllOfGearRuleOutputPriority¶

class AllOfGearRuleOutputPriority¶

AllOfGearRulePriority¶

class AllOfGearRulePriority¶

AllOfGroupContainerOutputContainerType¶

class AllOfGroupContainerOutputContainerType¶

AllOfInputJobPriority¶

class AllOfInputJobPriority¶

AllOfJobAskResponseJobPriority¶

class AllOfJobAskResponseJobPriority¶

AllOfJobAskResponseJobTransitions¶

class AllOfJobAskResponseJobTransitions¶

AllOfJobAskXReturn¶

class AllOfJobAskXReturn¶

AllOfJobDetailPriority¶

class AllOfJobDetailPriority¶

AllOfJobDetailTransitions¶

class AllOfJobDetailTransitions¶

AllOfJobListOutputPriority¶

class AllOfJobListOutputPriority¶

AllOfJobListOutputTransitions¶

class AllOfJobListOutputTransitions¶

AllOfJobOutputPriority¶

class AllOfJobOutputPriority¶

AllOfJobOutputTransitions¶

class AllOfJobOutputTransitions¶

AllOfMultifactorAccountPreferredChannel¶

class AllOfMultifactorAccountPreferredChannel¶

AllOfProjectContainerOutputContainerType¶

class AllOfProjectContainerOutputContainerType¶

AllOfSearchQueryReturnType¶

Sets the type of search results to return

class AllOfSearchQueryReturnType¶: Sets the type of search results to return

AllOfSessionContainerOutputContainerType¶

class AllOfSessionContainerOutputContainerType¶

AllOfStorageStrategyConfigStorageStrategy¶

class AllOfStorageStrategyConfigStorageStrategy¶

AllOfSubjectContainerOutputContainerType¶

class AllOfSubjectContainerOutputContainerType¶

Analysis¶

class Analysis¶

AnalysisContainerOutput¶

Job is the job id

class AnalysisContainerOutput¶

Job is the job id

id¶

Gets the id of this AnalysisContainerOutput.

Returns: The id of this AnalysisContainerOutput.
Return type: char

label¶

Gets the label of this AnalysisContainerOutput.

Returns: The label of this AnalysisContainerOutput.
Return type: char

parent¶

Gets the parent of this AnalysisContainerOutput.

Returns: The parent of this AnalysisContainerOutput.
Return type: ContainerReference

parents¶

Gets the parents of this AnalysisContainerOutput.

Returns: The parents of this AnalysisContainerOutput.
Return type: AnalysisParents

created¶

Gets the created of this AnalysisContainerOutput.

Returns: The created of this AnalysisContainerOutput.
Return type: datetime

modified¶

Gets the modified of this AnalysisContainerOutput.

Returns: The modified of this AnalysisContainerOutput.
Return type: datetime

timestamp¶

Gets the timestamp of this AnalysisContainerOutput.

Returns: The timestamp of this AnalysisContainerOutput.
Return type: datetime

revision¶

Gets the revision of this AnalysisContainerOutput.

Returns: The revision of this AnalysisContainerOutput.
Return type: integer

inputs¶

Gets the inputs of this AnalysisContainerOutput.

Returns: The inputs of this AnalysisContainerOutput.
Return type: FileOutput

description¶

Gets the description of this AnalysisContainerOutput.

Returns: The description of this AnalysisContainerOutput.
Return type: char

info¶

Gets the info of this AnalysisContainerOutput.

Returns: The info of this AnalysisContainerOutput.
Return type: containers.Map

files¶

Gets the files of this AnalysisContainerOutput.

Returns: The files of this AnalysisContainerOutput.
Return type: FileOutput

notes¶

Gets the notes of this AnalysisContainerOutput.

Returns: The notes of this AnalysisContainerOutput.
Return type: Note

tags¶

Gets the tags of this AnalysisContainerOutput.

Returns: The tags of this AnalysisContainerOutput.
Return type: vector[char]

job¶

Gets the job of this AnalysisContainerOutput.

Returns: The job of this AnalysisContainerOutput.
Return type: char

gearInfo¶

Gets the gearInfo of this AnalysisContainerOutput.

Returns: The gearInfo of this AnalysisContainerOutput.
Return type: GearInfo

computeProviderId¶

Gets the computeProviderId of this AnalysisContainerOutput.

Returns: The computeProviderId of this AnalysisContainerOutput.
Return type: char

joinOrigin¶

Gets the joinOrigin of this AnalysisContainerOutput.

Returns: The joinOrigin of this AnalysisContainerOutput.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this AnalysisContainerOutput.

Returns: The copyOf of this AnalysisContainerOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this AnalysisContainerOutput.

Returns: The originalCopyOf of this AnalysisContainerOutput.
Return type: char

containerType¶

Gets the containerType of this AnalysisContainerOutput.

Returns: The containerType of this AnalysisContainerOutput.
Return type: AllOfAnalysisContainerOutputContainerType

AnalysisFilesCreateTicketOutput¶

class AnalysisFilesCreateTicketOutput¶

ticket¶

Gets the ticket of this AnalysisFilesCreateTicketOutput.

Returns: The ticket of this AnalysisFilesCreateTicketOutput.
Return type: char

filename¶

Gets the filename of this AnalysisFilesCreateTicketOutput.

Returns: The filename of this AnalysisFilesCreateTicketOutput.
Return type: char

fileCnt¶

Gets the fileCnt of this AnalysisFilesCreateTicketOutput.

Returns: The fileCnt of this AnalysisFilesCreateTicketOutput.
Return type: integer

size¶

Gets the size of this AnalysisFilesCreateTicketOutput.

Returns: The size of this AnalysisFilesCreateTicketOutput.
Return type: integer

AnalysisInput¶

Analysis input for creating ad-hoc analyses

class AnalysisInput¶

Analysis input for creating ad-hoc analyses

inputs¶

The set of inputs that this analysis is based on

Returns: The inputs of this AnalysisInput.
Return type: FileReference

description¶

Gets the description of this AnalysisInput.

Returns: The description of this AnalysisInput.
Return type: char

info¶

Gets the info of this AnalysisInput.

Returns: The info of this AnalysisInput.
Return type: CommonInfo

label¶

Application-specific label

Returns: The label of this AnalysisInput.
Return type: char

job¶

Gets the job of this AnalysisInput.

Returns: The job of this AnalysisInput.
Return type: Job

computeProviderId¶

Unique database ID

Returns: The computeProviderId of this AnalysisInput.
Return type: char

AnalysisInputLegacy¶

class AnalysisInputLegacy¶

AnalysisListOutput¶

Job is the job id

class AnalysisListOutput¶

Job is the job id

id¶

Gets the id of this AnalysisListOutput.

Returns: The id of this AnalysisListOutput.
Return type: char

label¶

Gets the label of this AnalysisListOutput.

Returns: The label of this AnalysisListOutput.
Return type: char

parent¶

Gets the parent of this AnalysisListOutput.

Returns: The parent of this AnalysisListOutput.
Return type: ContainerReference

parents¶

Gets the parents of this AnalysisListOutput.

Returns: The parents of this AnalysisListOutput.
Return type: AnalysisParents

created¶

Gets the created of this AnalysisListOutput.

Returns: The created of this AnalysisListOutput.
Return type: datetime

modified¶

Gets the modified of this AnalysisListOutput.

Returns: The modified of this AnalysisListOutput.
Return type: datetime

revision¶

Gets the revision of this AnalysisListOutput.

Returns: The revision of this AnalysisListOutput.
Return type: integer

tags¶

Gets the tags of this AnalysisListOutput.

Returns: The tags of this AnalysisListOutput.
Return type: vector[char]

inputs¶

Gets the inputs of this AnalysisListOutput.

Returns: The inputs of this AnalysisListOutput.
Return type: FileListOutput

description¶

Gets the description of this AnalysisListOutput.

Returns: The description of this AnalysisListOutput.
Return type: char

files¶

Gets the files of this AnalysisListOutput.

Returns: The files of this AnalysisListOutput.
Return type: FileListOutput

notes¶

Gets the notes of this AnalysisListOutput.

Returns: The notes of this AnalysisListOutput.
Return type: Note

job¶

Gets the job of this AnalysisListOutput.

Returns: The job of this AnalysisListOutput.
Return type: char

gearInfo¶

Gets the gearInfo of this AnalysisListOutput.

Returns: The gearInfo of this AnalysisListOutput.
Return type: GearInfo

computeProviderId¶

Gets the computeProviderId of this AnalysisListOutput.

Returns: The computeProviderId of this AnalysisListOutput.
Return type: char

joinOrigin¶

Gets the joinOrigin of this AnalysisListOutput.

Returns: The joinOrigin of this AnalysisListOutput.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this AnalysisListOutput.

Returns: The copyOf of this AnalysisListOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this AnalysisListOutput.

Returns: The originalCopyOf of this AnalysisListOutput.
Return type: char

timestamp¶

Gets the timestamp of this AnalysisListOutput.

Returns: The timestamp of this AnalysisListOutput.
Return type: datetime

info¶

Gets the info of this AnalysisListOutput.

Returns: The info of this AnalysisListOutput.
Return type: containers.Map

AnalysisListOutputInflatedJob¶

Job is the job

class AnalysisListOutputInflatedJob¶

Job is the job

id¶

Gets the id of this AnalysisListOutputInflatedJob.

Returns: The id of this AnalysisListOutputInflatedJob.
Return type: char

label¶

Gets the label of this AnalysisListOutputInflatedJob.

Returns: The label of this AnalysisListOutputInflatedJob.
Return type: char

parent¶

Gets the parent of this AnalysisListOutputInflatedJob.

Returns: The parent of this AnalysisListOutputInflatedJob.
Return type: ContainerReference

parents¶

Gets the parents of this AnalysisListOutputInflatedJob.

Returns: The parents of this AnalysisListOutputInflatedJob.
Return type: AnalysisParents

created¶

Gets the created of this AnalysisListOutputInflatedJob.

Returns: The created of this AnalysisListOutputInflatedJob.
Return type: datetime

modified¶

Gets the modified of this AnalysisListOutputInflatedJob.

Returns: The modified of this AnalysisListOutputInflatedJob.
Return type: datetime

revision¶

Gets the revision of this AnalysisListOutputInflatedJob.

Returns: The revision of this AnalysisListOutputInflatedJob.
Return type: integer

inputs¶

Gets the inputs of this AnalysisListOutputInflatedJob.

Returns: The inputs of this AnalysisListOutputInflatedJob.
Return type: FileListOutput

description¶

Gets the description of this AnalysisListOutputInflatedJob.

Returns: The description of this AnalysisListOutputInflatedJob.
Return type: char

tags¶

Gets the tags of this AnalysisListOutputInflatedJob.

Returns: The tags of this AnalysisListOutputInflatedJob.
Return type: vector[char]

files¶

Gets the files of this AnalysisListOutputInflatedJob.

Returns: The files of this AnalysisListOutputInflatedJob.
Return type: FileListOutput

notes¶

Gets the notes of this AnalysisListOutputInflatedJob.

Returns: The notes of this AnalysisListOutputInflatedJob.
Return type: Note

jobId¶

Gets the jobId of this AnalysisListOutputInflatedJob.

Returns: The jobId of this AnalysisListOutputInflatedJob.
Return type: char

job¶

Gets the job of this AnalysisListOutputInflatedJob.

Returns: The job of this AnalysisListOutputInflatedJob.
Return type: JobListOutput

gearInfo¶

Gets the gearInfo of this AnalysisListOutputInflatedJob.

Returns: The gearInfo of this AnalysisListOutputInflatedJob.
Return type: GearInfo

computeProviderId¶

Gets the computeProviderId of this AnalysisListOutputInflatedJob.

Returns: The computeProviderId of this AnalysisListOutputInflatedJob.
Return type: char

joinOrigin¶

Gets the joinOrigin of this AnalysisListOutputInflatedJob.

Returns: The joinOrigin of this AnalysisListOutputInflatedJob.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this AnalysisListOutputInflatedJob.

Returns: The copyOf of this AnalysisListOutputInflatedJob.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this AnalysisListOutputInflatedJob.

Returns: The originalCopyOf of this AnalysisListOutputInflatedJob.
Return type: char

AnalysisModifyInput¶

class AnalysisModifyInput¶

description¶

Gets the description of this AnalysisModifyInput.

Returns: The description of this AnalysisModifyInput.
Return type: char

label¶

Gets the label of this AnalysisModifyInput.

Returns: The label of this AnalysisModifyInput.
Return type: char

AnalysisNode¶

class AnalysisNode¶

id¶

Gets the id of this AnalysisNode.

Returns: The id of this AnalysisNode.
Return type: char

label¶

Gets the label of this AnalysisNode.

Returns: The label of this AnalysisNode.
Return type: char

parent¶

Gets the parent of this AnalysisNode.

Returns: The parent of this AnalysisNode.
Return type: ContainerReference

parents¶

Gets the parents of this AnalysisNode.

Returns: The parents of this AnalysisNode.
Return type: AnalysisParents

created¶

Gets the created of this AnalysisNode.

Returns: The created of this AnalysisNode.
Return type: datetime

modified¶

Gets the modified of this AnalysisNode.

Returns: The modified of this AnalysisNode.
Return type: datetime

timestamp¶

Gets the timestamp of this AnalysisNode.

Returns: The timestamp of this AnalysisNode.
Return type: datetime

revision¶

Gets the revision of this AnalysisNode.

Returns: The revision of this AnalysisNode.
Return type: integer

inputs¶

Gets the inputs of this AnalysisNode.

Returns: The inputs of this AnalysisNode.
Return type: FileOutput

description¶

Gets the description of this AnalysisNode.

Returns: The description of this AnalysisNode.
Return type: char

info¶

Gets the info of this AnalysisNode.

Returns: The info of this AnalysisNode.
Return type: containers.Map

files¶

Gets the files of this AnalysisNode.

Returns: The files of this AnalysisNode.
Return type: FileOutput

notes¶

Gets the notes of this AnalysisNode.

Returns: The notes of this AnalysisNode.
Return type: Note

tags¶

Gets the tags of this AnalysisNode.

Returns: The tags of this AnalysisNode.
Return type: vector[char]

job¶

Gets the job of this AnalysisNode.

Returns: The job of this AnalysisNode.
Return type: Job

gearInfo¶

Gets the gearInfo of this AnalysisNode.

Returns: The gearInfo of this AnalysisNode.
Return type: GearInfo

computeProviderId¶

Gets the computeProviderId of this AnalysisNode.

Returns: The computeProviderId of this AnalysisNode.
Return type: char

joinOrigin¶

Gets the joinOrigin of this AnalysisNode.

Returns: The joinOrigin of this AnalysisNode.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this AnalysisNode.

Returns: The copyOf of this AnalysisNode.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this AnalysisNode.

Returns: The originalCopyOf of this AnalysisNode.
Return type: char

AnalysisOutput¶

Job is the job id

class AnalysisOutput¶

Job is the job id

id¶

Gets the id of this AnalysisOutput.

Returns: The id of this AnalysisOutput.
Return type: char

label¶

Gets the label of this AnalysisOutput.

Returns: The label of this AnalysisOutput.
Return type: char

parent¶

Gets the parent of this AnalysisOutput.

Returns: The parent of this AnalysisOutput.
Return type: ContainerReference

parents¶

Gets the parents of this AnalysisOutput.

Returns: The parents of this AnalysisOutput.
Return type: AnalysisParents

created¶

Gets the created of this AnalysisOutput.

Returns: The created of this AnalysisOutput.
Return type: datetime

modified¶

Gets the modified of this AnalysisOutput.

Returns: The modified of this AnalysisOutput.
Return type: datetime

timestamp¶

Gets the timestamp of this AnalysisOutput.

Returns: The timestamp of this AnalysisOutput.
Return type: datetime

revision¶

Gets the revision of this AnalysisOutput.

Returns: The revision of this AnalysisOutput.
Return type: integer

inputs¶

Gets the inputs of this AnalysisOutput.

Returns: The inputs of this AnalysisOutput.
Return type: FileOutput

description¶

Gets the description of this AnalysisOutput.

Returns: The description of this AnalysisOutput.
Return type: char

info¶

Gets the info of this AnalysisOutput.

Returns: The info of this AnalysisOutput.
Return type: containers.Map

files¶

Gets the files of this AnalysisOutput.

Returns: The files of this AnalysisOutput.
Return type: FileOutput

notes¶

Gets the notes of this AnalysisOutput.

Returns: The notes of this AnalysisOutput.
Return type: Note

tags¶

Gets the tags of this AnalysisOutput.

Returns: The tags of this AnalysisOutput.
Return type: vector[char]

job¶

Gets the job of this AnalysisOutput.

Returns: The job of this AnalysisOutput.
Return type: Job

gearInfo¶

Gets the gearInfo of this AnalysisOutput.

Returns: The gearInfo of this AnalysisOutput.
Return type: GearInfo

computeProviderId¶

Gets the computeProviderId of this AnalysisOutput.

Returns: The computeProviderId of this AnalysisOutput.
Return type: char

joinOrigin¶

Gets the joinOrigin of this AnalysisOutput.

Returns: The joinOrigin of this AnalysisOutput.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this AnalysisOutput.

Returns: The copyOf of this AnalysisOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this AnalysisOutput.

Returns: The originalCopyOf of this AnalysisOutput.
Return type: char

AnalysisOutputInflatedJob¶

Job is the job

class AnalysisOutputInflatedJob¶

Job is the job

id¶

Gets the id of this AnalysisOutputInflatedJob.

Returns: The id of this AnalysisOutputInflatedJob.
Return type: char

label¶

Gets the label of this AnalysisOutputInflatedJob.

Returns: The label of this AnalysisOutputInflatedJob.
Return type: char

parent¶

Gets the parent of this AnalysisOutputInflatedJob.

Returns: The parent of this AnalysisOutputInflatedJob.
Return type: ContainerReference

parents¶

Gets the parents of this AnalysisOutputInflatedJob.

Returns: The parents of this AnalysisOutputInflatedJob.
Return type: AnalysisParents

created¶

Gets the created of this AnalysisOutputInflatedJob.

Returns: The created of this AnalysisOutputInflatedJob.
Return type: datetime

modified¶

Gets the modified of this AnalysisOutputInflatedJob.

Returns: The modified of this AnalysisOutputInflatedJob.
Return type: datetime

revision¶

Gets the revision of this AnalysisOutputInflatedJob.

Returns: The revision of this AnalysisOutputInflatedJob.
Return type: integer

inputs¶

Gets the inputs of this AnalysisOutputInflatedJob.

Returns: The inputs of this AnalysisOutputInflatedJob.
Return type: FileOutput

description¶

Gets the description of this AnalysisOutputInflatedJob.

Returns: The description of this AnalysisOutputInflatedJob.
Return type: char

info¶

Gets the info of this AnalysisOutputInflatedJob.

Returns: The info of this AnalysisOutputInflatedJob.
Return type: containers.Map

files¶

Gets the files of this AnalysisOutputInflatedJob.

Returns: The files of this AnalysisOutputInflatedJob.
Return type: FileOutput

notes¶

Gets the notes of this AnalysisOutputInflatedJob.

Returns: The notes of this AnalysisOutputInflatedJob.
Return type: Note

tags¶

Gets the tags of this AnalysisOutputInflatedJob.

Returns: The tags of this AnalysisOutputInflatedJob.
Return type: vector[char]

jobId¶

Gets the jobId of this AnalysisOutputInflatedJob.

Returns: The jobId of this AnalysisOutputInflatedJob.
Return type: char

job¶

Gets the job of this AnalysisOutputInflatedJob.

Returns: The job of this AnalysisOutputInflatedJob.
Return type: JobOutput

gearInfo¶

Gets the gearInfo of this AnalysisOutputInflatedJob.

Returns: The gearInfo of this AnalysisOutputInflatedJob.
Return type: GearInfo

computeProviderId¶

Gets the computeProviderId of this AnalysisOutputInflatedJob.

Returns: The computeProviderId of this AnalysisOutputInflatedJob.
Return type: char

joinOrigin¶

Gets the joinOrigin of this AnalysisOutputInflatedJob.

Returns: The joinOrigin of this AnalysisOutputInflatedJob.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this AnalysisOutputInflatedJob.

Returns: The copyOf of this AnalysisOutputInflatedJob.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this AnalysisOutputInflatedJob.

Returns: The originalCopyOf of this AnalysisOutputInflatedJob.
Return type: char

AnalysisParents¶

class AnalysisParents¶

group¶

Gets the group of this AnalysisParents.

Returns: The group of this AnalysisParents.
Return type: char

project¶

Gets the project of this AnalysisParents.

Returns: The project of this AnalysisParents.
Return type: char

subject¶

Gets the subject of this AnalysisParents.

Returns: The subject of this AnalysisParents.
Return type: char

session¶

Gets the session of this AnalysisParents.

Returns: The session of this AnalysisParents.
Return type: char

acquisition¶

Gets the acquisition of this AnalysisParents.

Returns: The acquisition of this AnalysisParents.
Return type: char

AnalysisUpdate¶

class AnalysisUpdate¶

AnyOfAcquisitionContainerOutputAnalysesItems¶

class AnyOfAcquisitionContainerOutputAnalysesItems¶

AnyOfAcquisitionListOutputAnalysesItems¶

class AnyOfAcquisitionListOutputAnalysesItems¶

AnyOfAcquisitionOutputAnalysesItems¶

class AnyOfAcquisitionOutputAnalysesItems¶

AnyOfClassicBatchProposalOutputAmbiguous¶

class AnyOfClassicBatchProposalOutputAmbiguous¶

AnyOfClassicBatchProposalOutputMatched¶

class AnyOfClassicBatchProposalOutputMatched¶

AnyOfClassicBatchProposalOutputNotMatched¶

class AnyOfClassicBatchProposalOutputNotMatched¶

AnyOfCollectionWithStatsAnalysesItems¶

class AnyOfCollectionWithStatsAnalysesItems¶

AnyOfGearRuleInputFixedInputsItems¶

class AnyOfGearRuleInputFixedInputsItems¶

AnyOfGearRuleModifyInputFixedInputsItems¶

class AnyOfGearRuleModifyInputFixedInputsItems¶

AnyOfIngressSiteSettingsDeidProfile¶

class AnyOfIngressSiteSettingsDeidProfile¶

AnyOfJobDetailParents¶

class AnyOfJobDetailParents¶

AnyOfProjectContainerOutputAnalysesItems¶

class AnyOfProjectContainerOutputAnalysesItems¶

AnyOfProjectListOutputAnalysesItems¶

class AnyOfProjectListOutputAnalysesItems¶

AnyOfProjectOutputAnalysesItems¶

class AnyOfProjectOutputAnalysesItems¶

AnyOfProjectSettingsInputDeidProfile¶

class AnyOfProjectSettingsInputDeidProfile¶

AnyOfProviderConfig¶

class AnyOfProviderConfig¶

AnyOfProviderCreds¶

class AnyOfProviderCreds¶

AnyOfRoleOutputActionsItems¶

class AnyOfRoleOutputActionsItems¶

AnyOfSearchQuerySize¶

class AnyOfSearchQuerySize¶

AnyOfSessionContainerOutputAnalysesItems¶

class AnyOfSessionContainerOutputAnalysesItems¶

AnyOfSessionInputSubject¶

class AnyOfSessionInputSubject¶

AnyOfSessionListOutputAnalysesItems¶

class AnyOfSessionListOutputAnalysesItems¶

AnyOfSessionModifySubject¶

class AnyOfSessionModifySubject¶

AnyOfSessionOutputAnalysesItems¶

class AnyOfSessionOutputAnalysesItems¶

AnyOfSubjectContainerOutputAnalysesItems¶

class AnyOfSubjectContainerOutputAnalysesItems¶

AnyOfSubjectOutputAnalysesItems¶

class AnyOfSubjectOutputAnalysesItems¶

AnyOfSubjectOutputForListAnalysesItems¶

class AnyOfSubjectOutputForListAnalysesItems¶

AnyOfUploadTicketOutputUrls¶

class AnyOfUploadTicketOutputUrls¶

ApiKeyInputWithOptionalLabel¶

class ApiKeyInputWithOptionalLabel¶

label¶

Gets the label of this ApiKeyInputWithOptionalLabel.

Returns: The label of this ApiKeyInputWithOptionalLabel.
Return type: char

expiresAt¶

Gets the expiresAt of this ApiKeyInputWithOptionalLabel.

Returns: The expiresAt of this ApiKeyInputWithOptionalLabel.
Return type: datetime

ApiKeyOutput¶

class ApiKeyOutput¶

label¶

Gets the label of this ApiKeyOutput.

Returns: The label of this ApiKeyOutput.
Return type: char

key¶

Gets the key of this ApiKeyOutput.

Returns: The key of this ApiKeyOutput.
Return type: char

created¶

Gets the created of this ApiKeyOutput.

Returns: The created of this ApiKeyOutput.
Return type: datetime

lastUsed¶

Gets the lastUsed of this ApiKeyOutput.

Returns: The lastUsed of this ApiKeyOutput.
Return type: datetime

unencryptedSecret¶

Gets the unencryptedSecret of this ApiKeyOutput.

Returns: The unencryptedSecret of this ApiKeyOutput.
Return type: char

expiresAt¶

Gets the expiresAt of this ApiKeyOutput.

Returns: The expiresAt of this ApiKeyOutput.
Return type: datetime

AsStorage¶

class AsStorage¶

bucket¶

Gets the bucket of this AsStorage.

Returns: The bucket of this AsStorage.
Return type: char

path¶

Gets the path of this AsStorage.

Returns: The path of this AsStorage.
Return type: char

signedUrls¶

Gets the signedUrls of this AsStorage.

Returns: The signedUrls of this AsStorage.
Return type: logical

region¶

Gets the region of this AsStorage.

Returns: The region of this AsStorage.
Return type: char

configType¶

Gets the configType of this AsStorage.

Returns: The configType of this AsStorage.
Return type: char

configClass¶

Gets the configClass of this AsStorage.

Returns: The configClass of this AsStorage.
Return type: char

AuditTrailReport¶

class AuditTrailReport¶

id¶

Gets the id of this AuditTrailReport.

Returns: The id of this AuditTrailReport.
Return type: char

origin¶

Gets the origin of this AuditTrailReport.

Returns: The origin of this AuditTrailReport.
Return type: Origin

projectId¶

Gets the projectId of this AuditTrailReport.

Returns: The projectId of this AuditTrailReport.
Return type: char

subjectIds¶

Gets the subjectIds of this AuditTrailReport.

Returns: The subjectIds of this AuditTrailReport.
Return type: vector[char]

label¶

Gets the label of this AuditTrailReport.

Returns: The label of this AuditTrailReport.
Return type: char

status¶

Gets the status of this AuditTrailReport.

Returns: The status of this AuditTrailReport.
Return type: AuditTrailReportStatus

created¶

Gets the created of this AuditTrailReport.

Returns: The created of this AuditTrailReport.
Return type: datetime

finished¶

Gets the finished of this AuditTrailReport.

Returns: The finished of this AuditTrailReport.
Return type: datetime

revision¶

Gets the revision of this AuditTrailReport.

Returns: The revision of this AuditTrailReport.
Return type: integer

deleted¶

Gets the deleted of this AuditTrailReport.

Returns: The deleted of this AuditTrailReport.
Return type: datetime

error¶

Gets the error of this AuditTrailReport.

Returns: The error of this AuditTrailReport.
Return type: char

celeryTaskId¶

Gets the celeryTaskId of this AuditTrailReport.

Returns: The celeryTaskId of this AuditTrailReport.
Return type: char

size¶

Gets the size of this AuditTrailReport.

Returns: The size of this AuditTrailReport.
Return type: integer

AuditTrailReportStatus¶

An enumeration.

class AuditTrailReportStatus¶: An enumeration.

Auth0AuthOut¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

class Auth0AuthOut¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

clientId¶

Gets the clientId of this Auth0AuthOut.

Returns: The clientId of this Auth0AuthOut.
Return type: char

domain¶

Gets the domain of this Auth0AuthOut.

Returns: The domain of this Auth0AuthOut.
Return type: char

audience¶

Gets the audience of this Auth0AuthOut.

Returns: The audience of this Auth0AuthOut.
Return type: vector[char]

claimNamespace¶

Gets the claimNamespace of this Auth0AuthOut.

Returns: The claimNamespace of this Auth0AuthOut.
Return type: char

jwks¶

Gets the jwks of this Auth0AuthOut.

Returns: The jwks of this Auth0AuthOut.
Return type: containers.Map[String, containers.Map]

options¶

Gets the options of this Auth0AuthOut.

Returns: The options of this Auth0AuthOut.
Return type: Auth0OptionsOut

Auth0OptionsOut¶

class Auth0OptionsOut¶

onboarding¶

Gets the onboarding of this Auth0OptionsOut.

Returns: The onboarding of this Auth0OptionsOut.
Return type: logical

onboardingEppn¶

Gets the onboardingEppn of this Auth0OptionsOut.

Returns: The onboardingEppn of this Auth0OptionsOut.
Return type: logical

fetchProfile¶

Gets the fetchProfile of this Auth0OptionsOut.

Returns: The fetchProfile of this Auth0OptionsOut.
Return type: logical

limitSocialDomains¶

Gets the limitSocialDomains of this Auth0OptionsOut.

Returns: The limitSocialDomains of this Auth0OptionsOut.
Return type: logical

socialDomainWhitelist¶

Gets the socialDomainWhitelist of this Auth0OptionsOut.

Returns: The socialDomainWhitelist of this Auth0OptionsOut.
Return type: vector[char]

academicIdpWhitelist¶

Gets the academicIdpWhitelist of this Auth0OptionsOut.

Returns: The academicIdpWhitelist of this Auth0OptionsOut.
Return type: vector[char]

federatedLogoutSubs¶

Gets the federatedLogoutSubs of this Auth0OptionsOut.

Returns: The federatedLogoutSubs of this Auth0OptionsOut.
Return type: vector[char]

AuthOut¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

class AuthOut¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

google¶

Gets the google of this AuthOut.

Returns: The google of this AuthOut.
Return type: GoogleAuthOut

auth0¶

Gets the auth0 of this AuthOut.

Returns: The auth0 of this AuthOut.
Return type: Auth0AuthOut

basic¶

Gets the basic of this AuthOut.

Returns: The basic of this AuthOut.
Return type: containers.Map

cas¶

Gets the cas of this AuthOut.

Returns: The cas of this AuthOut.
Return type: containers.Map

ldap¶

Gets the ldap of this AuthOut.

Returns: The ldap of this AuthOut.
Return type: containers.Map

mail¶

Gets the mail of this AuthOut.

Returns: The mail of this AuthOut.
Return type: containers.Map

saml¶

Gets the saml of this AuthOut.

Returns: The saml of this AuthOut.
Return type: containers.Map

wechat¶

Gets the wechat of this AuthOut.

Returns: The wechat of this AuthOut.
Return type: containers.Map

AuthSessionOutput¶

class AuthSessionOutput¶

origin¶

Gets the origin of this AuthSessionOutput.

Returns: The origin of this AuthSessionOutput.
Return type: Origin

userId¶

Gets the userId of this AuthSessionOutput.

Returns: The userId of this AuthSessionOutput.
Return type: char

userIsAdmin¶

Gets the userIsAdmin of this AuthSessionOutput.

Returns: The userIsAdmin of this AuthSessionOutput.
Return type: logical

isDevice¶

Gets the isDevice of this AuthSessionOutput.

Returns: The isDevice of this AuthSessionOutput.
Return type: logical

roles¶

Gets the roles of this AuthSessionOutput.

Returns: The roles of this AuthSessionOutput.
Return type: RoleType

Avatars¶

class Avatars¶

gravatar¶

Gets the gravatar of this Avatars.

Returns: The gravatar of this Avatars.
Return type: char

provider¶

Gets the provider of this Avatars.

Returns: The provider of this Avatars.
Return type: char

custom¶

Gets the custom of this Avatars.

Returns: The custom of this Avatars.
Return type: char

AwsCreds¶

Creds for AWS can be excluded and then they are loaded from the ENV

class AwsCreds¶

Creds for AWS can be excluded and then they are loaded from the ENV

awsAccessKeyId¶

Gets the awsAccessKeyId of this AwsCreds.

Returns: The awsAccessKeyId of this AwsCreds.
Return type: char

awsSecretAccessKey¶

Gets the awsSecretAccessKey of this AwsCreds.

Returns: The awsSecretAccessKey of this AwsCreds.
Return type: char

AwsStorage¶

class AwsStorage¶

region¶

Gets the region of this AwsStorage.

Returns: The region of this AwsStorage.
Return type: char

bucket¶

Gets the bucket of this AwsStorage.

Returns: The bucket of this AwsStorage.
Return type: char

path¶

Gets the path of this AwsStorage.

Returns: The path of this AwsStorage.
Return type: char

zone¶

Gets the zone of this AwsStorage.

Returns: The zone of this AwsStorage.
Return type: char

endpointUrl¶

Gets the endpointUrl of this AwsStorage.

Returns: The endpointUrl of this AwsStorage.
Return type: char

configType¶

Gets the configType of this AwsStorage.

Returns: The configType of this AwsStorage.
Return type: char

configClass¶

Gets the configClass of this AwsStorage.

Returns: The configClass of this AwsStorage.
Return type: char

AzureCreds¶

Creds for Azure can be excluded and then they are loaded from the ENV

class AzureCreds¶

Creds for Azure can be excluded and then they are loaded from the ENV

azureAccountName¶

Gets the azureAccountName of this AzureCreds.

Returns: The azureAccountName of this AzureCreds.
Return type: char

azureAccountKey¶

Gets the azureAccountKey of this AzureCreds.

Returns: The azureAccountKey of this AzureCreds.
Return type: char

BaseAET¶

class BaseAET¶

id¶

Gets the id of this BaseAET.

Returns: The id of this BaseAET.
Return type: char

created¶

Gets the created of this BaseAET.

Returns: The created of this BaseAET.
Return type: datetime

aet¶

DICOM Application Entity Title

Returns: The aet of this BaseAET.
Return type: char

creator¶

Database ID of a user

Returns: The creator of this BaseAET.
Return type: char

BaseCompute¶

class BaseCompute¶

queueThreshold¶

Gets the queueThreshold of this BaseCompute.

Returns: The queueThreshold of this BaseCompute.
Return type: integer

maxCompute¶

Gets the maxCompute of this BaseCompute.

Returns: The maxCompute of this BaseCompute.
Return type: integer

machineType¶

Gets the machineType of this BaseCompute.

Returns: The machineType of this BaseCompute.
Return type: char

diskSize¶

Gets the diskSize of this BaseCompute.

Returns: The diskSize of this BaseCompute.
Return type: integer

swapSize¶

Gets the swapSize of this BaseCompute.

Returns: The swapSize of this BaseCompute.
Return type: char

preemptible¶

Gets the preemptible of this BaseCompute.

Returns: The preemptible of this BaseCompute.
Return type: logical

zone¶

Gets the zone of this BaseCompute.

Returns: The zone of this BaseCompute.
Return type: char

region¶

Gets the region of this BaseCompute.

Returns: The region of this BaseCompute.
Return type: char

tags¶

Gets the tags of this BaseCompute.

Returns: The tags of this BaseCompute.
Return type: containers.Map

configType¶

Gets the configType of this BaseCompute.

Returns: The configType of this BaseCompute.
Return type: char

configClass¶

Gets the configClass of this BaseCompute.

Returns: The configClass of this BaseCompute.
Return type: char

Batch¶

class Batch¶

id¶

Unique database ID

Returns: The id of this Batch.
Return type: char

gearId¶

Gets the gearId of this Batch.

Returns: The gearId of this Batch.
Return type: char

state¶

Gets the state of this Batch.

Returns: The state of this Batch.
Return type: JobState

origin¶

Gets the origin of this Batch.

Returns: The origin of this Batch.
Return type: Origin

config¶

Gets the config of this Batch.

Returns: The config of this Batch.
Return type: containers.Map

jobs¶

Gets the jobs of this Batch.

Returns: The jobs of this Batch.
Return type: vector[char]

created¶

Creation time (automatically set)

Returns: The created of this Batch.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Batch.
Return type: datetime

BatchJobAnalysisInput¶

Analysis input for creating ad-hoc analyses

class BatchJobAnalysisInput¶

Analysis input for creating ad-hoc analyses

job¶

Gets the job of this BatchJobAnalysisInput.

Returns: The job of this BatchJobAnalysisInput.
Return type: InputJob

label¶

Application-specific label

Returns: The label of this BatchJobAnalysisInput.
Return type: char

description¶

The set of inputs that this analysis is based on

Returns: The description of this BatchJobAnalysisInput.
Return type: char

computeProviderId¶

Unique database ID

Returns: The computeProviderId of this BatchJobAnalysisInput.
Return type: char

info¶

Gets the info of this BatchJobAnalysisInput.

Returns: The info of this BatchJobAnalysisInput.
Return type: containers.Map

BatchProposal¶

class BatchProposal¶

BatchProposalInput¶

class BatchProposalInput¶

Body¶

class Body¶

firstName¶

First name

Returns: The firstName of this Body.
Return type: char

lastName¶

Last name

Returns: The lastName of this Body.
Return type: char

dateOfBirth¶

Date of birth in YYYY-MM-DD format

Returns: The dateOfBirth of this Body.
Return type: char

patientId¶

Patient id

Returns: The patientId of this Body.
Return type: char

usePatientId¶

Use patient ID for identification or first name, last name, DOB

Returns: The usePatientId of this Body.
Return type: logical

BodyRegenerateKeyApiDevicesDeviceIdKeyPost¶

class BodyRegenerateKeyApiDevicesDeviceIdKeyPost¶

BodyRegion¶

An enumeration.

class BodyRegion¶: An enumeration.

Bookmark¶

class Bookmark¶

label¶

Gets the label of this Bookmark.

Returns: The label of this Bookmark.
Return type: char

url¶

Gets the url of this Bookmark.

Returns: The url of this Bookmark.
Return type: char

BulkMoveInput¶

class BulkMoveInput¶

destinationContainerType¶

Gets the destinationContainerType of this BulkMoveInput.

Returns: The destinationContainerType of this BulkMoveInput.
Return type: DestinationContainerType

sources¶

Gets the sources of this BulkMoveInput.

Returns: The sources of this BulkMoveInput.
Return type: vector[char]

destinations¶

Gets the destinations of this BulkMoveInput.

Returns: The destinations of this BulkMoveInput.
Return type: vector[char]

conflictMode¶

Gets the conflictMode of this BulkMoveInput.

Returns: The conflictMode of this BulkMoveInput.
Return type: ConflictTypes

removeSource¶

Gets the removeSource of this BulkMoveInput.

Returns: The removeSource of this BulkMoveInput.
Return type: logical

BulkMoveSessions¶

class BulkMoveSessions¶

CancelledBatchOutput¶

class CancelledBatchOutput¶

numberCancelled¶

Gets the numberCancelled of this CancelledBatchOutput.

Returns: The numberCancelled of this CancelledBatchOutput.
Return type: integer

CatalogListOutput¶

class CatalogListOutput¶

id¶

Gets the id of this CatalogListOutput.

Returns: The id of this CatalogListOutput.
Return type: char

label¶

Gets the label of this CatalogListOutput.

Returns: The label of this CatalogListOutput.
Return type: char

tags¶

Gets the tags of this CatalogListOutput.

Returns: The tags of this CatalogListOutput.
Return type: vector[char]

therapeuticAreas¶

Gets the therapeuticAreas of this CatalogListOutput.

Returns: The therapeuticAreas of this CatalogListOutput.
Return type: TherapeuticArea

bodyRegions¶

Gets the bodyRegions of this CatalogListOutput.

Returns: The bodyRegions of this CatalogListOutput.
Return type: BodyRegion

organSystems¶

Gets the organSystems of this CatalogListOutput.

Returns: The organSystems of this CatalogListOutput.
Return type: OrganSystem

projectInstitutions¶

Gets the projectInstitutions of this CatalogListOutput.

Returns: The projectInstitutions of this CatalogListOutput.
Return type: ProjectInstitution

projectContacts¶

Gets the projectContacts of this CatalogListOutput.

Returns: The projectContacts of this CatalogListOutput.
Return type: ProjectContact

summary¶

Gets the summary of this CatalogListOutput.

Returns: The summary of this CatalogListOutput.
Return type: char

stats¶

Gets the stats of this CatalogListOutput.

Returns: The stats of this CatalogListOutput.
Return type: ProjectStats

Channel¶

An enumeration.

class Channel¶: An enumeration.

ClassicBatchJobOutput¶

class ClassicBatchJobOutput¶

id¶

Gets the id of this ClassicBatchJobOutput.

Returns: The id of this ClassicBatchJobOutput.
Return type: char

gearId¶

Gets the gearId of this ClassicBatchJobOutput.

Returns: The gearId of this ClassicBatchJobOutput.
Return type: char

state¶

Gets the state of this ClassicBatchJobOutput.

Returns: The state of this ClassicBatchJobOutput.
Return type: JobState

origin¶

Gets the origin of this ClassicBatchJobOutput.

Returns: The origin of this ClassicBatchJobOutput.
Return type: Origin

config¶

Gets the config of this ClassicBatchJobOutput.

Returns: The config of this ClassicBatchJobOutput.
Return type: containers.Map

jobs¶

Gets the jobs of this ClassicBatchJobOutput.

Returns: The jobs of this ClassicBatchJobOutput.
Return type: vector[char]

created¶

Gets the created of this ClassicBatchJobOutput.

Returns: The created of this ClassicBatchJobOutput.
Return type: datetime

modified¶

Gets the modified of this ClassicBatchJobOutput.

Returns: The modified of this ClassicBatchJobOutput.
Return type: datetime

ClassicBatchJobOutputInflatedJobs¶

class ClassicBatchJobOutputInflatedJobs¶

id¶

Gets the id of this ClassicBatchJobOutputInflatedJobs.

Returns: The id of this ClassicBatchJobOutputInflatedJobs.
Return type: char

gearId¶

Gets the gearId of this ClassicBatchJobOutputInflatedJobs.

Returns: The gearId of this ClassicBatchJobOutputInflatedJobs.
Return type: char

state¶

Gets the state of this ClassicBatchJobOutputInflatedJobs.

Returns: The state of this ClassicBatchJobOutputInflatedJobs.
Return type: JobState

origin¶

Gets the origin of this ClassicBatchJobOutputInflatedJobs.

Returns: The origin of this ClassicBatchJobOutputInflatedJobs.
Return type: Origin

config¶

Gets the config of this ClassicBatchJobOutputInflatedJobs.

Returns: The config of this ClassicBatchJobOutputInflatedJobs.
Return type: containers.Map

tags¶

Gets the tags of this ClassicBatchJobOutputInflatedJobs.

Returns: The tags of this ClassicBatchJobOutputInflatedJobs.
Return type: vector[char]

jobs¶

Gets the jobs of this ClassicBatchJobOutputInflatedJobs.

Returns: The jobs of this ClassicBatchJobOutputInflatedJobs.
Return type: Job

created¶

Gets the created of this ClassicBatchJobOutputInflatedJobs.

Returns: The created of this ClassicBatchJobOutputInflatedJobs.
Return type: datetime

modified¶

Gets the modified of this ClassicBatchJobOutputInflatedJobs.

Returns: The modified of this ClassicBatchJobOutputInflatedJobs.
Return type: datetime

ClassicBatchProposalInput¶

class ClassicBatchProposalInput¶

gearId¶

Gets the gearId of this ClassicBatchProposalInput.

Returns: The gearId of this ClassicBatchProposalInput.
Return type: char

targets¶

Gets the targets of this ClassicBatchProposalInput.

Returns: The targets of this ClassicBatchProposalInput.
Return type: ContainerReference

targetContext¶

Gets the targetContext of this ClassicBatchProposalInput.

Returns: The targetContext of this ClassicBatchProposalInput.
Return type: ContainerReference

priority¶

Gets the priority of this ClassicBatchProposalInput.

Returns: The priority of this ClassicBatchProposalInput.
Return type: AllOfClassicBatchProposalInputPriority

config¶

Gets the config of this ClassicBatchProposalInput.

Returns: The config of this ClassicBatchProposalInput.
Return type: containers.Map

tags¶

Array of application-specific tags

Returns: The tags of this ClassicBatchProposalInput.
Return type: vector[char]

analysis¶

Gets the analysis of this ClassicBatchProposalInput.

Returns: The analysis of this ClassicBatchProposalInput.
Return type: BatchJobAnalysisInput

optionalInputPolicy¶

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 optionalInputPolicy of this ClassicBatchProposalInput.
Return type: AllOfClassicBatchProposalInputOptionalInputPolicy

computeProviderId¶

Unique database ID

Returns: The computeProviderId of this ClassicBatchProposalInput.
Return type: char

ClassicBatchProposalOutput¶

class ClassicBatchProposalOutput¶

id¶

Unique database ID

Returns: The id of this ClassicBatchProposalOutput.
Return type: char

gearId¶

Gets the gearId of this ClassicBatchProposalOutput.

Returns: The gearId of this ClassicBatchProposalOutput.
Return type: char

state¶

Gets the state of this ClassicBatchProposalOutput.

Returns: The state of this ClassicBatchProposalOutput.
Return type: JobState

origin¶

Gets the origin of this ClassicBatchProposalOutput.

Returns: The origin of this ClassicBatchProposalOutput.
Return type: Origin

config¶

Gets the config of this ClassicBatchProposalOutput.

Returns: The config of this ClassicBatchProposalOutput.
Return type: containers.Map

created¶

Creation time (automatically set)

Returns: The created of this ClassicBatchProposalOutput.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ClassicBatchProposalOutput.
Return type: datetime

optionalInputPolicy¶

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 optionalInputPolicy of this ClassicBatchProposalOutput.
Return type: AllOfClassicBatchProposalOutputOptionalInputPolicy

ambiguous¶

Gets the ambiguous of this ClassicBatchProposalOutput.

Returns: The ambiguous of this ClassicBatchProposalOutput.
Return type: AnyOfClassicBatchProposalOutputAmbiguous

notMatched¶

Gets the notMatched of this ClassicBatchProposalOutput.

Returns: The notMatched of this ClassicBatchProposalOutput.
Return type: AnyOfClassicBatchProposalOutputNotMatched

matched¶

Gets the matched of this ClassicBatchProposalOutput.

Returns: The matched of this ClassicBatchProposalOutput.
Return type: AnyOfClassicBatchProposalOutputMatched

improperPermissions¶

Unique database IDs

Returns: The improperPermissions of this ClassicBatchProposalOutput.
Return type: vector[char]

Cohort¶

An enumeration.

class Cohort¶: An enumeration.

Collection¶

class Collection¶

CollectionContainerOutput¶

class CollectionContainerOutput¶

created¶

Gets the created of this CollectionContainerOutput.

Returns: The created of this CollectionContainerOutput.
Return type: datetime

modified¶

Gets the modified of this CollectionContainerOutput.

Returns: The modified of this CollectionContainerOutput.
Return type: datetime

label¶

Gets the label of this CollectionContainerOutput.

Returns: The label of this CollectionContainerOutput.
Return type: char

description¶

Gets the description of this CollectionContainerOutput.

Returns: The description of this CollectionContainerOutput.
Return type: char

info¶

Gets the info of this CollectionContainerOutput.

Returns: The info of this CollectionContainerOutput.
Return type: containers.Map

id¶

Gets the id of this CollectionContainerOutput.

Returns: The id of this CollectionContainerOutput.
Return type: char

curator¶

Gets the curator of this CollectionContainerOutput.

Returns: The curator of this CollectionContainerOutput.
Return type: char

revision¶

Gets the revision of this CollectionContainerOutput.

Returns: The revision of this CollectionContainerOutput.
Return type: integer

notes¶

Gets the notes of this CollectionContainerOutput.

Returns: The notes of this CollectionContainerOutput.
Return type: Note

tags¶

Gets the tags of this CollectionContainerOutput.

Returns: The tags of this CollectionContainerOutput.
Return type: vector[char]

analyses¶

Gets the analyses of this CollectionContainerOutput.

Returns: The analyses of this CollectionContainerOutput.
Return type: Analysis

permissions¶

Gets the permissions of this CollectionContainerOutput.

Returns: The permissions of this CollectionContainerOutput.
Return type: AccessPermission

joinOrigin¶

Gets the joinOrigin of this CollectionContainerOutput.

Returns: The joinOrigin of this CollectionContainerOutput.
Return type: JoinOrigins

files¶

Gets the files of this CollectionContainerOutput.

Returns: The files of this CollectionContainerOutput.
Return type: FileOutput

containerType¶

Gets the containerType of this CollectionContainerOutput.

Returns: The containerType of this CollectionContainerOutput.
Return type: char

CollectionInput¶

class CollectionInput¶

label¶

Gets the label of this CollectionInput.

Returns: The label of this CollectionInput.
Return type: char

info¶

Gets the info of this CollectionInput.

Returns: The info of this CollectionInput.
Return type: containers.Map

description¶

Gets the description of this CollectionInput.

Returns: The description of this CollectionInput.
Return type: char

CollectionInputWithContents¶

class CollectionInputWithContents¶

contents¶

Gets the contents of this CollectionInputWithContents.

Returns: The contents of this CollectionInputWithContents.
Return type: CollectionOperation

label¶

Gets the label of this CollectionInputWithContents.

Returns: The label of this CollectionInputWithContents.
Return type: char

info¶

Gets the info of this CollectionInputWithContents.

Returns: The info of this CollectionInputWithContents.
Return type: containers.Map

description¶

Gets the description of this CollectionInputWithContents.

Returns: The description of this CollectionInputWithContents.
Return type: char

CollectionNode¶

class CollectionNode¶

level¶

Gets the level of this CollectionNode.

Returns: The level of this CollectionNode.
Return type: CollectionNodeLevel

id¶

Gets the id of this CollectionNode.

Returns: The id of this CollectionNode.
Return type: char

CollectionNodeLevel¶

An enumeration.

class CollectionNodeLevel¶: An enumeration.

CollectionOperation¶

class CollectionOperation¶

operation¶

Gets the operation of this CollectionOperation.

Returns: The operation of this CollectionOperation.
Return type: CollectionOperationType

nodes¶

Gets the nodes of this CollectionOperation.

Returns: The nodes of this CollectionOperation.
Return type: CollectionNode

CollectionOperationType¶

An enumeration.

class CollectionOperationType¶: An enumeration.

CollectionOutput¶

class CollectionOutput¶

created¶

Gets the created of this CollectionOutput.

Returns: The created of this CollectionOutput.
Return type: datetime

modified¶

Gets the modified of this CollectionOutput.

Returns: The modified of this CollectionOutput.
Return type: datetime

label¶

Gets the label of this CollectionOutput.

Returns: The label of this CollectionOutput.
Return type: char

description¶

Gets the description of this CollectionOutput.

Returns: The description of this CollectionOutput.
Return type: char

info¶

Gets the info of this CollectionOutput.

Returns: The info of this CollectionOutput.
Return type: containers.Map

id¶

Gets the id of this CollectionOutput.

Returns: The id of this CollectionOutput.
Return type: char

curator¶

Gets the curator of this CollectionOutput.

Returns: The curator of this CollectionOutput.
Return type: char

revision¶

Gets the revision of this CollectionOutput.

Returns: The revision of this CollectionOutput.
Return type: integer

notes¶

Gets the notes of this CollectionOutput.

Returns: The notes of this CollectionOutput.
Return type: Note

tags¶

Gets the tags of this CollectionOutput.

Returns: The tags of this CollectionOutput.
Return type: vector[char]

analyses¶

Gets the analyses of this CollectionOutput.

Returns: The analyses of this CollectionOutput.
Return type: Analysis

permissions¶

Gets the permissions of this CollectionOutput.

Returns: The permissions of this CollectionOutput.
Return type: AccessPermission

joinOrigin¶

Gets the joinOrigin of this CollectionOutput.

Returns: The joinOrigin of this CollectionOutput.
Return type: JoinOrigins

files¶

Gets the files of this CollectionOutput.

Returns: The files of this CollectionOutput.
Return type: FileOutput

attachmentCount¶

Gets the attachmentCount of this CollectionOutput.

Returns: The attachmentCount of this CollectionOutput.
Return type: integer

sessionCount¶

Gets the sessionCount of this CollectionOutput.

Returns: The sessionCount of this CollectionOutput.
Return type: integer

noncompliantSessionCount¶

Gets the noncompliantSessionCount of this CollectionOutput.

Returns: The noncompliantSessionCount of this CollectionOutput.
Return type: integer

subjectCount¶

Gets the subjectCount of this CollectionOutput.

Returns: The subjectCount of this CollectionOutput.
Return type: integer

CollectionWithStats¶

class CollectionWithStats¶

id¶

Gets the id of this CollectionWithStats.

Returns: The id of this CollectionWithStats.
Return type: char

created¶

Gets the created of this CollectionWithStats.

Returns: The created of this CollectionWithStats.
Return type: datetime

modified¶

Gets the modified of this CollectionWithStats.

Returns: The modified of this CollectionWithStats.
Return type: datetime

label¶

Gets the label of this CollectionWithStats.

Returns: The label of this CollectionWithStats.
Return type: char

description¶

Gets the description of this CollectionWithStats.

Returns: The description of this CollectionWithStats.
Return type: char

info¶

Gets the info of this CollectionWithStats.

Returns: The info of this CollectionWithStats.
Return type: containers.Map

curator¶

Gets the curator of this CollectionWithStats.

Returns: The curator of this CollectionWithStats.
Return type: char

revision¶

Gets the revision of this CollectionWithStats.

Returns: The revision of this CollectionWithStats.
Return type: integer

notes¶

Gets the notes of this CollectionWithStats.

Returns: The notes of this CollectionWithStats.
Return type: Note

tags¶

Gets the tags of this CollectionWithStats.

Returns: The tags of this CollectionWithStats.
Return type: vector[char]

analyses¶

Gets the analyses of this CollectionWithStats.

Returns: The analyses of this CollectionWithStats.
Return type: Object

permissions¶

Gets the permissions of this CollectionWithStats.

Returns: The permissions of this CollectionWithStats.
Return type: AccessPermission

joinOrigin¶

Gets the joinOrigin of this CollectionWithStats.

Returns: The joinOrigin of this CollectionWithStats.
Return type: JoinOrigins

files¶

Gets the files of this CollectionWithStats.

Returns: The files of this CollectionWithStats.
Return type: FileListOutput

attachmentCount¶

Gets the attachmentCount of this CollectionWithStats.

Returns: The attachmentCount of this CollectionWithStats.
Return type: integer

sessionCount¶

Gets the sessionCount of this CollectionWithStats.

Returns: The sessionCount of this CollectionWithStats.
Return type: integer

noncompliantSessionCount¶

Gets the noncompliantSessionCount of this CollectionWithStats.

Returns: The noncompliantSessionCount of this CollectionWithStats.
Return type: integer

subjectCount¶

Gets the subjectCount of this CollectionWithStats.

Returns: The subjectCount of this CollectionWithStats.
Return type: integer

Column¶

Describe a column that should belong to the view

class Column¶

Describe a column that should belong to the view

src¶

The source property in the format of {container}.{field}

Returns: The src of this Column.
Return type: char

dst¶

The optional destination property name

Returns: The dst of this Column.
Return type: char

type¶

The type that this value should be translated to (for typed output)

Returns: The type of this Column.
Return type: AllOfColumnType

expr¶

An optional expression, allowing simple calculations (add, subtract, multiply, divide). Use ‘x’ to substitute the column

Returns: The expr of this Column.
Return type: char

accumulator¶

Accumulation operator for an a group by aggregation

Returns: The accumulator of this Column.
Return type: AllOfColumnAccumulator

ColumnType¶

An enumeration.

class ColumnType¶: An enumeration.

CommonClassification¶

class CommonClassification¶

CommonDeletedCount¶

class CommonDeletedCount¶

CommonEditions¶

class CommonEditions¶

CommonInfo¶

Free-form information storage

class CommonInfo¶: Free-form information storage

CommonJoinOrigins¶

class CommonJoinOrigins¶

CommonModifiedCount¶

class CommonModifiedCount¶

CommonProjectSettings¶

class CommonProjectSettings¶

ConfigAuthOutput¶

class ConfigAuthOutput¶

ConfigFeatureMap¶

class ConfigFeatureMap¶

ConfigOut¶

class ConfigOut¶

lastUpdated¶

Gets the lastUpdated of this ConfigOut.

Returns: The lastUpdated of this ConfigOut.
Return type: datetime

site¶

Gets the site of this ConfigOut.

Returns: The site of this ConfigOut.
Return type: Site

features¶

Gets the features of this ConfigOut.

Returns: The features of this ConfigOut.
Return type: AllOfConfigOutFeatures

wipFeatures¶

Gets the wipFeatures of this ConfigOut.

Returns: The wipFeatures of this ConfigOut.
Return type: AllOfConfigOutWipFeatures

signedUrl¶

Gets the signedUrl of this ConfigOut.

Returns: The signedUrl of this ConfigOut.
Return type: logical

auth¶

Gets the auth of this ConfigOut.

Returns: The auth of this ConfigOut.
Return type: AuthOut

openTracing¶

Gets the openTracing of this ConfigOut.

Returns: The openTracing of this ConfigOut.
Return type: OpenTracing

created¶

Gets the created of this ConfigOut.

Returns: The created of this ConfigOut.
Return type: datetime

modified¶

Gets the modified of this ConfigOut.

Returns: The modified of this ConfigOut.
Return type: datetime

ConfigOutput¶

class ConfigOutput¶

ConfigSiteConfigOutput¶

class ConfigSiteConfigOutput¶

ConfigSiteSettings¶

class ConfigSiteSettings¶

ConfigSiteSettingsInput¶

class ConfigSiteSettingsInput¶

centerGears¶

A list of gear algorithm names that are treated as center-pays for the purpose of the billing report

Returns: The centerGears of this ConfigSiteSettingsInput.
Return type: vector[char]

providers¶

Gets the providers of this ConfigSiteSettingsInput.

Returns: The providers of this ConfigSiteSettingsInput.
Return type: ProviderLinks

viewerApps¶

A list of viewer app associations for files and container

Returns: The viewerApps of this ConfigSiteSettingsInput.
Return type: ViewerApp

ldapSync¶

Gets the ldapSync of this ConfigSiteSettingsInput.

Returns: The ldapSync of this ConfigSiteSettingsInput.
Return type: LdapSync

ConflictTypes¶

An enumeration.

class ConflictTypes¶: An enumeration.

ContainerDeleteReason¶

An enumeration.

class ContainerDeleteReason¶: An enumeration.

ContainerFilter¶

class ContainerFilter¶

type¶

Gets the type of this ContainerFilter.

Returns: The type of this ContainerFilter.
Return type: ContainerType

tags¶

Gets the tags of this ContainerFilter.

Returns: The tags of this ContainerFilter.
Return type: FilterValues

ContainerIdViewInput¶

View input to server

class ContainerIdViewInput¶

View input to server

parent¶

Gets the parent of this ContainerIdViewInput.

Returns: The parent of this ContainerIdViewInput.
Return type: char

label¶

Gets the label of this ContainerIdViewInput.

Returns: The label of this ContainerIdViewInput.
Return type: char

description¶

Gets the description of this ContainerIdViewInput.

Returns: The description of this ContainerIdViewInput.
Return type: char

columns¶

Gets the columns of this ContainerIdViewInput.

Returns: The columns of this ContainerIdViewInput.
Return type: Column

fileSpec¶

Gets the fileSpec of this ContainerIdViewInput.

Returns: The fileSpec of this ContainerIdViewInput.
Return type: containers.Map

filter¶

Gets the filter of this ContainerIdViewInput.

Returns: The filter of this ContainerIdViewInput.
Return type: char

groupBy¶

Gets the groupBy of this ContainerIdViewInput.

Returns: The groupBy of this ContainerIdViewInput.
Return type: GroupBy

includeIds¶

Gets the includeIds of this ContainerIdViewInput.

Returns: The includeIds of this ContainerIdViewInput.
Return type: logical

includeLabels¶

Gets the includeLabels of this ContainerIdViewInput.

Returns: The includeLabels of this ContainerIdViewInput.
Return type: logical

errorColumn¶

Gets the errorColumn of this ContainerIdViewInput.

Returns: The errorColumn of this ContainerIdViewInput.
Return type: logical

missingDataStrategy¶

Gets the missingDataStrategy of this ContainerIdViewInput.

Returns: The missingDataStrategy of this ContainerIdViewInput.
Return type: DataStrategy

sort¶

Gets the sort of this ContainerIdViewInput.

Returns: The sort of this ContainerIdViewInput.
Return type: logical

id¶

Gets the id of this ContainerIdViewInput.

Returns: The id of this ContainerIdViewInput.
Return type: char

origin¶

Gets the origin of this ContainerIdViewInput.

Returns: The origin of this ContainerIdViewInput.
Return type: Origin

ContainerIdViewInputExecuteAndSave¶

A request to save data-view data to a container

class ContainerIdViewInputExecuteAndSave¶

A request to save data-view data to a container

viewId¶

Unique database ID

Returns: The viewId of this ContainerIdViewInputExecuteAndSave.
Return type: char

view¶

Gets the view of this ContainerIdViewInputExecuteAndSave.

Returns: The view of this ContainerIdViewInputExecuteAndSave.
Return type: ContainerPipelineInput

containerType¶

The type of container (e.g. session)

Returns: The containerType of this ContainerIdViewInputExecuteAndSave.
Return type: AllOfContainerIdViewInputExecuteAndSaveContainerType

containerId¶

Unique database ID

Returns: The containerId of this ContainerIdViewInputExecuteAndSave.
Return type: char

filename¶

The name of the file on disk

Returns: The filename of this ContainerIdViewInputExecuteAndSave.
Return type: char

ContainerNewOutput¶

class ContainerNewOutput¶

ContainerNodeMin¶

Special case for any min container.

class ContainerNodeMin¶

Special case for any min container.

id¶

Gets the id of this ContainerNodeMin.

Returns: The id of this ContainerNodeMin.
Return type: char

label¶

Gets the label of this ContainerNodeMin.

Returns: The label of this ContainerNodeMin.
Return type: char

name¶

Gets the name of this ContainerNodeMin.

Returns: The name of this ContainerNodeMin.
Return type: char

code¶

Gets the code of this ContainerNodeMin.

Returns: The code of this ContainerNodeMin.
Return type: char

created¶

Gets the created of this ContainerNodeMin.

Returns: The created of this ContainerNodeMin.
Return type: datetime

modified¶

Gets the modified of this ContainerNodeMin.

Returns: The modified of this ContainerNodeMin.
Return type: datetime

containerType¶

Gets the containerType of this ContainerNodeMin.

Returns: The containerType of this ContainerNodeMin.
Return type: char

nodeType¶

Gets the nodeType of this ContainerNodeMin.

Returns: The nodeType of this ContainerNodeMin.
Return type: char

ContainerOutputWithFiles¶

Generic container output with files

class ContainerOutputWithFiles¶

Generic container output with files

id¶

Unique database ID

Returns: The id of this ContainerOutputWithFiles.
Return type: char

label¶

Application-specific label

Returns: The label of this ContainerOutputWithFiles.
Return type: char

files¶

Gets the files of this ContainerOutputWithFiles.

Returns: The files of this ContainerOutputWithFiles.
Return type: FileEntry

created¶

Creation time (automatically set)

Returns: The created of this ContainerOutputWithFiles.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ContainerOutputWithFiles.
Return type: datetime

ContainerParents¶

class ContainerParents¶

analysis¶

Unique database ID

Returns: The analysis of this ContainerParents.
Return type: char

acquisition¶

Unique database ID

Returns: The acquisition of this ContainerParents.
Return type: char

session¶

Unique database ID

Returns: The session of this ContainerParents.
Return type: char

subject¶

Unique database ID

Returns: The subject of this ContainerParents.
Return type: char

project¶

Unique database ID

Returns: The project of this ContainerParents.
Return type: char

group¶

Unique database ID

Returns: The group of this ContainerParents.
Return type: char

ContainerPipelineInput¶

Specifies a flattened view of the flywheel hierarchy, possibly including files.

class ContainerPipelineInput¶

Specifies a flattened view of the flywheel hierarchy, possibly including files.

parent¶

The parent container id

Returns: The parent of this ContainerPipelineInput.
Return type: char

label¶

Application-specific label

Returns: The label of this ContainerPipelineInput.
Return type: char

description¶

Gets the description of this ContainerPipelineInput.

Returns: The description of this ContainerPipelineInput.
Return type: char

columns¶

Gets the columns of this ContainerPipelineInput.

Returns: The columns of this ContainerPipelineInput.
Return type: Column

fileSpec¶

Gets the fileSpec of this ContainerPipelineInput.

Returns: The fileSpec of this ContainerPipelineInput.
Return type: DataViewFileSpec

filter¶

Gets the filter of this ContainerPipelineInput.

Returns: The filter of this ContainerPipelineInput.
Return type: char

groupBy¶

Gets the groupBy of this ContainerPipelineInput.

Returns: The groupBy of this ContainerPipelineInput.
Return type: GroupBy

includeIds¶

Whether or not to include container id fields. Default is true

Returns: The includeIds of this ContainerPipelineInput.
Return type: logical

includeLabels¶

Whether or not to include container label fields. Default is true

Returns: The includeLabels of this ContainerPipelineInput.
Return type: logical

errorColumn¶

Whether or not to include errors column. Default is true

Returns: The errorColumn of this ContainerPipelineInput.
Return type: logical

missingDataStrategy¶

What to do if missing data are encountered. Default is none, which is to say replace with an empty or null value.

Returns: The missingDataStrategy of this ContainerPipelineInput.
Return type: AllOfContainerPipelineInputMissingDataStrategy

sort¶

Opt out of sorting results by setting value to false

Returns: The sort of this ContainerPipelineInput.
Return type: logical

id¶

Unique database ID

Returns: The id of this ContainerPipelineInput.
Return type: char

origin¶

Gets the origin of this ContainerPipelineInput.

Returns: The origin of this ContainerPipelineInput.
Return type: Origin

ContainerProjectParents¶

class ContainerProjectParents¶

ContainerReference¶

A reference to an individual container, by type and id

class ContainerReference¶

A reference to an individual container, by type and id

type¶

The type of container (e.g. session)

Returns: The type of this ContainerReference.
Return type: char

id¶

Unique database ID

Returns: The id of this ContainerReference.
Return type: char

ContainerReferenceWithLabel¶

Representation of a container reference that is returned with the label

class ContainerReferenceWithLabel¶

Representation of a container reference that is returned with the label

id¶

Gets the id of this ContainerReferenceWithLabel.

Returns: The id of this ContainerReferenceWithLabel.
Return type: char

contType¶

Gets the contType of this ContainerReferenceWithLabel.

Returns: The contType of this ContainerReferenceWithLabel.
Return type: ContainerType

label¶

Gets the label of this ContainerReferenceWithLabel.

Returns: The label of this ContainerReferenceWithLabel.
Return type: char

ContainerSessionParents¶

class ContainerSessionParents¶

ContainerSubjectParents¶

class ContainerSubjectParents¶

ContainerType¶

An enumeration.

class ContainerType¶: An enumeration.

ContainerUidcheck¶

Input for checking the existence of UIDs

class ContainerUidcheck¶

Input for checking the existence of UIDs

sessions¶

A list of UIDs

Returns: The sessions of this ContainerUidcheck.
Return type: vector[char]

acquisitions¶

A list of UIDs

Returns: The acquisitions of this ContainerUidcheck.
Return type: vector[char]

projectId¶

Unique database ID

Returns: The projectId of this ContainerUidcheck.
Return type: char

projectIds¶

A list of Project IDs

Returns: The projectIds of this ContainerUidcheck.
Return type: vector[char]

ContainerUpdate¶

Generic input, should be validated by the correct schema later on

class ContainerUpdate¶: Generic input, should be validated by the correct schema later on

ContextInput¶

Represents a context-based input to a job Attributes: found (bool): Whether or not the context information was found value (Any): TODO: description base (str): The input type

class ContextInput¶

Represents a context-based input to a job Attributes: found (bool): Whether or not the context information was found value (Any): TODO: description base (str): The input type

found¶

Gets the found of this ContextInput.

Returns: The found of this ContextInput.
Return type: logical

value¶

Gets the value of this ContextInput.

Returns: The value of this ContextInput.
Return type: containers.Map

base¶

Gets the base of this ContextInput.

Returns: The base of this ContextInput.
Return type: char

CoreModelsApiKeyApiKeyInput¶

class CoreModelsApiKeyApiKeyInput¶

label¶

Gets the label of this CoreModelsApiKeyApiKeyInput.

Returns: The label of this CoreModelsApiKeyApiKeyInput.
Return type: char

expiresAt¶

Gets the expiresAt of this CoreModelsApiKeyApiKeyInput.

Returns: The expiresAt of this CoreModelsApiKeyApiKeyInput.
Return type: datetime

CoreModelsJobsApiKeyInput¶

Represents an api key input for a job to use to interact with the api Attributes: base (str): The input type key (Optional[str]): The key?

class CoreModelsJobsApiKeyInput¶

Represents an api key input for a job to use to interact with the api Attributes: base (str): The input type key (Optional[str]): The key?

base¶

Gets the base of this CoreModelsJobsApiKeyInput.

Returns: The base of this CoreModelsJobsApiKeyInput.
Return type: char

key¶

Gets the key of this CoreModelsJobsApiKeyInput.

Returns: The key of this CoreModelsJobsApiKeyInput.
Return type: char

CreateReportInput¶

class CreateReportInput¶

projectId¶

Gets the projectId of this CreateReportInput.

Returns: The projectId of this CreateReportInput.
Return type: char

subjectIds¶

Gets the subjectIds of this CreateReportInput.

Returns: The subjectIds of this CreateReportInput.
Return type: vector[char]

label¶

Gets the label of this CreateReportInput.

Returns: The label of this CreateReportInput.
Return type: char

status¶

Gets the status of this CreateReportInput.

Returns: The status of this CreateReportInput.
Return type: AllOfCreateReportInputStatus

created¶

Gets the created of this CreateReportInput.

Returns: The created of this CreateReportInput.
Return type: datetime

Creds¶

Used for creds that are empty Provider explicit type with no definition

class Creds¶: Used for creds that are empty Provider explicit type with no definition

Curator¶

class Curator¶

id¶

Database ID of a user

Returns: The id of this Curator.
Return type: char

firstname¶

First name

Returns: The firstname of this Curator.
Return type: char

lastname¶

Last name

Returns: The lastname of this Curator.
Return type: char

CurrentUserOutput¶

class CurrentUserOutput¶

id¶

Gets the id of this CurrentUserOutput.

Returns: The id of this CurrentUserOutput.
Return type: char

userId¶

Gets the userId of this CurrentUserOutput.

Returns: The userId of this CurrentUserOutput.
Return type: char

firstname¶

Gets the firstname of this CurrentUserOutput.

Returns: The firstname of this CurrentUserOutput.
Return type: char

lastname¶

Gets the lastname of this CurrentUserOutput.

Returns: The lastname of this CurrentUserOutput.
Return type: char

email¶

Gets the email of this CurrentUserOutput.

Returns: The email of this CurrentUserOutput.
Return type: char

auth0sub¶

Gets the auth0sub of this CurrentUserOutput.

Returns: The auth0sub of this CurrentUserOutput.
Return type: char

roles¶

Gets the roles of this CurrentUserOutput.

Returns: The roles of this CurrentUserOutput.
Return type: vector[char]

root¶

Gets the root of this CurrentUserOutput.

Returns: The root of this CurrentUserOutput.
Return type: logical

apiKey¶

Gets the apiKey of this CurrentUserOutput.

Returns: The apiKey of this CurrentUserOutput.
Return type: LegacyApiKeyOutput

apiKeys¶

Gets the apiKeys of this CurrentUserOutput.

Returns: The apiKeys of this CurrentUserOutput.
Return type: ApiKeyOutput

avatar¶

Gets the avatar of this CurrentUserOutput.

Returns: The avatar of this CurrentUserOutput.
Return type: char

avatars¶

Gets the avatars of this CurrentUserOutput.

Returns: The avatars of this CurrentUserOutput.
Return type: AllOfCurrentUserOutputAvatars

disabled¶

Gets the disabled of this CurrentUserOutput.

Returns: The disabled of this CurrentUserOutput.
Return type: logical

preferences¶

Gets the preferences of this CurrentUserOutput.

Returns: The preferences of this CurrentUserOutput.
Return type: UserPreferences

created¶

Gets the created of this CurrentUserOutput.

Returns: The created of this CurrentUserOutput.
Return type: datetime

modified¶

Gets the modified of this CurrentUserOutput.

Returns: The modified of this CurrentUserOutput.
Return type: datetime

multifactor¶

Gets the multifactor of this CurrentUserOutput.

Returns: The multifactor of this CurrentUserOutput.
Return type: MultifactorAccount

info¶

Gets the info of this CurrentUserOutput.

Returns: The info of this CurrentUserOutput.
Return type: containers.Map

firstlogin¶

Gets the firstlogin of this CurrentUserOutput.

Returns: The firstlogin of this CurrentUserOutput.
Return type: char

lastlogin¶

Gets the lastlogin of this CurrentUserOutput.

Returns: The lastlogin of this CurrentUserOutput.
Return type: char

visitedProjects¶

Gets the visitedProjects of this CurrentUserOutput.

Returns: The visitedProjects of this CurrentUserOutput.
Return type: vector[char]

DataStrategy¶

An enumeration.

class DataStrategy¶: An enumeration.

DataView¶

Specifies a flattened view of the flywheel hierarchy, possibly including files.

class DataView¶

Specifies a flattened view of the flywheel hierarchy, possibly including files.

parent¶

The parent container id

Returns: The parent of this DataView.
Return type: char

label¶

Application-specific label

Returns: The label of this DataView.
Return type: char

description¶

Gets the description of this DataView.

Returns: The description of this DataView.
Return type: char

columns¶

Gets the columns of this DataView.

Returns: The columns of this DataView.
Return type: DataViewColumnSpec

groupBy¶

Gets the groupBy of this DataView.

Returns: The groupBy of this DataView.
Return type: DataViewGroupBy

filter¶

An optional row filter

Returns: The filter of this DataView.
Return type: char

fileSpec¶

Gets the fileSpec of this DataView.

Returns: The fileSpec of this DataView.
Return type: DataViewFileSpec

includeIds¶

Whether or not to include container id fields. Default is true

Returns: The includeIds of this DataView.
Return type: logical

includeLabels¶

Whether or not to include container label fields. Default is true

Returns: The includeLabels of this DataView.
Return type: logical

errorColumn¶

Whether or not to include errors column. Default is true

Returns: The errorColumn of this DataView.
Return type: logical

missingDataStrategy¶

The resolution strategy if rows are missing data for a column. The default is to replace the column value with None. This value can be one of: none, drop-row.

Returns: The missingDataStrategy of this DataView.
Return type: char

sort¶

Opt out of sorting results by setting value to false

Returns: The sort of this DataView.
Return type: logical

DataViewAnalysisFileSpec¶

class DataViewAnalysisFileSpec¶

label¶

Gets the label of this DataViewAnalysisFileSpec.

Returns: The label of this DataViewAnalysisFileSpec.
Return type: DataViewNameFilterSpec

gearName¶

Gets the gearName of this DataViewAnalysisFileSpec.

Returns: The gearName of this DataViewAnalysisFileSpec.
Return type: DataViewNameFilterSpec

gearVersion¶

Gets the gearVersion of this DataViewAnalysisFileSpec.

Returns: The gearVersion of this DataViewAnalysisFileSpec.
Return type: DataViewNameFilterSpec

DataViewAnalysisFilterSpec¶

Specifies which analyses to match for files

class DataViewAnalysisFilterSpec¶

Specifies which analyses to match for files

label¶

Gets the label of this DataViewAnalysisFilterSpec.

Returns: The label of this DataViewAnalysisFilterSpec.
Return type: DataViewNameFilterSpec

gearName¶

Gets the gearName of this DataViewAnalysisFilterSpec.

Returns: The gearName of this DataViewAnalysisFilterSpec.
Return type: DataViewNameFilterSpec

gearVersion¶

Gets the gearVersion of this DataViewAnalysisFilterSpec.

Returns: The gearVersion of this DataViewAnalysisFilterSpec.
Return type: DataViewNameFilterSpec

DataViewColumnAlias¶

Represents a column alias for use in data views. Maps from src to name.

class DataViewColumnAlias¶

Represents a column alias for use in data views. Maps from src to name.

name¶

The column alias name

Returns: The name of this DataViewColumnAlias.
Return type: char

src¶

The source for this column’s data

Returns: The src of this DataViewColumnAlias.
Return type: char

group¶

The list of columns that belong to this group

Returns: The group of this DataViewColumnAlias.
Return type: vector[char]

description¶

A description of this field

Returns: The description of this DataViewColumnAlias.
Return type: char

type¶

The type that this value should be translated to (for typed output)

Returns: The type of this DataViewColumnAlias.
Return type: AllOfDataViewColumnAliasType

expr¶

An optional expression, allowing simple calculations

Returns: The expr of this DataViewColumnAlias.
Return type: char

hidden¶

Gets the hidden of this DataViewColumnAlias.

Returns: The hidden of this DataViewColumnAlias.
Return type: logical

DataViewColumnSpec¶

Describe a column that should belong to the view

class DataViewColumnSpec¶

Describe a column that should belong to the view

src¶

The source property in the format of {container}.{field}

Returns: The src of this DataViewColumnSpec.
Return type: char

dst¶

The optional destination property name

Returns: The dst of this DataViewColumnSpec.
Return type: char

type¶

The type that this value should be translated to (for typed output)

Returns: The type of this DataViewColumnSpec.
Return type: char

expr¶

An optional expression, allowing simple calculations (add, subtract, multiply, divide). Use ‘x’ to substitute the column

Returns: The expr of this DataViewColumnSpec.
Return type: char

accumulator¶

Accumulation operator for an a group by aggregation

Returns: The accumulator of this DataViewColumnSpec.
Return type: char

DataViewExecution¶

class DataViewExecution¶

id¶

Unique database ID

Returns: The id of this DataViewExecution.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this DataViewExecution.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this DataViewExecution.
Return type: datetime

timestampRan¶

Gets the timestampRan of this DataViewExecution.

Returns: The timestampRan of this DataViewExecution.
Return type: datetime

userId¶

Database ID of a user

Returns: The userId of this DataViewExecution.
Return type: char

projectId¶

Unique database ID

Returns: The projectId of this DataViewExecution.
Return type: char

state¶

The expected data file format, default is auto-detect

Returns: The state of this DataViewExecution.
Return type: char

dataViewId¶

Unique database ID

Returns: The dataViewId of this DataViewExecution.
Return type: char

storageFileId¶

Unique database ID

Returns: The storageFileId of this DataViewExecution.
Return type: char

taskId¶

Hyphen-separated universally unique identifier

Returns: The taskId of this DataViewExecution.
Return type: char

expiresOn¶

Gets the expiresOn of this DataViewExecution.

Returns: The expiresOn of this DataViewExecution.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this DataViewExecution.
Return type: integer

DataViewExecutionState¶

An enumeration.

class DataViewExecutionState¶: An enumeration.

DataViewFileSpec¶

Specifies a file to be processed, including filename matching and parsing options

class DataViewFileSpec¶

Specifies a file to be processed, including filename matching and parsing options

container¶

The type of container (e.g. session)

Returns: The container of this DataViewFileSpec.
Return type: char

analysisFilter¶

Gets the analysisFilter of this DataViewFileSpec.

Returns: The analysisFilter of this DataViewFileSpec.
Return type: DataViewAnalysisFilterSpec

filter¶

Gets the filter of this DataViewFileSpec.

Returns: The filter of this DataViewFileSpec.
Return type: DataViewNameFilterSpec

zipMember¶

Gets the zipMember of this DataViewFileSpec.

Returns: The zipMember of this DataViewFileSpec.
Return type: DataViewZipFilterSpec

match¶

If multiple file matches are encountered, which file to choose. Default is first

Returns: The match of this DataViewFileSpec.
Return type: char

format¶

The expected data file format, default is auto-detect

Returns: The format of this DataViewFileSpec.
Return type: char

formatOptions¶

Gets the formatOptions of this DataViewFileSpec.

Returns: The formatOptions of this DataViewFileSpec.
Return type: containers.Map

processFiles¶

Set to false to skip file reading, and return file attributes instead

Returns: The processFiles of this DataViewFileSpec.
Return type: logical

columns¶

Gets the columns of this DataViewFileSpec.

Returns: The columns of this DataViewFileSpec.
Return type: DataViewColumnSpec

DataViewGroupBy¶

class DataViewGroupBy¶

columns¶

Gets the columns of this DataViewGroupBy.

Returns: The columns of this DataViewGroupBy.
Return type: DataViewGroupByColumn

DataViewGroupByColumn¶

class DataViewGroupByColumn¶

src¶

The source property in the format of {container}.{field}

Returns: The src of this DataViewGroupByColumn.
Return type: char

dst¶

The optional destination property name

Returns: The dst of this DataViewGroupByColumn.
Return type: char

DataViewNameFilterSpec¶

Specifies either a pattern match or regular expression match string filter

class DataViewNameFilterSpec¶

Specifies either a pattern match or regular expression match string filter

value¶

The pattern or regular expression to match

Returns: The value of this DataViewNameFilterSpec.
Return type: char

regex¶

Whether or not this filter is a pattern or regular expression match

Returns: The regex of this DataViewNameFilterSpec.
Return type: logical

DataViewOutput¶

class DataViewOutput¶

DataViewSaveDataViewInput¶

class DataViewSaveDataViewInput¶

DataViewZipFilterSpec¶

Specifies filters for zip members.

class DataViewZipFilterSpec¶

Specifies filters for zip members.

value¶

The pattern or regular expression to match

Returns: The value of this DataViewZipFilterSpec.
Return type: char

regex¶

Whether or not this filter is a pattern or regular expression match

Returns: The regex of this DataViewZipFilterSpec.
Return type: logical

match¶

If multiple file matches are encountered, which file to choose. Default is first

Returns: The match of this DataViewZipFilterSpec.
Return type: char

DefaultFlywheelRole¶

An enumeration.

class DefaultFlywheelRole¶: An enumeration.

DeidLogSkipReason¶

An enumeration.

class DeidLogSkipReason¶: An enumeration.

DeletedFile¶

Truncated file data in the ‘files’ collection after hard deletion

class DeletedFile¶

Truncated file data in the ‘files’ collection after hard deletion

id¶

Gets the id of this DeletedFile.

Returns: The id of this DeletedFile.
Return type: FileVersion

origin¶

Gets the origin of this DeletedFile.

Returns: The origin of this DeletedFile.
Return type: Origin

parentRef¶

Gets the parentRef of this DeletedFile.

Returns: The parentRef of this DeletedFile.
Return type: ContainerReference

name¶

Gets the name of this DeletedFile.

Returns: The name of this DeletedFile.
Return type: char

providerId¶

Gets the providerId of this DeletedFile.

Returns: The providerId of this DeletedFile.
Return type: char

uuid¶

Gets the uuid of this DeletedFile.

Returns: The uuid of this DeletedFile.
Return type: char

size¶

Gets the size of this DeletedFile.

Returns: The size of this DeletedFile.
Return type: integer

copyOf¶

Gets the copyOf of this DeletedFile.

Returns: The copyOf of this DeletedFile.
Return type: FileVersionCopyOf

created¶

Gets the created of this DeletedFile.

Returns: The created of this DeletedFile.
Return type: datetime

deleted¶

Gets the deleted of this DeletedFile.

Returns: The deleted of this DeletedFile.
Return type: datetime

replaced¶

Gets the replaced of this DeletedFile.

Returns: The replaced of this DeletedFile.
Return type: datetime

hardDeleted¶

Gets the hardDeleted of this DeletedFile.

Returns: The hardDeleted of this DeletedFile.
Return type: datetime

DeletedResult¶

class DeletedResult¶

deleted¶

Gets the deleted of this DeletedResult.

Returns: The deleted of this DeletedResult.
Return type: integer

DeprecatedAction¶

An enumeration.

class DeprecatedAction¶: An enumeration.

DestinationContainerType¶

An enumeration.

class DestinationContainerType¶: An enumeration.

Device¶

class Device¶

label¶

Gets the label of this Device.

Returns: The label of this Device.
Return type: char

type¶

Gets the type of this Device.

Returns: The type of this Device.
Return type: char

storageConfig¶

Gets the storageConfig of this Device.

Returns: The storageConfig of this Device.
Return type: containers.Map

disabled¶

Gets the disabled of this Device.

Returns: The disabled of this Device.
Return type: logical

version¶

Gets the version of this Device.

Returns: The version of this Device.
Return type: char

name¶

Gets the name of this Device.

Returns: The name of this Device.
Return type: char

interval¶

Gets the interval of this Device.

Returns: The interval of this Device.
Return type: integer

errors¶

Gets the errors of this Device.

Returns: The errors of this Device.
Return type: vector[char]

info¶

Gets the info of this Device.

Returns: The info of this Device.
Return type: CommonInfo

DeviceAdminUpdate¶

class DeviceAdminUpdate¶

disabled¶

Gets the disabled of this DeviceAdminUpdate.

Returns: The disabled of this DeviceAdminUpdate.
Return type: logical

storageConfig¶

Gets the storageConfig of this DeviceAdminUpdate.

Returns: The storageConfig of this DeviceAdminUpdate.
Return type: DeviceStorageStrategyUpdate

DeviceCreate¶

Used only for Post inputs

class DeviceCreate¶

Used only for Post inputs

label¶

Gets the label of this DeviceCreate.

Returns: The label of this DeviceCreate.
Return type: char

type¶

Gets the type of this DeviceCreate.

Returns: The type of this DeviceCreate.
Return type: char

storageConfig¶

Gets the storageConfig of this DeviceCreate.

Returns: The storageConfig of this DeviceCreate.
Return type: StorageStrategyConfig

DeviceSelfUpdate¶

class DeviceSelfUpdate¶

type¶

Gets the type of this DeviceSelfUpdate.

Returns: The type of this DeviceSelfUpdate.
Return type: char

version¶

Gets the version of this DeviceSelfUpdate.

Returns: The version of this DeviceSelfUpdate.
Return type: char

interval¶

Gets the interval of this DeviceSelfUpdate.

Returns: The interval of this DeviceSelfUpdate.
Return type: integer

errors¶

Gets the errors of this DeviceSelfUpdate.

Returns: The errors of this DeviceSelfUpdate.
Return type: vector[char]

info¶

Gets the info of this DeviceSelfUpdate.

Returns: The info of this DeviceSelfUpdate.
Return type: containers.Map

DeviceStatusEntry¶

class DeviceStatusEntry¶

errors¶

Gets the errors of this DeviceStatusEntry.

Returns: The errors of this DeviceStatusEntry.
Return type: vector[char]

lastSeen¶

Gets the lastSeen of this DeviceStatusEntry.

Returns: The lastSeen of this DeviceStatusEntry.
Return type: datetime

status¶

Gets the status of this DeviceStatusEntry.

Returns: The status of this DeviceStatusEntry.
Return type: StatusValue

DeviceStorageStrategyUpdate¶

class DeviceStorageStrategyUpdate¶

storageStrategy¶

Gets the storageStrategy of this DeviceStorageStrategyUpdate.

Returns: The storageStrategy of this DeviceStorageStrategyUpdate.
Return type: StorageStrategy

provider¶

Gets the provider of this DeviceStorageStrategyUpdate.

Returns: The provider of this DeviceStorageStrategyUpdate.
Return type: char

DimseProjectInput¶

class DimseProjectInput¶

DimseProjectOutput¶

class DimseProjectOutput¶

DimseServiceInput¶

class DimseServiceInput¶

aet¶

DICOM Application Entity Title

Returns: The aet of this DimseServiceInput.
Return type: char

host¶

DICOM service hostname or IP

Returns: The host of this DimseServiceInput.
Return type: char

port¶

DICOM service port number

Returns: The port of this DimseServiceInput.
Return type: integer

DimseServiceOutput¶

class DimseServiceOutput¶

id¶

Unique database ID

Returns: The id of this DimseServiceOutput.
Return type: char

created¶

Gets the created of this DimseServiceOutput.

Returns: The created of this DimseServiceOutput.
Return type: datetime

creator¶

Database ID of a user

Returns: The creator of this DimseServiceOutput.
Return type: char

aet¶

DICOM Application Entity Title

Returns: The aet of this DimseServiceOutput.
Return type: char

host¶

DICOM service hostname or IP

Returns: The host of this DimseServiceOutput.
Return type: char

port¶

DICOM service port number

Returns: The port of this DimseServiceOutput.
Return type: integer

Download¶

Specifies a set of files to download

class Download¶

Specifies a set of files to download

optional¶

Gets the optional of this Download.

Returns: The optional of this Download.
Return type: logical

nodes¶

Gets the nodes of this Download.

Returns: The nodes of this Download.
Return type: DownloadNode

containerFilters¶

Gets the containerFilters of this Download.

Returns: The containerFilters of this Download.
Return type: DownloadContainerFilter

filters¶

Gets the filters of this Download.

Returns: The filters of this Download.
Return type: DownloadFilter

DownloadContainerFilter¶

class DownloadContainerFilter¶

tags¶

Gets the tags of this DownloadContainerFilter.

Returns: The tags of this DownloadContainerFilter.
Return type: DownloadContainerFilterDefinition

DownloadContainerFilterDefinition¶

class DownloadContainerFilterDefinition¶

type¶

Gets the type of this DownloadContainerFilterDefinition.

Returns: The type of this DownloadContainerFilterDefinition.
Return type: char

plus¶

A list of items to include or exclude from a download

Returns: The plus of this DownloadContainerFilterDefinition.
Return type: vector[char]

minus¶

A list of items to include or exclude from a download

Returns: The minus of this DownloadContainerFilterDefinition.
Return type: vector[char]

DownloadFilter¶

class DownloadFilter¶

tags¶

Gets the tags of this DownloadFilter.

Returns: The tags of this DownloadFilter.
Return type: DownloadFilterDefinition

types¶

Gets the types of this DownloadFilter.

Returns: The types of this DownloadFilter.
Return type: DownloadFilterDefinition

since¶

Gets the since of this DownloadFilter.

Returns: The since of this DownloadFilter.
Return type: float

DownloadFilterDefinition¶

class DownloadFilterDefinition¶

plus¶

A list of items to include or exclude from a download

Returns: The plus of this DownloadFilterDefinition.
Return type: vector[char]

minus¶

A list of items to include or exclude from a download

Returns: The minus of this DownloadFilterDefinition.
Return type: vector[char]

DownloadFormat¶

An enumeration.

class DownloadFormat¶: An enumeration.

DownloadInput¶

class DownloadInput¶

DownloadNode¶

A reference to a container

class DownloadNode¶

A reference to a container

level¶

Gets the level of this DownloadNode.

Returns: The level of this DownloadNode.
Return type: char

id¶

Gets the id of this DownloadNode.

Returns: The id of this DownloadNode.
Return type: char

DownloadStrategy¶

An enumeration.

class DownloadStrategy¶: An enumeration.

DownloadTicketStub¶

Returned by get_ticket(). Contains info on the DownloadTicket just created. Attributes: ticket (str): unique id of ticket filename (str): filename to use file_cnt (int): number of files size (int): total size, in bytes

class DownloadTicketStub¶

Returned by get_ticket(). Contains info on the DownloadTicket just created. Attributes: ticket (str): unique id of ticket filename (str): filename to use file_cnt (int): number of files size (int): total size, in bytes

ticket¶

The ticket to use to perform the actual download

Returns: The ticket of this DownloadTicketStub.
Return type: char

filename¶

The filename to use when serving the download ticket

Returns: The filename of this DownloadTicketStub.
Return type: char

fileCnt¶

The number of files that will be included in the download

Returns: The fileCnt of this DownloadTicketStub.
Return type: integer

size¶

The ticket to use to perform the actual download

Returns: The size of this DownloadTicketStub.
Return type: integer

Edition¶

class Edition¶

lab¶

Gets the lab of this Edition.

Returns: The lab of this Edition.
Return type: logical

EgressDevice¶

class EgressDevice¶

id¶

Gets the id of this EgressDevice.

Returns: The id of this EgressDevice.
Return type: char

label¶

Gets the label of this EgressDevice.

Returns: The label of this EgressDevice.
Return type: char

name¶

Gets the name of this EgressDevice.

Returns: The name of this EgressDevice.
Return type: char

method¶

Gets the method of this EgressDevice.

Returns: The method of this EgressDevice.
Return type: char

apiKeys¶

Gets the apiKeys of this EgressDevice.

Returns: The apiKeys of this EgressDevice.
Return type: ApiKeyOutput

apiKey¶

Gets the apiKey of this EgressDevice.

Returns: The apiKey of this EgressDevice.
Return type: LegacyApiKeyOutput

key¶

Gets the key of this EgressDevice.

Returns: The key of this EgressDevice.
Return type: char

type¶

Gets the type of this EgressDevice.

Returns: The type of this EgressDevice.
Return type: char

version¶

Gets the version of this EgressDevice.

Returns: The version of this EgressDevice.
Return type: char

errors¶

Gets the errors of this EgressDevice.

Returns: The errors of this EgressDevice.
Return type: vector[char]

info¶

Gets the info of this EgressDevice.

Returns: The info of this EgressDevice.
Return type: containers.Map

interval¶

Gets the interval of this EgressDevice.

Returns: The interval of this EgressDevice.
Return type: integer

lastSeen¶

Gets the lastSeen of this EgressDevice.

Returns: The lastSeen of this EgressDevice.
Return type: datetime

disabled¶

Gets the disabled of this EgressDevice.

Returns: The disabled of this EgressDevice.
Return type: logical

deleted¶

Gets the deleted of this EgressDevice.

Returns: The deleted of this EgressDevice.
Return type: datetime

storageConfig¶

Gets the storageConfig of this EgressDevice.

Returns: The storageConfig of this EgressDevice.
Return type: StorageStrategyConfig

modified¶

Gets the modified of this EgressDevice.

Returns: The modified of this EgressDevice.
Return type: datetime

EgressDevicePage¶

Generic model of a page.

class EgressDevicePage¶

Generic model of a page.

count¶

Gets the count of this EgressDevicePage.

Returns: The count of this EgressDevicePage.
Return type: integer

total¶

Gets the total of this EgressDevicePage.

Returns: The total of this EgressDevicePage.
Return type: integer

results¶

Gets the results of this EgressDevicePage.

Returns: The results of this EgressDevicePage.
Return type: EgressDevice

EgressProvider¶

Provider output model

class EgressProvider¶

Provider output model

id¶

Gets the id of this EgressProvider.

Returns: The id of this EgressProvider.
Return type: char

label¶

Gets the label of this EgressProvider.

Returns: The label of this EgressProvider.
Return type: char

providerClass¶

Gets the providerClass of this EgressProvider.

Returns: The providerClass of this EgressProvider.
Return type: ProviderClass

providerType¶

Gets the providerType of this EgressProvider.

Returns: The providerType of this EgressProvider.
Return type: ProviderType

config¶

Gets the config of this EgressProvider.

Returns: The config of this EgressProvider.
Return type: containers.Map

modified¶

Gets the modified of this EgressProvider.

Returns: The modified of this EgressProvider.
Return type: datetime

created¶

Gets the created of this EgressProvider.

Returns: The created of this EgressProvider.
Return type: datetime

accessType¶

Gets the accessType of this EgressProvider.

Returns: The accessType of this EgressProvider.
Return type: ProviderAccessType

EgressProviderId¶

class EgressProviderId¶

id¶

Gets the id of this EgressProviderId.

Returns: The id of this EgressProviderId.
Return type: char

ExchangeStorage¶

class ExchangeStorage¶

configType¶

Gets the configType of this ExchangeStorage.

Returns: The configType of this ExchangeStorage.
Return type: char

configClass¶

Gets the configClass of this ExchangeStorage.

Returns: The configClass of this ExchangeStorage.
Return type: char

siteId¶

Gets the siteId of this ExchangeStorage.

Returns: The siteId of this ExchangeStorage.
Return type: char

datasetId¶

Gets the datasetId of this ExchangeStorage.

Returns: The datasetId of this ExchangeStorage.
Return type: char

ExecutorInfo¶

Information about the entity executing the job Attributes: name (Optional[str]): A machine or instance name, possibly a FQDN host (Optional[str]): The hostname or (more likely) IP address of the engine instance instance_type (Optional[str]): A free form string describing the instance type cpu_cores (Optional[int]): The number of CPU cores gpu (Optional[bool]): Whether or not a GPU is available memory_bytes (Optional[int]): The amount of memory on the system, in bytes disk_bytes (Optional[int]): The size of the hard disk on the system, in bytes swap_bytes (Optional[int]): The available swap space, in bytes

class ExecutorInfo¶

Information about the entity executing the job Attributes: name (Optional[str]): A machine or instance name, possibly a FQDN host (Optional[str]): The hostname or (more likely) IP address of the engine instance instance_type (Optional[str]): A free form string describing the instance type cpu_cores (Optional[int]): The number of CPU cores gpu (Optional[bool]): Whether or not a GPU is available memory_bytes (Optional[int]): The amount of memory on the system, in bytes disk_bytes (Optional[int]): The size of the hard disk on the system, in bytes swap_bytes (Optional[int]): The available swap space, in bytes

name¶

Gets the name of this ExecutorInfo.

Returns: The name of this ExecutorInfo.
Return type: char

host¶

Gets the host of this ExecutorInfo.

Returns: The host of this ExecutorInfo.
Return type: char

instanceType¶

Gets the instanceType of this ExecutorInfo.

Returns: The instanceType of this ExecutorInfo.
Return type: char

cpuCores¶

Gets the cpuCores of this ExecutorInfo.

Returns: The cpuCores of this ExecutorInfo.
Return type: integer

gpu¶

Gets the gpu of this ExecutorInfo.

Returns: The gpu of this ExecutorInfo.
Return type: logical

memoryBytes¶

Gets the memoryBytes of this ExecutorInfo.

Returns: The memoryBytes of this ExecutorInfo.
Return type: integer

diskBytes¶

Gets the diskBytes of this ExecutorInfo.

Returns: The diskBytes of this ExecutorInfo.
Return type: integer

swapBytes¶

Gets the swapBytes of this ExecutorInfo.

Returns: The swapBytes of this ExecutorInfo.
Return type: integer

ExportTemplates¶

Contains export templates for data files and container data.

class ExportTemplates¶

Contains export templates for data files and container data.

file¶

Gets the file of this ExportTemplates.

Returns: The file of this ExportTemplates.
Return type: FileExportTemplates

hierarchy¶

Gets the hierarchy of this ExportTemplates.

Returns: The hierarchy of this ExportTemplates.
Return type: HierarchyExportTemplates

Features¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

class Features¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

auth0¶

Gets the auth0 of this Features.

Returns: The auth0 of this Features.
Return type: logical

auditTrail¶

Gets the auditTrail of this Features.

Returns: The auditTrail of this Features.
Return type: logical

coldJobLogs¶

Gets the coldJobLogs of this Features.

Returns: The coldJobLogs of this Features.
Return type: logical

collections¶

Gets the collections of this Features.

Returns: The collections of this Features.
Return type: logical

copyByReference¶

Gets the copyByReference of this Features.

Returns: The copyByReference of this Features.
Return type: logical

coreApi¶

Gets the coreApi of this Features.

Returns: The coreApi of this Features.
Return type: logical

crawler¶

Gets the crawler of this Features.

Returns: The crawler of this Features.
Return type: logical

defaultViewerApps¶

Gets the defaultViewerApps of this Features.

Returns: The defaultViewerApps of this Features.
Return type: logical

deidLog¶

Gets the deidLog of this Features.

Returns: The deidLog of this Features.
Return type: logical

deidProfile¶

Gets the deidProfile of this Features.

Returns: The deidProfile of this Features.
Return type: logical

dimse¶

Gets the dimse of this Features.

Returns: The dimse of this Features.
Return type: logical

elasticSearchPrimary¶

Gets the elasticSearchPrimary of this Features.

Returns: The elasticSearchPrimary of this Features.
Return type: logical

exchange¶

Gets the exchange of this Features.

Returns: The exchange of this Features.
Return type: logical

exchangeAdmin¶

Gets the exchangeAdmin of this Features.

Returns: The exchangeAdmin of this Features.
Return type: logical

externalRouting¶

Gets the externalRouting of this Features.

Returns: The externalRouting of this Features.
Return type: logical

gearAccess¶

Gets the gearAccess of this Features.

Returns: The gearAccess of this Features.
Return type: logical

googleAnalytics¶

Gets the googleAnalytics of this Features.

Returns: The googleAnalytics of this Features.
Return type: logical

healthcareApi¶

Gets the healthcareApi of this Features.

Returns: The healthcareApi of this Features.
Return type: logical

jobAsk¶

Gets the jobAsk of this Features.

Returns: The jobAsk of this Features.
Return type: logical

jobPrioritization¶

Gets the jobPrioritization of this Features.

Returns: The jobPrioritization of this Features.
Return type: logical

jobTickets¶

Gets the jobTickets of this Features.

Returns: The jobTickets of this Features.
Return type: logical

jupyterIntegration¶

Gets the jupyterIntegration of this Features.

Returns: The jupyterIntegration of this Features.
Return type: logical

ldapSync¶

Gets the ldapSync of this Features.

Returns: The ldapSync of this Features.
Return type: logical

multifactorAuth¶

Gets the multifactorAuth of this Features.

Returns: The multifactorAuth of this Features.
Return type: logical

multipartSignedUrl¶

Gets the multipartSignedUrl of this Features.

Returns: The multipartSignedUrl of this Features.
Return type: logical

multiproject¶

Gets the multiproject of this Features.

Returns: The multiproject of this Features.
Return type: logical

ohifMultiSubjectView¶

Gets the ohifMultiSubjectView of this Features.

Returns: The ohifMultiSubjectView of this Features.
Return type: logical

ohifReact¶

Gets the ohifReact of this Features.

Returns: The ohifReact of this Features.
Return type: logical

ohifReactBeta¶

Gets the ohifReactBeta of this Features.

Returns: The ohifReactBeta of this Features.
Return type: logical

ohifSliceOrder¶

Gets the ohifSliceOrder of this Features.

Returns: The ohifSliceOrder of this Features.
Return type: char

ohifV3¶

Gets the ohifV3 of this Features.

Returns: The ohifV3 of this Features.
Return type: logical

ohifV3Beta¶

Gets the ohifV3Beta of this Features.

Returns: The ohifV3Beta of this Features.
Return type: logical

openTracing¶

Gets the openTracing of this Features.

Returns: The openTracing of this Features.
Return type: logical

projectExport¶

Gets the projectExport of this Features.

Returns: The projectExport of this Features.
Return type: logical

projectLocking¶

Gets the projectLocking of this Features.

Returns: The projectLocking of this Features.
Return type: logical

readerTasks¶

Gets the readerTasks of this Features.

Returns: The readerTasks of this Features.
Return type: logical

rtsSync¶

Gets the rtsSync of this Features.

Returns: The rtsSync of this Features.
Return type: logical

sentryLogging¶

Gets the sentryLogging of this Features.

Returns: The sentryLogging of this Features.
Return type: logical

sharedProjects¶

Gets the sharedProjects of this Features.

Returns: The sharedProjects of this Features.
Return type: logical

signedUrl¶

Gets the signedUrl of this Features.

Returns: The signedUrl of this Features.
Return type: logical

studyTaskStatus¶

Gets the studyTaskStatus of this Features.

Returns: The studyTaskStatus of this Features.
Return type: logical

tagging¶

Gets the tagging of this Features.

Returns: The tagging of this Features.
Return type: logical

tagsInLists¶

Gets the tagsInLists of this Features.

Returns: The tagsInLists of this Features.
Return type: logical

taskManagerDataViews¶

Gets the taskManagerDataViews of this Features.

Returns: The taskManagerDataViews of this Features.
Return type: logical

unsafeLogin¶

Gets the unsafeLogin of this Features.

Returns: The unsafeLogin of this Features.
Return type: logical

userpilot¶

Gets the userpilot of this Features.

Returns: The userpilot of this Features.
Return type: logical

validateClassification¶

Gets the validateClassification of this Features.

Returns: The validateClassification of this Features.
Return type: logical

virusScan¶

Gets the virusScan of this Features.

Returns: The virusScan of this Features.
Return type: logical

apiEnabledGearRules¶

Gets the apiEnabledGearRules of this Features.

Returns: The apiEnabledGearRules of this Features.
Return type: logical

projectListUsesStats¶

Gets the projectListUsesStats of this Features.

Returns: The projectListUsesStats of this Features.
Return type: logical

ohifV3Datasource¶

Gets the ohifV3Datasource of this Features.

Returns: The ohifV3Datasource of this Features.
Return type: char

File¶

New standalone file model

class File¶

New standalone file model

id¶

Gets the id of this File.

Returns: The id of this File.
Return type: FileVersion

parentRef¶

Gets the parentRef of this File.

Returns: The parentRef of this File.
Return type: ContainerReference

name¶

Gets the name of this File.

Returns: The name of this File.
Return type: char

fileGroup¶

Gets the fileGroup of this File.

Returns: The fileGroup of this File.
Return type: AllOfFileFileGroup

providerId¶

Gets the providerId of this File.

Returns: The providerId of this File.
Return type: char

uuid¶

Gets the uuid of this File.

Returns: The uuid of this File.
Return type: char

path¶

Gets the path of this File.

Returns: The path of this File.
Return type: char

reference¶

Gets the reference of this File.

Returns: The reference of this File.
Return type: logical

size¶

Gets the size of this File.

Returns: The size of this File.
Return type: integer

hash¶

Gets the hash of this File.

Returns: The hash of this File.
Return type: char

clientHash¶

Gets the clientHash of this File.

Returns: The clientHash of this File.
Return type: char

zipMemberCount¶

Gets the zipMemberCount of this File.

Returns: The zipMemberCount of this File.
Return type: integer

virusScan¶

Gets the virusScan of this File.

Returns: The virusScan of this File.
Return type: VirusScan

sourceFileId¶

Gets the sourceFileId of this File.

Returns: The sourceFileId of this File.
Return type: FileVersion

restoredFrom¶

Gets the restoredFrom of this File.

Returns: The restoredFrom of this File.
Return type: integer

restoredBy¶

Gets the restoredBy of this File.

Returns: The restoredBy of this File.
Return type: Origin

parents¶

Gets the parents of this File.

Returns: The parents of this File.
Return type: FileParents

revision¶

Gets the revision of this File.

Returns: The revision of this File.
Return type: integer

origin¶

Gets the origin of this File.

Returns: The origin of this File.
Return type: Origin

type¶

Gets the type of this File.

Returns: The type of this File.
Return type: char

mimetype¶

Gets the mimetype of this File.

Returns: The mimetype of this File.
Return type: char

modality¶

Gets the modality of this File.

Returns: The modality of this File.
Return type: char

classification¶

Gets the classification of this File.

Returns: The classification of this File.
Return type: containers.Map[String, vector[char]]

tags¶

Gets the tags of this File.

Returns: The tags of this File.
Return type: vector[char]

info¶

Gets the info of this File.

Returns: The info of this File.
Return type: containers.Map

infoExists¶

Gets the infoExists of this File.

Returns: The infoExists of this File.
Return type: logical

deidLogId¶

Gets the deidLogId of this File.

Returns: The deidLogId of this File.
Return type: char

deidLogSkipReason¶

Gets the deidLogSkipReason of this File.

Returns: The deidLogSkipReason of this File.
Return type: DeidLogSkipReason

gearInfo¶

Gets the gearInfo of this File.

Returns: The gearInfo of this File.
Return type: FileGearInfo

created¶

Gets the created of this File.

Returns: The created of this File.
Return type: datetime

modified¶

Gets the modified of this File.

Returns: The modified of this File.
Return type: datetime

replaced¶

Gets the replaced of this File.

Returns: The replaced of this File.
Return type: datetime

deleted¶

Gets the deleted of this File.

Returns: The deleted of this File.
Return type: datetime

copyOf¶

Gets the copyOf of this File.

Returns: The copyOf of this File.
Return type: FileVersionCopyOf

originalCopyOf¶

Gets the originalCopyOf of this File.

Returns: The originalCopyOf of this File.
Return type: FileVersion

FileClassificationDelta¶

Represents a set of changes to be applied to the file classification using the modality classification as the schema

class FileClassificationDelta¶

Represents a set of changes to be applied to the file classification using the modality classification as the schema

modality¶

Gets the modality of this FileClassificationDelta.

Returns: The modality of this FileClassificationDelta.
Return type: char

add¶

Gets the add of this FileClassificationDelta.

Returns: The add of this FileClassificationDelta.
Return type: containers.Map[String, vector[char]]

delete¶

Gets the delete of this FileClassificationDelta.

Returns: The delete of this FileClassificationDelta.
Return type: containers.Map[String, vector[char]]

replace¶

Gets the replace of this FileClassificationDelta.

Returns: The replace of this FileClassificationDelta.
Return type: containers.Map[String, vector[char]]

FileEntry¶

A file description

class FileEntry¶

A file description

id¶

Gets the id of this FileEntry.

Returns: The id of this FileEntry.
Return type: char

fileId¶

Unique database ID

Returns: The fileId of this FileEntry.
Return type: char

version¶

Version of the file

Returns: The version of this FileEntry.
Return type: integer

name¶

The name of the file on disk

Returns: The name of this FileEntry.
Return type: char

type¶

A descriptive file type (e.g. dicom, image, document, …)

Returns: The type of this FileEntry.
Return type: char

mimetype¶

A MIME Content-Type of the file

Returns: The mimetype of this FileEntry.
Return type: char

modality¶

The type of instrument that originated the file (e.g. MR, CT, …)

Returns: The modality of this FileEntry.
Return type: char

deidLogId¶

The UUID of the de-id log

Returns: The deidLogId of this FileEntry.
Return type: char

classification¶

Gets the classification of this FileEntry.

Returns: The classification of this FileEntry.
Return type: CommonClassification

tags¶

Array of application-specific tags

Returns: The tags of this FileEntry.
Return type: vector[char]

info¶

Gets the info of this FileEntry.

Returns: The info of this FileEntry.
Return type: CommonInfo

origin¶

Gets the origin of this FileEntry.

Returns: The origin of this FileEntry.
Return type: FileOrigin

hash¶

Cryptographic hash of the file

Returns: The hash of this FileEntry.
Return type: char

parents¶

Gets the parents of this FileEntry.

Returns: The parents of this FileEntry.
Return type: ContainerParents

parentRef¶

Gets the parentRef of this FileEntry.

Returns: The parentRef of this FileEntry.
Return type: ContainerReference

created¶

Creation time (automatically set)

Returns: The created of this FileEntry.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this FileEntry.
Return type: datetime

replaced¶

Last replaced time (automatically updated)

Returns: The replaced of this FileEntry.
Return type: datetime

size¶

Size of the file, in bytes

Returns: The size of this FileEntry.
Return type: integer

infoExists¶

Gets the infoExists of this FileEntry.

Returns: The infoExists of this FileEntry.
Return type: logical

zipMemberCount¶

Number of entries in the zip archive

Returns: The zipMemberCount of this FileEntry.
Return type: integer

FileExportTemplates¶

Contains all the export templates applicable to data files.

class FileExportTemplates¶

Contains all the export templates applicable to data files.

group¶

Gets the group of this FileExportTemplates.

Returns: The group of this FileExportTemplates.
Return type: char

project¶

Gets the project of this FileExportTemplates.

Returns: The project of this FileExportTemplates.
Return type: char

subject¶

Gets the subject of this FileExportTemplates.

Returns: The subject of this FileExportTemplates.
Return type: char

session¶

Gets the session of this FileExportTemplates.

Returns: The session of this FileExportTemplates.
Return type: char

acquisition¶

Gets the acquisition of this FileExportTemplates.

Returns: The acquisition of this FileExportTemplates.
Return type: char

FileFormat¶

An enumeration.

class FileFormat¶: An enumeration.

FileGearInfo¶

class FileGearInfo¶

name¶

Gets the name of this FileGearInfo.

Returns: The name of this FileGearInfo.
Return type: char

version¶

Gets the version of this FileGearInfo.

Returns: The version of this FileGearInfo.
Return type: char

id¶

Gets the id of this FileGearInfo.

Returns: The id of this FileGearInfo.
Return type: char

FileGroup¶

An enumeration.

class FileGroup¶: An enumeration.

FileListOutput¶

class FileListOutput¶

id¶

Gets the id of this FileListOutput.

Returns: The id of this FileListOutput.
Return type: char

name¶

Gets the name of this FileListOutput.

Returns: The name of this FileListOutput.
Return type: char

type¶

Gets the type of this FileListOutput.

Returns: The type of this FileListOutput.
Return type: char

mimetype¶

Gets the mimetype of this FileListOutput.

Returns: The mimetype of this FileListOutput.
Return type: char

fileId¶

Gets the fileId of this FileListOutput.

Returns: The fileId of this FileListOutput.
Return type: char

version¶

Gets the version of this FileListOutput.

Returns: The version of this FileListOutput.
Return type: integer

modality¶

Gets the modality of this FileListOutput.

Returns: The modality of this FileListOutput.
Return type: char

deidLogId¶

Gets the deidLogId of this FileListOutput.

Returns: The deidLogId of this FileListOutput.
Return type: char

deidLogSkipReason¶

Gets the deidLogSkipReason of this FileListOutput.

Returns: The deidLogSkipReason of this FileListOutput.
Return type: DeidLogSkipReason

classification¶

Gets the classification of this FileListOutput.

Returns: The classification of this FileListOutput.
Return type: containers.Map[String, vector[char]]

tags¶

Gets the tags of this FileListOutput.

Returns: The tags of this FileListOutput.
Return type: vector[char]

providerId¶

Gets the providerId of this FileListOutput.

Returns: The providerId of this FileListOutput.
Return type: char

path¶

Gets the path of this FileListOutput.

Returns: The path of this FileListOutput.
Return type: char

reference¶

Gets the reference of this FileListOutput.

Returns: The reference of this FileListOutput.
Return type: logical

restoredFrom¶

Gets the restoredFrom of this FileListOutput.

Returns: The restoredFrom of this FileListOutput.
Return type: integer

restoredBy¶

Gets the restoredBy of this FileListOutput.

Returns: The restoredBy of this FileListOutput.
Return type: Origin

parentRef¶

Gets the parentRef of this FileListOutput.

Returns: The parentRef of this FileListOutput.
Return type: ContainerReference

parents¶

Gets the parents of this FileListOutput.

Returns: The parents of this FileListOutput.
Return type: FileParents

origin¶

Gets the origin of this FileListOutput.

Returns: The origin of this FileListOutput.
Return type: Origin

virusScan¶

Gets the virusScan of this FileListOutput.

Returns: The virusScan of this FileListOutput.
Return type: VirusScan

created¶

Gets the created of this FileListOutput.

Returns: The created of this FileListOutput.
Return type: datetime

modified¶

Gets the modified of this FileListOutput.

Returns: The modified of this FileListOutput.
Return type: datetime

replaced¶

Gets the replaced of this FileListOutput.

Returns: The replaced of this FileListOutput.
Return type: datetime

deleted¶

Gets the deleted of this FileListOutput.

Returns: The deleted of this FileListOutput.
Return type: datetime

size¶

Gets the size of this FileListOutput.

Returns: The size of this FileListOutput.
Return type: integer

hash¶

Gets the hash of this FileListOutput.

Returns: The hash of this FileListOutput.
Return type: char

info¶

Gets the info of this FileListOutput.

Returns: The info of this FileListOutput.
Return type: containers.Map

infoExists¶

Gets the infoExists of this FileListOutput.

Returns: The infoExists of this FileListOutput.
Return type: logical

zipMemberCount¶

Gets the zipMemberCount of this FileListOutput.

Returns: The zipMemberCount of this FileListOutput.
Return type: integer

gearInfo¶

Gets the gearInfo of this FileListOutput.

Returns: The gearInfo of this FileListOutput.
Return type: FileGearInfo

copyOf¶

Gets the copyOf of this FileListOutput.

Returns: The copyOf of this FileListOutput.
Return type: FileVersionCopyOf

originalCopyOf¶

Gets the originalCopyOf of this FileListOutput.

Returns: The originalCopyOf of this FileListOutput.
Return type: FileVersion

clientHash¶

Gets the clientHash of this FileListOutput.

Returns: The clientHash of this FileListOutput.
Return type: char

FileModifyInput¶

User input for modifying a file

class FileModifyInput¶

User input for modifying a file

type¶

Gets the type of this FileModifyInput.

Returns: The type of this FileModifyInput.
Return type: char

modality¶

Gets the modality of this FileModifyInput.

Returns: The modality of this FileModifyInput.
Return type: char

FileMoveInput¶

class FileMoveInput¶

containerReference¶

Gets the containerReference of this FileMoveInput.

Returns: The containerReference of this FileMoveInput.
Return type: ContainerReference

name¶

Gets the name of this FileMoveInput.

Returns: The name of this FileMoveInput.
Return type: char

runGearRules¶

Gets the runGearRules of this FileMoveInput.

Returns: The runGearRules of this FileMoveInput.
Return type: logical

FileNode¶

class FileNode¶

id¶

Gets the id of this FileNode.

Returns: The id of this FileNode.
Return type: char

name¶

Gets the name of this FileNode.

Returns: The name of this FileNode.
Return type: char

type¶

Gets the type of this FileNode.

Returns: The type of this FileNode.
Return type: char

mimetype¶

Gets the mimetype of this FileNode.

Returns: The mimetype of this FileNode.
Return type: char

fileId¶

Gets the fileId of this FileNode.

Returns: The fileId of this FileNode.
Return type: char

version¶

Gets the version of this FileNode.

Returns: The version of this FileNode.
Return type: integer

modality¶

Gets the modality of this FileNode.

Returns: The modality of this FileNode.
Return type: char

deidLogId¶

Gets the deidLogId of this FileNode.

Returns: The deidLogId of this FileNode.
Return type: char

deidLogSkipReason¶

Gets the deidLogSkipReason of this FileNode.

Returns: The deidLogSkipReason of this FileNode.
Return type: DeidLogSkipReason

classification¶

Gets the classification of this FileNode.

Returns: The classification of this FileNode.
Return type: containers.Map[String, vector[char]]

tags¶

Gets the tags of this FileNode.

Returns: The tags of this FileNode.
Return type: vector[char]

providerId¶

Gets the providerId of this FileNode.

Returns: The providerId of this FileNode.
Return type: char

path¶

Gets the path of this FileNode.

Returns: The path of this FileNode.
Return type: char

reference¶

Gets the reference of this FileNode.

Returns: The reference of this FileNode.
Return type: logical

restoredFrom¶

Gets the restoredFrom of this FileNode.

Returns: The restoredFrom of this FileNode.
Return type: integer

restoredBy¶

Gets the restoredBy of this FileNode.

Returns: The restoredBy of this FileNode.
Return type: Origin

parentRef¶

Gets the parentRef of this FileNode.

Returns: The parentRef of this FileNode.
Return type: ContainerReference

parents¶

Gets the parents of this FileNode.

Returns: The parents of this FileNode.
Return type: FileParents

origin¶

Gets the origin of this FileNode.

Returns: The origin of this FileNode.
Return type: Origin

virusScan¶

Gets the virusScan of this FileNode.

Returns: The virusScan of this FileNode.
Return type: VirusScan

created¶

Gets the created of this FileNode.

Returns: The created of this FileNode.
Return type: datetime

modified¶

Gets the modified of this FileNode.

Returns: The modified of this FileNode.
Return type: datetime

replaced¶

Gets the replaced of this FileNode.

Returns: The replaced of this FileNode.
Return type: datetime

deleted¶

Gets the deleted of this FileNode.

Returns: The deleted of this FileNode.
Return type: datetime

size¶

Gets the size of this FileNode.

Returns: The size of this FileNode.
Return type: integer

hash¶

Gets the hash of this FileNode.

Returns: The hash of this FileNode.
Return type: char

info¶

Gets the info of this FileNode.

Returns: The info of this FileNode.
Return type: containers.Map

infoExists¶

Gets the infoExists of this FileNode.

Returns: The infoExists of this FileNode.
Return type: logical

zipMemberCount¶

Gets the zipMemberCount of this FileNode.

Returns: The zipMemberCount of this FileNode.
Return type: integer

gearInfo¶

Gets the gearInfo of this FileNode.

Returns: The gearInfo of this FileNode.
Return type: FileGearInfo

copyOf¶

Gets the copyOf of this FileNode.

Returns: The copyOf of this FileNode.
Return type: FileVersionCopyOf

originalCopyOf¶

Gets the originalCopyOf of this FileNode.

Returns: The originalCopyOf of this FileNode.
Return type: FileVersion

clientHash¶

Gets the clientHash of this FileNode.

Returns: The clientHash of this FileNode.
Return type: char

FileNodeMin¶

Special case for min files.

class FileNodeMin¶

Special case for min files.

id¶

Gets the id of this FileNodeMin.

Returns: The id of this FileNodeMin.
Return type: char

name¶

Gets the name of this FileNodeMin.

Returns: The name of this FileNodeMin.
Return type: char

size¶

Gets the size of this FileNodeMin.

Returns: The size of this FileNodeMin.
Return type: integer

created¶

Gets the created of this FileNodeMin.

Returns: The created of this FileNodeMin.
Return type: datetime

modified¶

Gets the modified of this FileNodeMin.

Returns: The modified of this FileNodeMin.
Return type: datetime

containerType¶

Gets the containerType of this FileNodeMin.

Returns: The containerType of this FileNodeMin.
Return type: char

nodeType¶

Gets the nodeType of this FileNodeMin.

Returns: The nodeType of this FileNodeMin.
Return type: char

FileOrigin¶

class FileOrigin¶

id¶

Database ID of joined name and method

Returns: The id of this FileOrigin.
Return type: char

method¶

Method of file origin

Returns: The method of this FileOrigin.
Return type: char

type¶

Type of file origin (e.g. device, user, job)

Returns: The type of this FileOrigin.
Return type: char

name¶

Name of device, user or job that originated the file

Returns: The name of this FileOrigin.
Return type: char

via¶

Gets the via of this FileOrigin.

Returns: The via of this FileOrigin.
Return type: FileVia

FileOutput¶

class FileOutput¶

id¶

Gets the id of this FileOutput.

Returns: The id of this FileOutput.
Return type: char

name¶

Gets the name of this FileOutput.

Returns: The name of this FileOutput.
Return type: char

type¶

Gets the type of this FileOutput.

Returns: The type of this FileOutput.
Return type: char

fileId¶

Gets the fileId of this FileOutput.

Returns: The fileId of this FileOutput.
Return type: char

version¶

Gets the version of this FileOutput.

Returns: The version of this FileOutput.
Return type: integer

mimetype¶

Gets the mimetype of this FileOutput.

Returns: The mimetype of this FileOutput.
Return type: char

modality¶

Gets the modality of this FileOutput.

Returns: The modality of this FileOutput.
Return type: char

deidLogId¶

Gets the deidLogId of this FileOutput.

Returns: The deidLogId of this FileOutput.
Return type: char

deidLogSkipReason¶

Gets the deidLogSkipReason of this FileOutput.

Returns: The deidLogSkipReason of this FileOutput.
Return type: DeidLogSkipReason

classification¶

Gets the classification of this FileOutput.

Returns: The classification of this FileOutput.
Return type: containers.Map[String, vector[char]]

tags¶

Gets the tags of this FileOutput.

Returns: The tags of this FileOutput.
Return type: vector[char]

providerId¶

Gets the providerId of this FileOutput.

Returns: The providerId of this FileOutput.
Return type: char

parentRef¶

Gets the parentRef of this FileOutput.

Returns: The parentRef of this FileOutput.
Return type: ContainerReference

parents¶

Gets the parents of this FileOutput.

Returns: The parents of this FileOutput.
Return type: FileParents

restoredFrom¶

Gets the restoredFrom of this FileOutput.

Returns: The restoredFrom of this FileOutput.
Return type: integer

restoredBy¶

Gets the restoredBy of this FileOutput.

Returns: The restoredBy of this FileOutput.
Return type: Origin

path¶

Gets the path of this FileOutput.

Returns: The path of this FileOutput.
Return type: char

reference¶

Gets the reference of this FileOutput.

Returns: The reference of this FileOutput.
Return type: logical

origin¶

Gets the origin of this FileOutput.

Returns: The origin of this FileOutput.
Return type: Origin

virusScan¶

Gets the virusScan of this FileOutput.

Returns: The virusScan of this FileOutput.
Return type: VirusScan

created¶

Gets the created of this FileOutput.

Returns: The created of this FileOutput.
Return type: datetime

modified¶

Gets the modified of this FileOutput.

Returns: The modified of this FileOutput.
Return type: datetime

replaced¶

Gets the replaced of this FileOutput.

Returns: The replaced of this FileOutput.
Return type: datetime

deleted¶

Gets the deleted of this FileOutput.

Returns: The deleted of this FileOutput.
Return type: datetime

size¶

Gets the size of this FileOutput.

Returns: The size of this FileOutput.
Return type: integer

hash¶

Gets the hash of this FileOutput.

Returns: The hash of this FileOutput.
Return type: char

clientHash¶

Gets the clientHash of this FileOutput.

Returns: The clientHash of this FileOutput.
Return type: char

info¶

Gets the info of this FileOutput.

Returns: The info of this FileOutput.
Return type: containers.Map

infoExists¶

Gets the infoExists of this FileOutput.

Returns: The infoExists of this FileOutput.
Return type: logical

zipMemberCount¶

Gets the zipMemberCount of this FileOutput.

Returns: The zipMemberCount of this FileOutput.
Return type: integer

gearInfo¶

Gets the gearInfo of this FileOutput.

Returns: The gearInfo of this FileOutput.
Return type: FileGearInfo

copyOf¶

Gets the copyOf of this FileOutput.

Returns: The copyOf of this FileOutput.
Return type: FileVersionCopyOf

originalCopyOf¶

Gets the originalCopyOf of this FileOutput.

Returns: The originalCopyOf of this FileOutput.
Return type: FileVersion

FileParents¶

class FileParents¶

group¶

Gets the group of this FileParents.

Returns: The group of this FileParents.
Return type: char

project¶

Gets the project of this FileParents.

Returns: The project of this FileParents.
Return type: char

subject¶

Gets the subject of this FileParents.

Returns: The subject of this FileParents.
Return type: char

session¶

Gets the session of this FileParents.

Returns: The session of this FileParents.
Return type: char

acquisition¶

Gets the acquisition of this FileParents.

Returns: The acquisition of this FileParents.
Return type: char

analysis¶

Gets the analysis of this FileParents.

Returns: The analysis of this FileParents.
Return type: char

FileReference¶

A reference to an individual file in a container, by type, id and name

class FileReference¶

A reference to an individual file in a container, by type, id and name

type¶

The type of container (e.g. session)

Returns: The type of this FileReference.
Return type: char

id¶

Unique database ID

Returns: The id of this FileReference.
Return type: char

name¶

The name of the file on disk

Returns: The name of this FileReference.
Return type: char

FileSuggestion¶

class FileSuggestion¶

name¶

Gets the name of this FileSuggestion.

Returns: The name of this FileSuggestion.
Return type: char

fileId¶

Gets the fileId of this FileSuggestion.

Returns: The fileId of this FileSuggestion.
Return type: char

version¶

Gets the version of this FileSuggestion.

Returns: The version of this FileSuggestion.
Return type: integer

suggested¶

Gets the suggested of this FileSuggestion.

Returns: The suggested of this FileSuggestion.
Return type: containers.Map[String, logical]

FileTemplateOptions¶

class FileTemplateOptions¶

minimum¶

Gets the minimum of this FileTemplateOptions.

Returns: The minimum of this FileTemplateOptions.
Return type: integer

maximum¶

Gets the maximum of this FileTemplateOptions.

Returns: The maximum of this FileTemplateOptions.
Return type: integer

mimetype¶

Gets the mimetype of this FileTemplateOptions.

Returns: The mimetype of this FileTemplateOptions.
Return type: char

modality¶

Gets the modality of this FileTemplateOptions.

Returns: The modality of this FileTemplateOptions.
Return type: char

tags¶

Gets the tags of this FileTemplateOptions.

Returns: The tags of this FileTemplateOptions.
Return type: char

classification¶

Gets the classification of this FileTemplateOptions.

Returns: The classification of this FileTemplateOptions.
Return type: char

FileUpsertInput¶

File upsert payload

class FileUpsertInput¶

File upsert payload

parentRef¶

Gets the parentRef of this FileUpsertInput.

Returns: The parentRef of this FileUpsertInput.
Return type: ContainerReference

providerId¶

Unique database ID

Returns: The providerId of this FileUpsertInput.
Return type: char

uuid¶

Hyphen-separated universally unique identifier

Returns: The uuid of this FileUpsertInput.
Return type: char

path¶

Gets the path of this FileUpsertInput.

Returns: The path of this FileUpsertInput.
Return type: char

reference¶

Gets the reference of this FileUpsertInput.

Returns: The reference of this FileUpsertInput.
Return type: logical

clientHash¶

Gets the clientHash of this FileUpsertInput.

Returns: The clientHash of this FileUpsertInput.
Return type: char

origin¶

Gets the origin of this FileUpsertInput.

Returns: The origin of this FileUpsertInput.
Return type: FileUpsertOrigin

name¶

The name of the file on disk

Returns: The name of this FileUpsertInput.
Return type: char

type¶

A descriptive file type (e.g. dicom, image, document, …)

Returns: The type of this FileUpsertInput.
Return type: char

mimetype¶

A MIME Content-Type of the file

Returns: The mimetype of this FileUpsertInput.
Return type: char

modality¶

The type of instrument that originated the file (e.g. MR, CT, …)

Returns: The modality of this FileUpsertInput.
Return type: char

classification¶

Gets the classification of this FileUpsertInput.

Returns: The classification of this FileUpsertInput.
Return type: CommonClassification

info¶

Gets the info of this FileUpsertInput.

Returns: The info of this FileUpsertInput.
Return type: CommonInfo

zipMemberCount¶

Number of entries in the zip archive

Returns: The zipMemberCount of this FileUpsertInput.
Return type: integer

deidLogId¶

The UUID of the de-id log

Returns: The deidLogId of this FileUpsertInput.
Return type: char

deidLogSkipReason¶

Gets the deidLogSkipReason of this FileUpsertInput.

Returns: The deidLogSkipReason of this FileUpsertInput.
Return type: char

FileUpsertOrigin¶

class FileUpsertOrigin¶

type¶

Gets the type of this FileUpsertOrigin.

Returns: The type of this FileUpsertOrigin.
Return type: char

id¶

Gets the id of this FileUpsertOrigin.

Returns: The id of this FileUpsertOrigin.
Return type: char

FileUpsertOutput¶

File upsert payload

class FileUpsertOutput¶

File upsert payload

parentRef¶

Gets the parentRef of this FileUpsertOutput.

Returns: The parentRef of this FileUpsertOutput.
Return type: ContainerReference

providerId¶

Unique database ID

Returns: The providerId of this FileUpsertOutput.
Return type: char

uuid¶

Hyphen-separated universally unique identifier

Returns: The uuid of this FileUpsertOutput.
Return type: char

path¶

Gets the path of this FileUpsertOutput.

Returns: The path of this FileUpsertOutput.
Return type: char

reference¶

Gets the reference of this FileUpsertOutput.

Returns: The reference of this FileUpsertOutput.
Return type: logical

clientHash¶

Gets the clientHash of this FileUpsertOutput.

Returns: The clientHash of this FileUpsertOutput.
Return type: char

origin¶

Gets the origin of this FileUpsertOutput.

Returns: The origin of this FileUpsertOutput.
Return type: FileUpsertOrigin

name¶

The name of the file on disk

Returns: The name of this FileUpsertOutput.
Return type: char

type¶

A descriptive file type (e.g. dicom, image, document, …)

Returns: The type of this FileUpsertOutput.
Return type: char

mimetype¶

A MIME Content-Type of the file

Returns: The mimetype of this FileUpsertOutput.
Return type: char

modality¶

The type of instrument that originated the file (e.g. MR, CT, …)

Returns: The modality of this FileUpsertOutput.
Return type: char

classification¶

Gets the classification of this FileUpsertOutput.

Returns: The classification of this FileUpsertOutput.
Return type: CommonClassification

info¶

Gets the info of this FileUpsertOutput.

Returns: The info of this FileUpsertOutput.
Return type: CommonInfo

zipMemberCount¶

Number of entries in the zip archive

Returns: The zipMemberCount of this FileUpsertOutput.
Return type: integer

deidLogId¶

The UUID of the de-id log

Returns: The deidLogId of this FileUpsertOutput.
Return type: char

deidLogSkipReason¶

Gets the deidLogSkipReason of this FileUpsertOutput.

Returns: The deidLogSkipReason of this FileUpsertOutput.
Return type: char

FileVersion¶

Primary file index, used by new standalone “/file/…” endpoints.

class FileVersion¶

Primary file index, used by new standalone “/file/…” endpoints.

fileId¶

Gets the fileId of this FileVersion.

Returns: The fileId of this FileVersion.
Return type: char

version¶

Gets the version of this FileVersion.

Returns: The version of this FileVersion.
Return type: integer

FileVersionCopyOf¶

Used to display a copied files version and metadata.

class FileVersionCopyOf¶

Used to display a copied files version and metadata.

fileId¶

Gets the fileId of this FileVersionCopyOf.

Returns: The fileId of this FileVersionCopyOf.
Return type: char

version¶

Gets the version of this FileVersionCopyOf.

Returns: The version of this FileVersionCopyOf.
Return type: integer

parents¶

Gets the parents of this FileVersionCopyOf.

Returns: The parents of this FileVersionCopyOf.
Return type: FileParents

projectLabel¶

Gets the projectLabel of this FileVersionCopyOf.

Returns: The projectLabel of this FileVersionCopyOf.
Return type: char

groupLabel¶

Gets the groupLabel of this FileVersionCopyOf.

Returns: The groupLabel of this FileVersionCopyOf.
Return type: char

FileVersionOutput¶

Used by frontend to display all versions of a file

class FileVersionOutput¶

Used by frontend to display all versions of a file

created¶

Creation time (automatically set)

Returns: The created of this FileVersionOutput.
Return type: datetime

deleted¶

Deleted time (automatically set on delete)

Returns: The deleted of this FileVersionOutput.
Return type: datetime

fileId¶

Unique database ID

Returns: The fileId of this FileVersionOutput.
Return type: char

origin¶

Gets the origin of this FileVersionOutput.

Returns: The origin of this FileVersionOutput.
Return type: FileOrigin

version¶

Gets the version of this FileVersionOutput.

Returns: The version of this FileVersionOutput.
Return type: integer

FileVia¶

class FileVia¶

id¶

Gets the id of this FileVia.

Returns: The id of this FileVia.
Return type: char

method¶

Gets the method of this FileVia.

Returns: The method of this FileVia.
Return type: char

type¶

Gets the type of this FileVia.

Returns: The type of this FileVia.
Return type: char

name¶

Gets the name of this FileVia.

Returns: The name of this FileVia.
Return type: char

FileZipEntry¶

class FileZipEntry¶

FileZipInfo¶

class FileZipInfo¶

FilterValues¶

class FilterValues¶

plus¶

A list of items to include or exclude from a download

Returns: The plus of this FilterValues.
Return type: vector[char]

minus¶

A list of items to include or exclude from a download

Returns: The minus of this FilterValues.
Return type: vector[char]

FixedFileVersionInput¶

Primary file index, used by new standalone “/file/…” endpoints.

class FixedFileVersionInput¶

Primary file index, used by new standalone “/file/…” endpoints.

fileId¶

Gets the fileId of this FixedFileVersionInput.

Returns: The fileId of this FixedFileVersionInput.
Return type: char

version¶

Gets the version of this FixedFileVersionInput.

Returns: The version of this FixedFileVersionInput.
Return type: integer

input¶

Gets the input of this FixedFileVersionInput.

Returns: The input of this FixedFileVersionInput.
Return type: char

FixedInput¶

Container and name associated with file, used by old container-based file endpoints. (Could have used a ContainerReference for the first two)

class FixedInput¶

Container and name associated with file, used by old container-based file endpoints. (Could have used a ContainerReference for the first two)

type¶

Gets the type of this FixedInput.

Returns: The type of this FixedInput.
Return type: ContainerType

id¶

Gets the id of this FixedInput.

Returns: The id of this FixedInput.
Return type: char

name¶

Gets the name of this FixedInput.

Returns: The name of this FixedInput.
Return type: char

version¶

Gets the version of this FixedInput.

Returns: The version of this FixedInput.
Return type: integer

input¶

Gets the input of this FixedInput.

Returns: The input of this FixedInput.
Return type: char

FormDefinition¶

Holds Form.io schema only. Will be extended as needed later

class FormDefinition¶

Holds Form.io schema only. Will be extended as needed later

components¶

Gets the components of this FormDefinition.

Returns: The components of this FormDefinition.
Return type: vector[containers.Map]

GcpCreds¶

class GcpCreds¶

clientEmail¶

Gets the clientEmail of this GcpCreds.

Returns: The clientEmail of this GcpCreds.
Return type: char

clientId¶

Gets the clientId of this GcpCreds.

Returns: The clientId of this GcpCreds.
Return type: char

privateKeyId¶

Gets the privateKeyId of this GcpCreds.

Returns: The privateKeyId of this GcpCreds.
Return type: char

privateKey¶

Gets the privateKey of this GcpCreds.

Returns: The privateKey of this GcpCreds.
Return type: char

clientX509CertUrl¶

Gets the clientX509CertUrl of this GcpCreds.

Returns: The clientX509CertUrl of this GcpCreds.
Return type: char

projectId¶

Gets the projectId of this GcpCreds.

Returns: The projectId of this GcpCreds.
Return type: char

authUri¶

Gets the authUri of this GcpCreds.

Returns: The authUri of this GcpCreds.
Return type: char

tokenUri¶

Gets the tokenUri of this GcpCreds.

Returns: The tokenUri of this GcpCreds.
Return type: char

authProviderX509CertUrl¶

Gets the authProviderX509CertUrl of this GcpCreds.

Returns: The authProviderX509CertUrl of this GcpCreds.
Return type: char

type¶

Gets the type of this GcpCreds.

Returns: The type of this GcpCreds.
Return type: char

GcpStorage¶

class GcpStorage¶

region¶

Gets the region of this GcpStorage.

Returns: The region of this GcpStorage.
Return type: char

bucket¶

Gets the bucket of this GcpStorage.

Returns: The bucket of this GcpStorage.
Return type: char

path¶

Gets the path of this GcpStorage.

Returns: The path of this GcpStorage.
Return type: char

zone¶

Gets the zone of this GcpStorage.

Returns: The zone of this GcpStorage.
Return type: char

configType¶

Gets the configType of this GcpStorage.

Returns: The configType of this GcpStorage.
Return type: char

configClass¶

Gets the configClass of this GcpStorage.

Returns: The configClass of this GcpStorage.
Return type: char

Gear¶

Gear manifest

class Gear¶

Gear manifest

author¶

The author of this gear.

Returns: The author of this Gear.
Return type: char

capabilities¶

Gets the capabilities of this Gear.

Returns: The capabilities of this Gear.
Return type: vector[char]

maintainer¶

(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: char

cite¶

(optional) Any citations relevant to the algorithm(s) or work present in the gear.

Returns: The cite of this Gear.
Return type: char

config¶

Gets the config of this Gear.

Returns: The config of this Gear.
Return type: GearConfig

custom¶

Gets the custom of this Gear.

Returns: The custom of this Gear.
Return type: GearCustom

description¶

A brief description of the gear’s purpose. Ideally 1-4 sentences.

Returns: The description of this Gear.
Return type: char

environment¶

Gets the environment of this Gear.

Returns: The environment of this Gear.
Return type: GearEnvironment

flywheel¶

Gets the flywheel of this Gear.

Returns: The flywheel of this Gear.
Return type: containers.Map

command¶

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

inputs¶

Gets the inputs of this Gear.

Returns: The inputs of this Gear.
Return type: GearInputs

label¶

The human-friendly name of this gear.

Returns: The label of this Gear.
Return type: char

license¶

Software license of the gear

Returns: The license of this Gear.
Return type: char

name¶

The identification of this gear.

Returns: The name of this Gear.
Return type: char

source¶

A valid URI, or empty string.

Returns: The source of this Gear.
Return type: char

url¶

A valid URI, or empty string.

Returns: The url of this Gear.
Return type: char

version¶

A human-friendly string explaining the release version of this gear. Example: 3.2.1

Returns: The version of this Gear.
Return type: char

GearCategory¶

Still gotta decide about this, right now there are no restrictions on gear categories

class GearCategory¶: Still gotta decide about this, right now there are no restrictions on gear categories

GearConfig¶

Schema snippets describing the options this gear consumes. Not currently processed.

class GearConfig¶: Schema snippets describing the options this gear consumes. Not currently processed.

GearContextInput¶

Represents a context-based input to a gear Attributes: base (str): The input type

class GearContextInput¶

Represents a context-based input to a gear Attributes: base (str): The input type

base¶

Gets the base of this GearContextInput.

Returns: The base of this GearContextInput.
Return type: char

GearContextLookup¶

class GearContextLookup¶

GearContextValueOutput¶

class GearContextValueOutput¶

containerType¶

Gets the containerType of this GearContextValueOutput.

Returns: The containerType of this GearContextValueOutput.
Return type: ContainerType

label¶

Gets the label of this GearContextValueOutput.

Returns: The label of this GearContextValueOutput.
Return type: char

id¶

Gets the id of this GearContextValueOutput.

Returns: The id of this GearContextValueOutput.
Return type: char

value¶

Gets the value of this GearContextValueOutput.

Returns: The value of this GearContextValueOutput.
Return type: containers.Map

found¶

Gets the found of this GearContextValueOutput.

Returns: The found of this GearContextValueOutput.
Return type: logical

GearContextValueOutputUnfound¶

class GearContextValueOutputUnfound¶

found¶

Gets the found of this GearContextValueOutputUnfound.

Returns: The found of this GearContextValueOutputUnfound.
Return type: logical

GearCustom¶

A place for gear authors to put arbitrary information.

class GearCustom¶: A place for gear authors to put arbitrary information.

GearDirective¶

A schema directive.

class GearDirective¶: A schema directive.

GearDoc¶

class GearDoc¶

GearDocument¶

class GearDocument¶

category¶

Gets the category of this GearDocument.

Returns: The category of this GearDocument.
Return type: AllOfGearDocumentCategory

gear¶

Gets the gear of this GearDocument.

Returns: The gear of this GearDocument.
Return type: GearManifest

exchange¶

Gets the exchange of this GearDocument.

Returns: The exchange of this GearDocument.
Return type: GearExchange

created¶

Gets the created of this GearDocument.

Returns: The created of this GearDocument.
Return type: datetime

modified¶

Gets the modified of this GearDocument.

Returns: The modified of this GearDocument.
Return type: datetime

disabled¶

Gets the disabled of this GearDocument.

Returns: The disabled of this GearDocument.
Return type: datetime

id¶

Gets the id of this GearDocument.

Returns: The id of this GearDocument.
Return type: char

GearDocumentInput¶

class GearDocumentInput¶

category¶

Gets the category of this GearDocumentInput.

Returns: The category of this GearDocumentInput.
Return type: AllOfGearDocumentInputCategory

gear¶

Gets the gear of this GearDocumentInput.

Returns: The gear of this GearDocumentInput.
Return type: GearManifest

exchange¶

Gets the exchange of this GearDocumentInput.

Returns: The exchange of this GearDocumentInput.
Return type: GearExchange

created¶

Gets the created of this GearDocumentInput.

Returns: The created of this GearDocumentInput.
Return type: datetime

modified¶

Gets the modified of this GearDocumentInput.

Returns: The modified of this GearDocumentInput.
Return type: datetime

disabled¶

Gets the disabled of this GearDocumentInput.

Returns: The disabled of this GearDocumentInput.
Return type: datetime

GearDocumentLegacyInput¶

class GearDocumentLegacyInput¶

category¶

Gets the category of this GearDocumentLegacyInput.

Returns: The category of this GearDocumentLegacyInput.
Return type: AllOfGearDocumentLegacyInputCategory

gear¶

Gets the gear of this GearDocumentLegacyInput.

Returns: The gear of this GearDocumentLegacyInput.
Return type: GearManifest

exchange¶

Gets the exchange of this GearDocumentLegacyInput.

Returns: The exchange of this GearDocumentLegacyInput.
Return type: GearExchange

created¶

Gets the created of this GearDocumentLegacyInput.

Returns: The created of this GearDocumentLegacyInput.
Return type: datetime

modified¶

Gets the modified of this GearDocumentLegacyInput.

Returns: The modified of this GearDocumentLegacyInput.
Return type: datetime

disabled¶

Gets the disabled of this GearDocumentLegacyInput.

Returns: The disabled of this GearDocumentLegacyInput.
Return type: datetime

GearEnvironment¶

Environment variables that should be set for the gear.

class GearEnvironment¶: Environment variables that should be set for the gear.

GearExchange¶

Metadata object that describes the origin of a gear version

class GearExchange¶

Metadata object that describes the origin of a gear version

gitCommit¶

The SHA-1 hash referring to the git commit

Returns: The gitCommit of this GearExchange.
Return type: char

rootfsHash¶

The cryptographic hash of the root filesystem in the form of “algorithm:<base16 hash>”

Returns: The rootfsHash of this GearExchange.
Return type: char

rootfsUrl¶

The absolute URL of the gear’s root file system

Returns: The rootfsUrl of this GearExchange.
Return type: char

GearFileInput¶

Represents a gear file input for a gear Attributes: base (str): The input type optional (bool): A bool representing an required decision

class GearFileInput¶

Represents a gear file input for a gear Attributes: base (str): The input type optional (bool): A bool representing an required decision

base¶

Gets the base of this GearFileInput.

Returns: The base of this GearFileInput.
Return type: char

optional¶

Gets the optional of this GearFileInput.

Returns: The optional of this GearFileInput.
Return type: logical

GearIdOutput¶

class GearIdOutput¶

id¶

Gets the id of this GearIdOutput.

Returns: The id of this GearIdOutput.
Return type: char

GearInfo¶

Optional information about a gear

class GearInfo¶

Optional information about a gear

id¶

Gets the id of this GearInfo.

Returns: The id of this GearInfo.
Return type: char

category¶

The gear category

Returns: The category of this GearInfo.
Return type: char

name¶

The identification of this gear.

Returns: The name of this GearInfo.
Return type: char

version¶

A human-friendly string explaining the release version of this gear. Example: 3.2.1

Returns: The version of this GearInfo.
Return type: char

GearInputItem¶

Describes a gear input

class GearInputItem¶

Describes a gear input

base¶

The type of gear input.

Returns: The base of this GearInputItem.
Return type: char

description¶

Hackaround for description not technically being a schema directive

Returns: The description of this GearInputItem.
Return type: char

optional¶

Allow the gear to mark an input file as optional.

Returns: The optional of this GearInputItem.
Return type: logical

GearInputs¶

Schema snippets describing the inputs this gear consumes.

class GearInputs¶: Schema snippets describing the inputs this gear consumes.

GearKeyInput¶

Represents a key-based input to a gear Attributes: base (str): The input type read_only (bool): A bool representing a read only decision

class GearKeyInput¶

Represents a key-based input to a gear Attributes: base (str): The input type read_only (bool): A bool representing a read only decision

base¶

Gets the base of this GearKeyInput.

Returns: The base of this GearKeyInput.
Return type: char

readOnly¶

Gets the readOnly of this GearKeyInput.

Returns: The readOnly of this GearKeyInput.
Return type: logical

GearManifest¶

Representation of a gear manifest Attributes: name (str): The name of the gear inputs (Dict[str, Union[Inputs]]): The input for the gear config (dict): The config for gear options custom (dict): A place for custom information author (str): The name of the author maintainer (Optional[str]): The name of the maintainer of the gear cite (Optional[str]): Any citations relevent to the gear capabilities: The capabilities of the gear description (Optional[str]): A description of the gears purpose environment (Optional[Dict[str, str]]): Environent variables that should be set for the gear command (Optional[str]): The starting command for the gear license (List[LicenseType]): The name of the license that applies to this gear label (Optional[str]): The label of the gear url (Optional[str]): The url where more information about this gear can be found source (Optional[str]): The url where the source code of this gear can be found version (Optional[str]): An explanation of the relase of this gear version flywheel (Optional[dict]): A currently unused key

class GearManifest¶

Representation of a gear manifest Attributes: name (str): The name of the gear inputs (Dict[str, Union[Inputs]]): The input for the gear config (dict): The config for gear options custom (dict): A place for custom information author (str): The name of the author maintainer (Optional[str]): The name of the maintainer of the gear cite (Optional[str]): Any citations relevent to the gear capabilities: The capabilities of the gear description (Optional[str]): A description of the gears purpose environment (Optional[Dict[str, str]]): Environent variables that should be set for the gear command (Optional[str]): The starting command for the gear license (List[LicenseType]): The name of the license that applies to this gear label (Optional[str]): The label of the gear url (Optional[str]): The url where more information about this gear can be found source (Optional[str]): The url where the source code of this gear can be found version (Optional[str]): An explanation of the relase of this gear version flywheel (Optional[dict]): A currently unused key

name¶

Gets the name of this GearManifest.

Returns: The name of this GearManifest.
Return type: char

inputs¶

Gets the inputs of this GearManifest.

Returns: The inputs of this GearManifest.
Return type: Object

config¶

Gets the config of this GearManifest.

Returns: The config of this GearManifest.
Return type: containers.Map

custom¶

Gets the custom of this GearManifest.

Returns: The custom of this GearManifest.
Return type: containers.Map

author¶

Gets the author of this GearManifest.

Returns: The author of this GearManifest.
Return type: char

maintainer¶

Gets the maintainer of this GearManifest.

Returns: The maintainer of this GearManifest.
Return type: char

cite¶

Gets the cite of this GearManifest.

Returns: The cite of this GearManifest.
Return type: char

capabilities¶

Gets the capabilities of this GearManifest.

Returns: The capabilities of this GearManifest.
Return type: vector[char]

description¶

Gets the description of this GearManifest.

Returns: The description of this GearManifest.
Return type: char

environment¶

Gets the environment of this GearManifest.

Returns: The environment of this GearManifest.
Return type: containers.Map[String, char]

command¶

Gets the command of this GearManifest.

Returns: The command of this GearManifest.
Return type: char

license¶

Gets the license of this GearManifest.

Returns: The license of this GearManifest.
Return type: char

label¶

Gets the label of this GearManifest.

Returns: The label of this GearManifest.
Return type: char

url¶

Gets the url of this GearManifest.

Returns: The url of this GearManifest.
Return type: char

source¶

Gets the source of this GearManifest.

Returns: The source of this GearManifest.
Return type: char

version¶

Gets the version of this GearManifest.

Returns: The version of this GearManifest.
Return type: char

flywheel¶

Gets the flywheel of this GearManifest.

Returns: The flywheel of this GearManifest.
Return type: containers.Map

GearNode¶

class GearNode¶

category¶

Gets the category of this GearNode.

Returns: The category of this GearNode.
Return type: Object

gear¶

Gets the gear of this GearNode.

Returns: The gear of this GearNode.
Return type: GearManifest

exchange¶

Gets the exchange of this GearNode.

Returns: The exchange of this GearNode.
Return type: GearExchange

created¶

Gets the created of this GearNode.

Returns: The created of this GearNode.
Return type: datetime

modified¶

Gets the modified of this GearNode.

Returns: The modified of this GearNode.
Return type: datetime

disabled¶

Gets the disabled of this GearNode.

Returns: The disabled of this GearNode.
Return type: datetime

id¶

Gets the id of this GearNode.

Returns: The id of this GearNode.
Return type: char

GearPermissions¶

class GearPermissions¶

users¶

Gets the users of this GearPermissions.

Returns: The users of this GearPermissions.
Return type: vector[char]

projects¶

Gets the projects of this GearPermissions.

Returns: The projects of this GearPermissions.
Return type: vector[char]

GearPermissionsInput¶

class GearPermissionsInput¶

id¶

Gets the id of this GearPermissionsInput.

Returns: The id of this GearPermissionsInput.
Return type: char

GearPermissionsType¶

An enumeration.

class GearPermissionsType¶: An enumeration.

GearReturnTicket¶

class GearReturnTicket¶

GearRule¶

Domain model for a gear rule Attributes: id (str): The id of the rule project_id (str): The id of the project the rule runs on or ‘site’ if it is a site wide rule template gear_id (str): The gear to run role_id (str): The id of the role name (str): The name of the gear rule config (Optional[dict]): The optional config for the gear fixed_inputs (List[FixedInput]): The fixed inputs for the gear run auto_update (bool): Flag to automatically update the gear version to the latest any (List[GearRuleCondition]): List of match criteria for a job to be created of which any one of must be matched to run the job all (List[GearRuleCondition]): List of match criteria for a job to be created of which all of must be matched to run the job not (List[GearRuleCondition]): List of match criteria for a job to be created of which none of must be matched to run the job disabled (bool): Rule will not be evaluated if set to true compute_provider_id (Optional[str]): Set the compute provider for the jobs

class GearRule¶

Domain model for a gear rule Attributes: id (str): The id of the rule project_id (str): The id of the project the rule runs on or ‘site’ if it is a site wide rule template gear_id (str): The gear to run role_id (str): The id of the role name (str): The name of the gear rule config (Optional[dict]): The optional config for the gear fixed_inputs (List[FixedInput]): The fixed inputs for the gear run auto_update (bool): Flag to automatically update the gear version to the latest any (List[GearRuleCondition]): List of match criteria for a job to be created of which any one of must be matched to run the job all (List[GearRuleCondition]): List of match criteria for a job to be created of which all of must be matched to run the job not (List[GearRuleCondition]): List of match criteria for a job to be created of which none of must be matched to run the job disabled (bool): Rule will not be evaluated if set to true compute_provider_id (Optional[str]): Set the compute provider for the jobs

id¶

Gets the id of this GearRule.

Returns: The id of this GearRule.
Return type: char

projectId¶

Gets the projectId of this GearRule.

Returns: The projectId of this GearRule.
Return type: char

gearId¶

Gets the gearId of this GearRule.

Returns: The gearId of this GearRule.
Return type: char

roleId¶

Gets the roleId of this GearRule.

Returns: The roleId of this GearRule.
Return type: char

name¶

Gets the name of this GearRule.

Returns: The name of this GearRule.
Return type: char

config¶

Gets the config of this GearRule.

Returns: The config of this GearRule.
Return type: containers.Map

fixedInputs¶

Gets the fixedInputs of this GearRule.

Returns: The fixedInputs of this GearRule.
Return type: FixedFileVersionInput

priority¶

Gets the priority of this GearRule.

Returns: The priority of this GearRule.
Return type: AllOfGearRulePriority

autoUpdate¶

Gets the autoUpdate of this GearRule.

Returns: The autoUpdate of this GearRule.
Return type: logical

revision¶

Gets the revision of this GearRule.

Returns: The revision of this GearRule.
Return type: integer

any¶

Gets the any of this GearRule.

Returns: The any of this GearRule.
Return type: GearRuleCondition

all¶

Gets the all of this GearRule.

Returns: The all of this GearRule.
Return type: GearRuleCondition

not¶

Gets the not of this GearRule.

Returns: The not of this GearRule.
Return type: GearRuleCondition

created¶

Gets the created of this GearRule.

Returns: The created of this GearRule.
Return type: datetime

modified¶

Gets the modified of this GearRule.

Returns: The modified of this GearRule.
Return type: datetime

disabled¶

Gets the disabled of this GearRule.

Returns: The disabled of this GearRule.
Return type: logical

computeProviderId¶

Gets the computeProviderId of this GearRule.

Returns: The computeProviderId of this GearRule.
Return type: char

lastModifiedBy¶

Gets the lastModifiedBy of this GearRule.

Returns: The lastModifiedBy of this GearRule.
Return type: Origin

triggeringInput¶

Gets the triggeringInput of this GearRule.

Returns: The triggeringInput of this GearRule.
Return type: char

GearRuleCondition¶

class GearRuleCondition¶

type¶

Gets the type of this GearRuleCondition.

Returns: The type of this GearRuleCondition.
Return type: GearRuleConditionType

value¶

Gets the value of this GearRuleCondition.

Returns: The value of this GearRuleCondition.
Return type: containers.Map

regex¶

Gets the regex of this GearRuleCondition.

Returns: The regex of this GearRuleCondition.
Return type: logical

GearRuleConditionType¶

An enumeration.

class GearRuleConditionType¶: An enumeration.

GearRuleInput¶

class GearRuleInput¶

projectId¶

Gets the projectId of this GearRuleInput.

Returns: The projectId of this GearRuleInput.
Return type: char

gearId¶

Gets the gearId of this GearRuleInput.

Returns: The gearId of this GearRuleInput.
Return type: char

roleId¶

Gets the roleId of this GearRuleInput.

Returns: The roleId of this GearRuleInput.
Return type: char

name¶

Gets the name of this GearRuleInput.

Returns: The name of this GearRuleInput.
Return type: char

config¶

Gets the config of this GearRuleInput.

Returns: The config of this GearRuleInput.
Return type: containers.Map

fixedInputs¶

Gets the fixedInputs of this GearRuleInput.

Returns: The fixedInputs of this GearRuleInput.
Return type: Object

priority¶

Gets the priority of this GearRuleInput.

Returns: The priority of this GearRuleInput.
Return type: AllOfGearRuleInputPriority

autoUpdate¶

Gets the autoUpdate of this GearRuleInput.

Returns: The autoUpdate of this GearRuleInput.
Return type: logical

any¶

Gets the any of this GearRuleInput.

Returns: The any of this GearRuleInput.
Return type: GearRuleCondition

all¶

Gets the all of this GearRuleInput.

Returns: The all of this GearRuleInput.
Return type: GearRuleCondition

not¶

Gets the not of this GearRuleInput.

Returns: The not of this GearRuleInput.
Return type: GearRuleCondition

disabled¶

Gets the disabled of this GearRuleInput.

Returns: The disabled of this GearRuleInput.
Return type: logical

computeProviderId¶

Gets the computeProviderId of this GearRuleInput.

Returns: The computeProviderId of this GearRuleInput.
Return type: char

triggeringInput¶

Gets the triggeringInput of this GearRuleInput.

Returns: The triggeringInput of this GearRuleInput.
Return type: char

GearRuleModifyInput¶

class GearRuleModifyInput¶

gearId¶

Gets the gearId of this GearRuleModifyInput.

Returns: The gearId of this GearRuleModifyInput.
Return type: char

roleId¶

Gets the roleId of this GearRuleModifyInput.

Returns: The roleId of this GearRuleModifyInput.
Return type: char

name¶

Gets the name of this GearRuleModifyInput.

Returns: The name of this GearRuleModifyInput.
Return type: char

config¶

Gets the config of this GearRuleModifyInput.

Returns: The config of this GearRuleModifyInput.
Return type: containers.Map

fixedInputs¶

Gets the fixedInputs of this GearRuleModifyInput.

Returns: The fixedInputs of this GearRuleModifyInput.
Return type: Object

priority¶

Gets the priority of this GearRuleModifyInput.

Returns: The priority of this GearRuleModifyInput.
Return type: JobPriority

autoUpdate¶

Gets the autoUpdate of this GearRuleModifyInput.

Returns: The autoUpdate of this GearRuleModifyInput.
Return type: logical

any¶

Gets the any of this GearRuleModifyInput.

Returns: The any of this GearRuleModifyInput.
Return type: GearRuleCondition

all¶

Gets the all of this GearRuleModifyInput.

Returns: The all of this GearRuleModifyInput.
Return type: GearRuleCondition

not¶

Gets the not of this GearRuleModifyInput.

Returns: The not of this GearRuleModifyInput.
Return type: GearRuleCondition

disabled¶

Gets the disabled of this GearRuleModifyInput.

Returns: The disabled of this GearRuleModifyInput.
Return type: logical

computeProviderId¶

Gets the computeProviderId of this GearRuleModifyInput.

Returns: The computeProviderId of this GearRuleModifyInput.
Return type: char

triggeringInput¶

Gets the triggeringInput of this GearRuleModifyInput.

Returns: The triggeringInput of this GearRuleModifyInput.
Return type: char

GearRuleOutput¶

class GearRuleOutput¶

id¶

Gets the id of this GearRuleOutput.

Returns: The id of this GearRuleOutput.
Return type: char

projectId¶

Gets the projectId of this GearRuleOutput.

Returns: The projectId of this GearRuleOutput.
Return type: char

gearId¶

Gets the gearId of this GearRuleOutput.

Returns: The gearId of this GearRuleOutput.
Return type: char

roleId¶

Gets the roleId of this GearRuleOutput.

Returns: The roleId of this GearRuleOutput.
Return type: char

name¶

Gets the name of this GearRuleOutput.

Returns: The name of this GearRuleOutput.
Return type: char

config¶

Gets the config of this GearRuleOutput.

Returns: The config of this GearRuleOutput.
Return type: containers.Map

fixedInputs¶

Gets the fixedInputs of this GearRuleOutput.

Returns: The fixedInputs of this GearRuleOutput.
Return type: FixedInput

priority¶

Gets the priority of this GearRuleOutput.

Returns: The priority of this GearRuleOutput.
Return type: AllOfGearRuleOutputPriority

autoUpdate¶

Gets the autoUpdate of this GearRuleOutput.

Returns: The autoUpdate of this GearRuleOutput.
Return type: logical

revision¶

Gets the revision of this GearRuleOutput.

Returns: The revision of this GearRuleOutput.
Return type: integer

any¶

Gets the any of this GearRuleOutput.

Returns: The any of this GearRuleOutput.
Return type: GearRuleCondition

all¶

Gets the all of this GearRuleOutput.

Returns: The all of this GearRuleOutput.
Return type: GearRuleCondition

not¶

Gets the not of this GearRuleOutput.

Returns: The not of this GearRuleOutput.
Return type: GearRuleCondition

created¶

Gets the created of this GearRuleOutput.

Returns: The created of this GearRuleOutput.
Return type: datetime

modified¶

Gets the modified of this GearRuleOutput.

Returns: The modified of this GearRuleOutput.
Return type: datetime

disabled¶

Gets the disabled of this GearRuleOutput.

Returns: The disabled of this GearRuleOutput.
Return type: logical

computeProviderId¶

Gets the computeProviderId of this GearRuleOutput.

Returns: The computeProviderId of this GearRuleOutput.
Return type: char

lastModifiedBy¶

Gets the lastModifiedBy of this GearRuleOutput.

Returns: The lastModifiedBy of this GearRuleOutput.
Return type: Origin

triggeringInput¶

Gets the triggeringInput of this GearRuleOutput.

Returns: The triggeringInput of this GearRuleOutput.
Return type: char

GearSaveSubmission¶

Confirmation of gear upload

class GearSaveSubmission¶

Confirmation of gear upload

ticket¶

Ticket id returned from prepare-add

Returns: The ticket of this GearSaveSubmission.
Return type: char

repo¶

The identification of this gear.

Returns: The repo of this GearSaveSubmission.
Return type: char

pointer¶

Checksum of the docker image

Returns: The pointer of this GearSaveSubmission.
Return type: char

GearSeries¶

Represents a gear bearing name and all of its versions. Attributes: name (str): the name of the gear permissions (Optional[GearPermissions]): the permissions to evaluate when gear`is_restricted` is True is_restricted (Optional[bool]): if False, the gear can be accessed site-wide. If True, permissions will be evaluated to determine gear access. Defaults to False when permissions is empty, True when permissions is set.

class GearSeries¶

Represents a gear bearing name and all of its versions. Attributes: name (str): the name of the gear permissions (Optional[GearPermissions]): the permissions to evaluate when gear`is_restricted` is True is_restricted (Optional[bool]): if False, the gear can be accessed site-wide. If True, permissions will be evaluated to determine gear access. Defaults to False when permissions is empty, True when permissions is set.

id¶

Gets the id of this GearSeries.

Returns: The id of this GearSeries.
Return type: char

name¶

Gets the name of this GearSeries.

Returns: The name of this GearSeries.
Return type: char

permissions¶

Gets the permissions of this GearSeries.

Returns: The permissions of this GearSeries.
Return type: GearPermissions

created¶

Gets the created of this GearSeries.

Returns: The created of this GearSeries.
Return type: datetime

modified¶

Gets the modified of this GearSeries.

Returns: The modified of this GearSeries.
Return type: datetime

isRestricted¶

Gets the isRestricted of this GearSeries.

Returns: The isRestricted of this GearSeries.
Return type: logical

GearSeriesUpdate¶

Represents GearSeries attributes that can be modified via PUT Attributes: is_restricted: (Optional[bool]): if False, the gear can be accessed site-wide. If True, permissions will be evaluated to determine gear access.

class GearSeriesUpdate¶

Represents GearSeries attributes that can be modified via PUT Attributes: is_restricted: (Optional[bool]): if False, the gear can be accessed site-wide. If True, permissions will be evaluated to determine gear access.

isRestricted¶

Gets the isRestricted of this GearSeriesUpdate.

Returns: The isRestricted of this GearSeriesUpdate.
Return type: logical

GearSuggestionOutput¶

class GearSuggestionOutput¶

id¶

Gets the id of this GearSuggestionOutput.

Returns: The id of this GearSuggestionOutput.
Return type: char

contType¶

Gets the contType of this GearSuggestionOutput.

Returns: The contType of this GearSuggestionOutput.
Return type: ContainerType

label¶

Gets the label of this GearSuggestionOutput.

Returns: The label of this GearSuggestionOutput.
Return type: char

parents¶

Gets the parents of this GearSuggestionOutput.

Returns: The parents of this GearSuggestionOutput.
Return type: ContainerReferenceWithLabel

children¶

Gets the children of this GearSuggestionOutput.

Returns: The children of this GearSuggestionOutput.
Return type: containers.Map[String, vector[ContainerReferenceWithLabel]]

files¶

Gets the files of this GearSuggestionOutput.

Returns: The files of this GearSuggestionOutput.
Return type: FileSuggestion

GearTicket¶

class GearTicket¶

id¶

Gets the id of this GearTicket.

Returns: The id of this GearTicket.
Return type: char

origin¶

Gets the origin of this GearTicket.

Returns: The origin of this GearTicket.
Return type: Origin

geardoc¶

Gets the geardoc of this GearTicket.

Returns: The geardoc of this GearTicket.
Return type: GearDocumentInput

timestamp¶

Gets the timestamp of this GearTicket.

Returns: The timestamp of this GearTicket.
Return type: datetime

GearTicketOutput¶

class GearTicketOutput¶

ticket¶

Gets the ticket of this GearTicketOutput.

Returns: The ticket of this GearTicketOutput.
Return type: char

GoogleAuthOut¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

class GoogleAuthOut¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

idEndpoint¶

Gets the idEndpoint of this GoogleAuthOut.

Returns: The idEndpoint of this GoogleAuthOut.
Return type: char

clientId¶

Gets the clientId of this GoogleAuthOut.

Returns: The clientId of this GoogleAuthOut.
Return type: char

tokenEndpoint¶

Gets the tokenEndpoint of this GoogleAuthOut.

Returns: The tokenEndpoint of this GoogleAuthOut.
Return type: char

verifyEndpoint¶

Gets the verifyEndpoint of this GoogleAuthOut.

Returns: The verifyEndpoint of this GoogleAuthOut.
Return type: char

refreshEndpoint¶

Gets the refreshEndpoint of this GoogleAuthOut.

Returns: The refreshEndpoint of this GoogleAuthOut.
Return type: char

authEndpoint¶

Gets the authEndpoint of this GoogleAuthOut.

Returns: The authEndpoint of this GoogleAuthOut.
Return type: char

GraphFilter¶

class GraphFilter¶

groups¶

Gets the groups of this GraphFilter.

Returns: The groups of this GraphFilter.
Return type: TreeContainerRequestSpec

projects¶

Gets the projects of this GraphFilter.

Returns: The projects of this GraphFilter.
Return type: TreeContainerRequestSpec

subjects¶

Gets the subjects of this GraphFilter.

Returns: The subjects of this GraphFilter.
Return type: TreeContainerRequestSpec

sessions¶

Gets the sessions of this GraphFilter.

Returns: The sessions of this GraphFilter.
Return type: TreeContainerRequestSpec

acquisitions¶

Gets the acquisitions of this GraphFilter.

Returns: The acquisitions of this GraphFilter.
Return type: TreeContainerRequestSpec

analyses¶

Gets the analyses of this GraphFilter.

Returns: The analyses of this GraphFilter.
Return type: TreeContainerRequestSpec

jobs¶

Gets the jobs of this GraphFilter.

Returns: The jobs of this GraphFilter.
Return type: TreeContainerRequestSpec

Group¶

class Group¶

GroupBy¶

class GroupBy¶

columns¶

Gets the columns of this GroupBy.

Returns: The columns of this GroupBy.
Return type: vector[char]

GroupContainerOutput¶

class GroupContainerOutput¶

id¶

Gets the id of this GroupContainerOutput.

Returns: The id of this GroupContainerOutput.
Return type: char

label¶

Gets the label of this GroupContainerOutput.

Returns: The label of this GroupContainerOutput.
Return type: char

permissions¶

Gets the permissions of this GroupContainerOutput.

Returns: The permissions of this GroupContainerOutput.
Return type: AccessPermission

permissionsTemplate¶

Gets the permissionsTemplate of this GroupContainerOutput.

Returns: The permissionsTemplate of this GroupContainerOutput.
Return type: RolePermission

created¶

Gets the created of this GroupContainerOutput.

Returns: The created of this GroupContainerOutput.
Return type: datetime

modified¶

Gets the modified of this GroupContainerOutput.

Returns: The modified of this GroupContainerOutput.
Return type: datetime

revision¶

Gets the revision of this GroupContainerOutput.

Returns: The revision of this GroupContainerOutput.
Return type: integer

tags¶

Gets the tags of this GroupContainerOutput.

Returns: The tags of this GroupContainerOutput.
Return type: vector[char]

providers¶

Gets the providers of this GroupContainerOutput.

Returns: The providers of this GroupContainerOutput.
Return type: Providers

roles¶

Gets the roles of this GroupContainerOutput.

Returns: The roles of this GroupContainerOutput.
Return type: vector[char]

editions¶

Gets the editions of this GroupContainerOutput.

Returns: The editions of this GroupContainerOutput.
Return type: Edition

settings¶

Gets the settings of this GroupContainerOutput.

Returns: The settings of this GroupContainerOutput.
Return type: GroupSettingsOutput

containerType¶

Gets the containerType of this GroupContainerOutput.

Returns: The containerType of this GroupContainerOutput.
Return type: AllOfGroupContainerOutputContainerType

GroupInput¶

class GroupInput¶

id¶

Gets the id of this GroupInput.

Returns: The id of this GroupInput.
Return type: char

label¶

Gets the label of this GroupInput.

Returns: The label of this GroupInput.
Return type: char

providers¶

Gets the providers of this GroupInput.

Returns: The providers of this GroupInput.
Return type: Providers

editions¶

Gets the editions of this GroupInput.

Returns: The editions of this GroupInput.
Return type: Edition

GroupNode¶

class GroupNode¶

id¶

Gets the id of this GroupNode.

Returns: The id of this GroupNode.
Return type: char

label¶

Gets the label of this GroupNode.

Returns: The label of this GroupNode.
Return type: char

permissions¶

Gets the permissions of this GroupNode.

Returns: The permissions of this GroupNode.
Return type: AccessPermission

permissionsTemplate¶

Gets the permissionsTemplate of this GroupNode.

Returns: The permissionsTemplate of this GroupNode.
Return type: RolePermission

created¶

Gets the created of this GroupNode.

Returns: The created of this GroupNode.
Return type: datetime

modified¶

Gets the modified of this GroupNode.

Returns: The modified of this GroupNode.
Return type: datetime

revision¶

Gets the revision of this GroupNode.

Returns: The revision of this GroupNode.
Return type: integer

tags¶

Gets the tags of this GroupNode.

Returns: The tags of this GroupNode.
Return type: vector[char]

providers¶

Gets the providers of this GroupNode.

Returns: The providers of this GroupNode.
Return type: Providers

roles¶

Gets the roles of this GroupNode.

Returns: The roles of this GroupNode.
Return type: vector[char]

editions¶

Gets the editions of this GroupNode.

Returns: The editions of this GroupNode.
Return type: Edition

settings¶

Gets the settings of this GroupNode.

Returns: The settings of this GroupNode.
Return type: GroupSettingsOutput

GroupOutput¶

class GroupOutput¶

id¶

Gets the id of this GroupOutput.

Returns: The id of this GroupOutput.
Return type: char

label¶

Gets the label of this GroupOutput.

Returns: The label of this GroupOutput.
Return type: char

permissions¶

Gets the permissions of this GroupOutput.

Returns: The permissions of this GroupOutput.
Return type: AccessPermission

permissionsTemplate¶

Gets the permissionsTemplate of this GroupOutput.

Returns: The permissionsTemplate of this GroupOutput.
Return type: RolePermission

created¶

Gets the created of this GroupOutput.

Returns: The created of this GroupOutput.
Return type: datetime

modified¶

Gets the modified of this GroupOutput.

Returns: The modified of this GroupOutput.
Return type: datetime

revision¶

Gets the revision of this GroupOutput.

Returns: The revision of this GroupOutput.
Return type: integer

tags¶

Gets the tags of this GroupOutput.

Returns: The tags of this GroupOutput.
Return type: vector[char]

providers¶

Gets the providers of this GroupOutput.

Returns: The providers of this GroupOutput.
Return type: Providers

roles¶

Gets the roles of this GroupOutput.

Returns: The roles of this GroupOutput.
Return type: vector[char]

editions¶

Gets the editions of this GroupOutput.

Returns: The editions of this GroupOutput.
Return type: Edition

settings¶

Gets the settings of this GroupOutput.

Returns: The settings of this GroupOutput.
Return type: GroupSettingsOutput

GroupReport¶

class GroupReport¶

projectCount¶

Gets the projectCount of this GroupReport.

Returns: The projectCount of this GroupReport.
Return type: integer

label¶

Gets the label of this GroupReport.

Returns: The label of this GroupReport.
Return type: char

sessionCount¶

Gets the sessionCount of this GroupReport.

Returns: The sessionCount of this GroupReport.
Return type: integer

GroupRole¶

class GroupRole¶

id¶

Gets the id of this GroupRole.

Returns: The id of this GroupRole.
Return type: char

GroupSettingsOutput¶

class GroupSettingsOutput¶

viewerApps¶

Gets the viewerApps of this GroupSettingsOutput.

Returns: The viewerApps of this GroupSettingsOutput.
Return type: ViewerApp

deidProfile¶

Gets the deidProfile of this GroupSettingsOutput.

Returns: The deidProfile of this GroupSettingsOutput.
Return type: containers.Map

forms¶

Gets the forms of this GroupSettingsOutput.

Returns: The forms of this GroupSettingsOutput.
Return type: containers.Map[String, vector[FormDefinition]]

externalRoutingId¶

Gets the externalRoutingId of this GroupSettingsOutput.

Returns: The externalRoutingId of this GroupSettingsOutput.
Return type: char

GroupUpdate¶

class GroupUpdate¶

label¶

Gets the label of this GroupUpdate.

Returns: The label of this GroupUpdate.
Return type: char

providers¶

Gets the providers of this GroupUpdate.

Returns: The providers of this GroupUpdate.
Return type: Providers

editions¶

Gets the editions of this GroupUpdate.

Returns: The editions of this GroupUpdate.
Return type: Edition

modified¶

Gets the modified of this GroupUpdate.

Returns: The modified of this GroupUpdate.
Return type: datetime

HTTPValidationError¶

class HTTPValidationError¶

detail¶

Gets the detail of this HTTPValidationError.

Returns: The detail of this HTTPValidationError.
Return type: ValidationError

HeaderFeature¶

An enum for all the features routers accept.

class HeaderFeature¶: An enum for all the features routers accept.

HierarchyExportTemplates¶

Contains all the export templates applicable to container data like container-metadata and analyses.

class HierarchyExportTemplates¶

Contains all the export templates applicable to container data like container-metadata and analyses.

group¶

Gets the group of this HierarchyExportTemplates.

Returns: The group of this HierarchyExportTemplates.
Return type: char

project¶

Gets the project of this HierarchyExportTemplates.

Returns: The project of this HierarchyExportTemplates.
Return type: char

subject¶

Gets the subject of this HierarchyExportTemplates.

Returns: The subject of this HierarchyExportTemplates.
Return type: char

session¶

Gets the session of this HierarchyExportTemplates.

Returns: The session of this HierarchyExportTemplates.
Return type: char

acquisition¶

Gets the acquisition of this HierarchyExportTemplates.

Returns: The acquisition of this HierarchyExportTemplates.
Return type: char

Info¶

class Info¶

set¶

Gets the set of this Info.

Returns: The set of this Info.
Return type: containers.Map

delete¶

Gets the delete of this Info.

Returns: The delete of this Info.
Return type: vector[char]

replace¶

Gets the replace of this Info.

Returns: The replace of this Info.
Return type: containers.Map

InfoUpdateInput¶

class InfoUpdateInput¶

IngressProvider¶

Provider input model–no relation to Ingress the Minikube add-on

class IngressProvider¶

Provider input model–no relation to Ingress the Minikube add-on

label¶

Gets the label of this IngressProvider.

Returns: The label of this IngressProvider.
Return type: char

providerClass¶

Gets the providerClass of this IngressProvider.

Returns: The providerClass of this IngressProvider.
Return type: ProviderClass

providerType¶

Gets the providerType of this IngressProvider.

Returns: The providerType of this IngressProvider.
Return type: ProviderType

creds¶

Gets the creds of this IngressProvider.

Returns: The creds of this IngressProvider.
Return type: containers.Map

config¶

Gets the config of this IngressProvider.

Returns: The config of this IngressProvider.
Return type: containers.Map

accessType¶

Gets the accessType of this IngressProvider.

Returns: The accessType of this IngressProvider.
Return type: ProviderAccessType

IngressProviders¶

Providers input model–no relation to Ingress the Minikube add-on

class IngressProviders¶

Providers input model–no relation to Ingress the Minikube add-on

storage¶

Gets the storage of this IngressProviders.

Returns: The storage of this IngressProviders.
Return type: char

compute¶

Gets the compute of this IngressProviders.

Returns: The compute of this IngressProviders.
Return type: char

changeLog¶

Gets the changeLog of this IngressProviders.

Returns: The changeLog of this IngressProviders.
Return type: char

accessLog¶

Gets the accessLog of this IngressProviders.

Returns: The accessLog of this IngressProviders.
Return type: char

jobLogs¶

Gets the jobLogs of this IngressProviders.

Returns: The jobLogs of this IngressProviders.
Return type: char

IngressSiteSettings¶

class IngressSiteSettings¶

centerGears¶

Gets the centerGears of this IngressSiteSettings.

Returns: The centerGears of this IngressSiteSettings.
Return type: vector[char]

providers¶

Gets the providers of this IngressSiteSettings.

Returns: The providers of this IngressSiteSettings.
Return type: IngressProviders

ldapSync¶

Gets the ldapSync of this IngressSiteSettings.

Returns: The ldapSync of this IngressSiteSettings.
Return type: LdapSyncConfig

viewerApps¶

Gets the viewerApps of this IngressSiteSettings.

Returns: The viewerApps of this IngressSiteSettings.
Return type: ViewerApp

deidProfile¶

Gets the deidProfile of this IngressSiteSettings.

Returns: The deidProfile of this IngressSiteSettings.
Return type: AnyOfIngressSiteSettingsDeidProfile

IngressUpdateProvider¶

class IngressUpdateProvider¶

label¶

Gets the label of this IngressUpdateProvider.

Returns: The label of this IngressUpdateProvider.
Return type: char

creds¶

Gets the creds of this IngressUpdateProvider.

Returns: The creds of this IngressUpdateProvider.
Return type: containers.Map

config¶

Gets the config of this IngressUpdateProvider.

Returns: The config of this IngressUpdateProvider.
Return type: containers.Map

InlineResponse200¶

class InlineResponse200¶

modified¶

Gets the modified of this InlineResponse200.

Returns: The modified of this InlineResponse200.
Return type: integer

InlineResponse2002¶

class InlineResponse2002¶

deleted¶

Gets the deleted of this InlineResponse2002.

Returns: The deleted of this InlineResponse2002.
Return type: integer

InlineResponse2005¶

class InlineResponse2005¶

InputFilter¶

class InputFilter¶

tags¶

Gets the tags of this InputFilter.

Returns: The tags of this InputFilter.
Return type: FilterValues

types¶

Gets the types of this InputFilter.

Returns: The types of this InputFilter.
Return type: FilterValues

since¶

Gets the since of this InputFilter.

Returns: The since of this InputFilter.
Return type: datetime

InputJob¶

class InputJob¶

attempt¶

Gets the attempt of this InputJob.

Returns: The attempt of this InputJob.
Return type: integer

priority¶

Gets the priority of this InputJob.

Returns: The priority of this InputJob.
Return type: AllOfInputJobPriority

batch¶

Gets the batch of this InputJob.

Returns: The batch of this InputJob.
Return type: char

origin¶

Gets the origin of this InputJob.

Returns: The origin of this InputJob.
Return type: Origin

computeProviderId¶

Gets the computeProviderId of this InputJob.

Returns: The computeProviderId of this InputJob.
Return type: char

destination¶

Gets the destination of this InputJob.

Returns: The destination of this InputJob.
Return type: ContainerReference

gearId¶

Gets the gearId of this InputJob.

Returns: The gearId of this InputJob.
Return type: char

roleId¶

Gets the roleId of this InputJob.

Returns: The roleId of this InputJob.
Return type: char

inputs¶

Gets the inputs of this InputJob.

Returns: The inputs of this InputJob.
Return type: Object

parents¶

Gets the parents of this InputJob.

Returns: The parents of this InputJob.
Return type: JobParents

label¶

Gets the label of this InputJob.

Returns: The label of this InputJob.
Return type: char

previousJobId¶

Gets the previousJobId of this InputJob.

Returns: The previousJobId of this InputJob.
Return type: char

tags¶

Gets the tags of this InputJob.

Returns: The tags of this InputJob.
Return type: vector[char]

config¶

Gets the config of this InputJob.

Returns: The config of this InputJob.
Return type: containers.Map

InputJobProfile¶

Represents the input for jobs profile Attributes: elapsed_time_ms (Optional[int]): The runtime of the job, in milliseconds executor (Optional[ExecutorInfo]): The information about the job executor, also known as engine preparation_time_ms (Optional[int]): The length of time taken to download gear container and inputs, in milliseconds upload_time_ms (Optional[int]): The length of time taken to upload the job’s outputs, in milliseconds versions (Optional[Dict[str, str]]): Version info of components involved in job

class InputJobProfile¶

Represents the input for jobs profile Attributes: elapsed_time_ms (Optional[int]): The runtime of the job, in milliseconds executor (Optional[ExecutorInfo]): The information about the job executor, also known as engine preparation_time_ms (Optional[int]): The length of time taken to download gear container and inputs, in milliseconds upload_time_ms (Optional[int]): The length of time taken to upload the job’s outputs, in milliseconds versions (Optional[Dict[str, str]]): Version info of components involved in job

elapsedTimeMs¶

Gets the elapsedTimeMs of this InputJobProfile.

Returns: The elapsedTimeMs of this InputJobProfile.
Return type: integer

executor¶

Gets the executor of this InputJobProfile.

Returns: The executor of this InputJobProfile.
Return type: ExecutorInfo

preparationTimeMs¶

Gets the preparationTimeMs of this InputJobProfile.

Returns: The preparationTimeMs of this InputJobProfile.
Return type: integer

uploadTimeMs¶

Gets the uploadTimeMs of this InputJobProfile.

Returns: The uploadTimeMs of this InputJobProfile.
Return type: integer

versions¶

Gets the versions of this InputJobProfile.

Returns: The versions of this InputJobProfile.
Return type: containers.Map[String, char]

InsertedId¶

class InsertedId¶

id¶

Gets the id of this InsertedId.

Returns: The id of this InsertedId.
Return type: char

Job¶

class Job¶

id¶

Unique database ID

Returns: The id of this Job.
Return type: char

origin¶

Gets the origin of this Job.

Returns: The origin of this Job.
Return type: JobOrigin

gearId¶

Gets the gearId of this Job.

Returns: The gearId of this Job.
Return type: char

gearInfo¶

Gets the gearInfo of this Job.

Returns: The gearInfo of this Job.
Return type: GearInfo

previousJobId¶

Gets the previousJobId of this Job.

Returns: The previousJobId of this Job.
Return type: char

inputs¶

Gets the inputs of this Job.

Returns: The inputs of this Job.
Return type: JobInputsObject

destination¶

Gets the destination of this Job.

Returns: The destination of this Job.
Return type: JobDestination

computeProviderId¶

Unique database ID

Returns: The computeProviderId of this Job.
Return type: char

group¶

Gets the group of this Job.

Returns: The group of this Job.
Return type: char

project¶

Unique database ID

Returns: The project of this Job.
Return type: char

tags¶

Gets the tags of this Job.

Returns: The tags of this Job.
Return type: vector[char]

priority¶

Gets the priority of this Job.

Returns: The priority of this Job.
Return type: char

state¶

Gets the state of this Job.

Returns: The state of this Job.
Return type: char

failureReason¶

An optional suspected reason for job failure

Returns: The failureReason of this Job.
Return type: char

attempt¶

Gets the attempt of this Job.

Returns: The attempt of this Job.
Return type: integer

created¶

Creation time (automatically set)

Returns: The created of this Job.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Job.
Return type: datetime

retried¶

Retried time (automatically set)

Returns: The retried of this Job.
Return type: datetime

config¶

Gets the config of this Job.

Returns: The config of this Job.
Return type: JobConfig

transitions¶

Gets the transitions of this Job.

Returns: The transitions of this Job.
Return type: JobTransitionTimes

request¶

Gets the request of this Job.

Returns: The request of this Job.
Return type: JobRequest

savedFiles¶

Gets the savedFiles of this Job.

Returns: The savedFiles of this Job.
Return type: vector[char]

profile¶

Gets the profile of this Job.

Returns: The profile of this Job.
Return type: JobProfile

relatedContainerIds¶

The set of all related container ids

Returns: The relatedContainerIds of this Job.
Return type: vector[char]

label¶

Application-specific label

Returns: The label of this Job.
Return type: char

JobAnalysisInput¶

class JobAnalysisInput¶

job¶

Gets the job of this JobAnalysisInput.

Returns: The job of this JobAnalysisInput.
Return type: InputJob

label¶

Gets the label of this JobAnalysisInput.

Returns: The label of this JobAnalysisInput.
Return type: char

description¶

Gets the description of this JobAnalysisInput.

Returns: The description of this JobAnalysisInput.
Return type: char

computeProviderId¶

Gets the computeProviderId of this JobAnalysisInput.

Returns: The computeProviderId of this JobAnalysisInput.
Return type: char

info¶

Gets the info of this JobAnalysisInput.

Returns: The info of this JobAnalysisInput.
Return type: containers.Map

JobAsk¶

Represents a query made by a job executor to retrieve a job

class JobAsk¶

Represents a query made by a job executor to retrieve a job

whitelist¶

Gets the whitelist of this JobAsk.

Returns: The whitelist of this JobAsk.
Return type: JobConfigInput

blacklist¶

Gets the blacklist of this JobAsk.

Returns: The blacklist of this JobAsk.
Return type: JobConfigInput

capabilities¶

Gets the capabilities of this JobAsk.

Returns: The capabilities of this JobAsk.
Return type: vector[char]

xReturn¶

Gets the xReturn of this JobAsk.

Returns: The xReturn of this JobAsk.
Return type: AllOfJobAskXReturn

limit¶

Gets the limit of this JobAsk.

Returns: The limit of this JobAsk.
Return type: integer

jobStates¶

Gets the jobStates of this JobAsk.

Returns: The jobStates of this JobAsk.
Return type: JobState

JobAskResponse¶

Represents the API’s reponse to a query for jobs Attributes: jobs (Optional[List[Job]]): The list of jobs matching the ask query states (Optional[JobsByState]): The number of jobs in each state

class JobAskResponse¶

Represents the API’s reponse to a query for jobs Attributes: jobs (Optional[List[Job]]): The list of jobs matching the ask query states (Optional[JobsByState]): The number of jobs in each state

jobs¶

Gets the jobs of this JobAskResponse.

Returns: The jobs of this JobAskResponse.
Return type: JobAskResponseJob

states¶

Gets the states of this JobAskResponse.

Returns: The states of this JobAskResponse.
Return type: JobsByState

JobAskResponseJob¶

Representation of a job run by an engine Attributes: gear_id (str): The id of the gear to run gear_info (Optional[GearInfo]): Extra information about the gear inputs (JobInputs): The input dictionary of the job rule_id (Optional[str]): The id of the gear rule if spawned via a rule role_id (Optional[str]): The id of the role which the job was created with if spawned via a rule legacy_inputs: (Optional[List[LegacyInput]]): TODO: description destination (ContainerReference): The destination of the outputs of the job tags (List[str]): List of tags for the jobs priority: JobPriority: The priority of the job attempt (int): The number of attempts made for the job previous_job_id (Optional[str]): The id of the previous job that this job is retry of created (datetime.datetime): Timestamp of when the job was created modified (datetime.datetime): Timestamp of when the job record was last modified retried (Optional[datetime.datetime]): Timestamp of when the job was retried as another job state (JobState): Current state of the job request (Optional[JobRequest)]: Request object for the job, used by the engine for downloading inputs, uploading outputs, etc. id (str): The id of the job config (dict): Configuration object of the job origin (Origin): The origin of the job, who/what created it saved_files (List[str]): Output files uploaded by the engine from the job produced_metadata (Optional[dict]): Raw content of the .metadata.json file to be attached to the flywheel hierarchy batch (Optional[str]): The id of the batch the job belongs to failed_output_accepted (bool): Flag as to whether to upload outputs if the job failed profile (Optional[JobProfile]): The profile of the job, contains information of execution time and resources failure_reason (Optional[str]): Description of how the job failed related_container_ids (List[str]): List of ids of all containers the job has ever been associated with label (Optional[str]): The label of the job compute_provider_id (Optional[str]): The id of the compute provider parents (JobParents): The hierarchy of the jobs destination transitions (Transitions): Mapping of state to timestamp of when the job transitioned to that state parent_info: (Optional[JobDetailParentInfo]): TODO: description

class JobAskResponseJob¶

Representation of a job run by an engine Attributes: gear_id (str): The id of the gear to run gear_info (Optional[GearInfo]): Extra information about the gear inputs (JobInputs): The input dictionary of the job rule_id (Optional[str]): The id of the gear rule if spawned via a rule role_id (Optional[str]): The id of the role which the job was created with if spawned via a rule legacy_inputs: (Optional[List[LegacyInput]]): TODO: description destination (ContainerReference): The destination of the outputs of the job tags (List[str]): List of tags for the jobs priority: JobPriority: The priority of the job attempt (int): The number of attempts made for the job previous_job_id (Optional[str]): The id of the previous job that this job is retry of created (datetime.datetime): Timestamp of when the job was created modified (datetime.datetime): Timestamp of when the job record was last modified retried (Optional[datetime.datetime]): Timestamp of when the job was retried as another job state (JobState): Current state of the job request (Optional[JobRequest)]: Request object for the job, used by the engine for downloading inputs, uploading outputs, etc. id (str): The id of the job config (dict): Configuration object of the job origin (Origin): The origin of the job, who/what created it saved_files (List[str]): Output files uploaded by the engine from the job produced_metadata (Optional[dict]): Raw content of the .metadata.json file to be attached to the flywheel hierarchy batch (Optional[str]): The id of the batch the job belongs to failed_output_accepted (bool): Flag as to whether to upload outputs if the job failed profile (Optional[JobProfile]): The profile of the job, contains information of execution time and resources failure_reason (Optional[str]): Description of how the job failed related_container_ids (List[str]): List of ids of all containers the job has ever been associated with label (Optional[str]): The label of the job compute_provider_id (Optional[str]): The id of the compute provider parents (JobParents): The hierarchy of the jobs destination transitions (Transitions): Mapping of state to timestamp of when the job transitioned to that state parent_info: (Optional[JobDetailParentInfo]): TODO: description

computeProviderId¶

Gets the computeProviderId of this JobAskResponseJob.

Returns: The computeProviderId of this JobAskResponseJob.
Return type: char

failureReason¶

Gets the failureReason of this JobAskResponseJob.

Returns: The failureReason of this JobAskResponseJob.
Return type: char

label¶

Gets the label of this JobAskResponseJob.

Returns: The label of this JobAskResponseJob.
Return type: char

priority¶

Gets the priority of this JobAskResponseJob.

Returns: The priority of this JobAskResponseJob.
Return type: AllOfJobAskResponseJobPriority

modified¶

Gets the modified of this JobAskResponseJob.

Returns: The modified of this JobAskResponseJob.
Return type: datetime

parents¶

Gets the parents of this JobAskResponseJob.

Returns: The parents of this JobAskResponseJob.
Return type: JobParents

producedMetadata¶

Gets the producedMetadata of this JobAskResponseJob.

Returns: The producedMetadata of this JobAskResponseJob.
Return type: containers.Map

relatedContainerIds¶

Gets the relatedContainerIds of this JobAskResponseJob.

Returns: The relatedContainerIds of this JobAskResponseJob.
Return type: vector[char]

request¶

Gets the request of this JobAskResponseJob.

Returns: The request of this JobAskResponseJob.
Return type: JobRequest

retried¶

Gets the retried of this JobAskResponseJob.

Returns: The retried of this JobAskResponseJob.
Return type: datetime

savedFiles¶

Gets the savedFiles of this JobAskResponseJob.

Returns: The savedFiles of this JobAskResponseJob.
Return type: vector[char]

state¶

Gets the state of this JobAskResponseJob.

Returns: The state of this JobAskResponseJob.
Return type: JobState

profile¶

Gets the profile of this JobAskResponseJob.

Returns: The profile of this JobAskResponseJob.
Return type: JobProfile

transitions¶

Gets the transitions of this JobAskResponseJob.

Returns: The transitions of this JobAskResponseJob.
Return type: AllOfJobAskResponseJobTransitions

gearId¶

Gets the gearId of this JobAskResponseJob.

Returns: The gearId of this JobAskResponseJob.
Return type: char

gearInfo¶

Gets the gearInfo of this JobAskResponseJob.

Returns: The gearInfo of this JobAskResponseJob.
Return type: GearInfo

ruleId¶

Gets the ruleId of this JobAskResponseJob.

Returns: The ruleId of this JobAskResponseJob.
Return type: char

roleId¶

Gets the roleId of this JobAskResponseJob.

Returns: The roleId of this JobAskResponseJob.
Return type: char

inputs¶

Gets the inputs of this JobAskResponseJob.

Returns: The inputs of this JobAskResponseJob.
Return type: Object

legacyInputs¶

Gets the legacyInputs of this JobAskResponseJob.

Returns: The legacyInputs of this JobAskResponseJob.
Return type: LegacyInput

destination¶

Gets the destination of this JobAskResponseJob.

Returns: The destination of this JobAskResponseJob.
Return type: ContainerReference

tags¶

Gets the tags of this JobAskResponseJob.

Returns: The tags of this JobAskResponseJob.
Return type: vector[char]

attempt¶

Gets the attempt of this JobAskResponseJob.

Returns: The attempt of this JobAskResponseJob.
Return type: integer

previousJobId¶

Gets the previousJobId of this JobAskResponseJob.

Returns: The previousJobId of this JobAskResponseJob.
Return type: char

created¶

Gets the created of this JobAskResponseJob.

Returns: The created of this JobAskResponseJob.
Return type: datetime

id¶

Gets the id of this JobAskResponseJob.

Returns: The id of this JobAskResponseJob.
Return type: char

config¶

Gets the config of this JobAskResponseJob.

Returns: The config of this JobAskResponseJob.
Return type: containers.Map

origin¶

Gets the origin of this JobAskResponseJob.

Returns: The origin of this JobAskResponseJob.
Return type: Origin

batch¶

Gets the batch of this JobAskResponseJob.

Returns: The batch of this JobAskResponseJob.
Return type: char

failedOutputAccepted¶

Gets the failedOutputAccepted of this JobAskResponseJob.

Returns: The failedOutputAccepted of this JobAskResponseJob.
Return type: logical

parentInfo¶

Gets the parentInfo of this JobAskResponseJob.

Returns: The parentInfo of this JobAskResponseJob.
Return type: JobDetailParentInfo

JobAskReturn¶

class JobAskReturn¶

JobAskReturnCriteria¶

Model that specifies what to return Attributes: jobs (int): The number of jobs to return peek (bool): Whether to start the jobs or not states (bool): To return the jobs by state object encoded (bool): To return the request urls for the jobs encoded. The uri is always stored in the persistence layer encoded, however if encoded is false, the uri’s will be decoded in the handler layer for the response

class JobAskReturnCriteria¶

Model that specifies what to return Attributes: jobs (int): The number of jobs to return peek (bool): Whether to start the jobs or not states (bool): To return the jobs by state object encoded (bool): To return the request urls for the jobs encoded. The uri is always stored in the persistence layer encoded, however if encoded is false, the uri’s will be decoded in the handler layer for the response

jobs¶

Gets the jobs of this JobAskReturnCriteria.

Returns: The jobs of this JobAskReturnCriteria.
Return type: integer

peek¶

Gets the peek of this JobAskReturnCriteria.

Returns: The peek of this JobAskReturnCriteria.
Return type: logical

states¶

Gets the states of this JobAskReturnCriteria.

Returns: The states of this JobAskReturnCriteria.
Return type: logical

encoded¶

Gets the encoded of this JobAskReturnCriteria.

Returns: The encoded of this JobAskReturnCriteria.
Return type: logical

JobAskState¶

class JobAskState¶

JobAskStateResponse¶

class JobAskStateResponse¶

count¶

Gets the count of this JobAskStateResponse.

Returns: The count of this JobAskStateResponse.
Return type: integer

JobComplete¶

Payload required to complete a job using a ticket Attributes: success (bool): Did the job complete successfully failure_reason (Optional[str]): If the job failed, a short description as to why profile (Optional[JobProfile]): An update to the job profile

class JobComplete¶

Payload required to complete a job using a ticket Attributes: success (bool): Did the job complete successfully failure_reason (Optional[str]): If the job failed, a short description as to why profile (Optional[JobProfile]): An update to the job profile

success¶

Gets the success of this JobComplete.

Returns: The success of this JobComplete.
Return type: logical

failureReason¶

Gets the failureReason of this JobComplete.

Returns: The failureReason of this JobComplete.
Return type: char

profile¶

Gets the profile of this JobComplete.

Returns: The profile of this JobComplete.
Return type: InputJobProfile

JobCompletionInput¶

class JobCompletionInput¶

JobCompletionTicket¶

class JobCompletionTicket¶

JobConfig¶

class JobConfig¶

JobConfigInput¶

Represents the properties of a job Attributes: group (Optional[str]): The group id of the job to match gear_name (Optional[str]): The gear name of the job to match tag (Optional[str]): A tag value of the job to match compute_provider (Optional[str]): The id of the compute provider of the job to match created_by (Optional[str]): The id of the origin of the job to match

class JobConfigInput¶

Represents the properties of a job Attributes: group (Optional[str]): The group id of the job to match gear_name (Optional[str]): The gear name of the job to match tag (Optional[str]): A tag value of the job to match compute_provider (Optional[str]): The id of the compute provider of the job to match created_by (Optional[str]): The id of the origin of the job to match

group¶

Gets the group of this JobConfigInput.

Returns: The group of this JobConfigInput.
Return type: vector[char]

gearName¶

Gets the gearName of this JobConfigInput.

Returns: The gearName of this JobConfigInput.
Return type: vector[char]

tag¶

Gets the tag of this JobConfigInput.

Returns: The tag of this JobConfigInput.
Return type: vector[char]

computeProvider¶

Gets the computeProvider of this JobConfigInput.

Returns: The computeProvider of this JobConfigInput.
Return type: vector[char]

createdBy¶

Gets the createdBy of this JobConfigInput.

Returns: The createdBy of this JobConfigInput.
Return type: vector[char]

JobConfigInputs¶

class JobConfigInputs¶

JobConfigOutput¶

class JobConfigOutput¶

JobContainerDetail¶

class JobContainerDetail¶

JobDestination¶

class JobDestination¶

type¶

Gets the type of this JobDestination.

Returns: The type of this JobDestination.
Return type: char

id¶

Gets the id of this JobDestination.

Returns: The id of this JobDestination.
Return type: char

JobDetail¶

class JobDetail¶

gearId¶

Gets the gearId of this JobDetail.

Returns: The gearId of this JobDetail.
Return type: char

gearInfo¶

Gets the gearInfo of this JobDetail.

Returns: The gearInfo of this JobDetail.
Return type: GearInfo

destination¶

Gets the destination of this JobDetail.

Returns: The destination of this JobDetail.
Return type: ContainerReference

tags¶

Gets the tags of this JobDetail.

Returns: The tags of this JobDetail.
Return type: vector[char]

priority¶

Gets the priority of this JobDetail.

Returns: The priority of this JobDetail.
Return type: AllOfJobDetailPriority

attempt¶

Gets the attempt of this JobDetail.

Returns: The attempt of this JobDetail.
Return type: integer

previousJobId¶

Gets the previousJobId of this JobDetail.

Returns: The previousJobId of this JobDetail.
Return type: char

created¶

Gets the created of this JobDetail.

Returns: The created of this JobDetail.
Return type: datetime

modified¶

Gets the modified of this JobDetail.

Returns: The modified of this JobDetail.
Return type: datetime

retried¶

Gets the retried of this JobDetail.

Returns: The retried of this JobDetail.
Return type: datetime

state¶

Gets the state of this JobDetail.

Returns: The state of this JobDetail.
Return type: JobState

request¶

Gets the request of this JobDetail.

Returns: The request of this JobDetail.
Return type: JobRequest

id¶

Gets the id of this JobDetail.

Returns: The id of this JobDetail.
Return type: char

config¶

Gets the config of this JobDetail.

Returns: The config of this JobDetail.
Return type: containers.Map

origin¶

Gets the origin of this JobDetail.

Returns: The origin of this JobDetail.
Return type: Origin

producedMetadata¶

Gets the producedMetadata of this JobDetail.

Returns: The producedMetadata of this JobDetail.
Return type: containers.Map

batch¶

Gets the batch of this JobDetail.

Returns: The batch of this JobDetail.
Return type: char

failedOutputAccepted¶

Gets the failedOutputAccepted of this JobDetail.

Returns: The failedOutputAccepted of this JobDetail.
Return type: logical

profile¶

Gets the profile of this JobDetail.

Returns: The profile of this JobDetail.
Return type: JobProfile

failureReason¶

Gets the failureReason of this JobDetail.

Returns: The failureReason of this JobDetail.
Return type: char

relatedContainerIds¶

Gets the relatedContainerIds of this JobDetail.

Returns: The relatedContainerIds of this JobDetail.
Return type: vector[char]

label¶

Gets the label of this JobDetail.

Returns: The label of this JobDetail.
Return type: char

computeProviderId¶

Gets the computeProviderId of this JobDetail.

Returns: The computeProviderId of this JobDetail.
Return type: char

parents¶

Gets the parents of this JobDetail.

Returns: The parents of this JobDetail.
Return type: AnyOfJobDetailParents

transitions¶

Gets the transitions of this JobDetail.

Returns: The transitions of this JobDetail.
Return type: AllOfJobDetailTransitions

parentInfo¶

Gets the parentInfo of this JobDetail.

Returns: The parentInfo of this JobDetail.
Return type: JobDetailParentInfo

inputs¶

Gets the inputs of this JobDetail.

Returns: The inputs of this JobDetail.
Return type: JobDetailFileEntry

outputs¶

Gets the outputs of this JobDetail.

Returns: The outputs of this JobDetail.
Return type: JobDetailFileEntry

deletedOutputs¶

Gets the deletedOutputs of this JobDetail.

Returns: The deletedOutputs of this JobDetail.
Return type: DeletedFile

JobDetailContainer¶

class JobDetailContainer¶

id¶

Gets the id of this JobDetailContainer.

Returns: The id of this JobDetailContainer.
Return type: char

label¶

Gets the label of this JobDetailContainer.

Returns: The label of this JobDetailContainer.
Return type: char

JobDetailFileEntry¶

class JobDetailFileEntry¶

ref¶

Gets the ref of this JobDetailFileEntry.

Returns: The ref of this JobDetailFileEntry.
Return type: FileReference

object¶

Gets the object of this JobDetailFileEntry.

Returns: The object of this JobDetailFileEntry.
Return type: FileOutput

JobDetailParentInfo¶

class JobDetailParentInfo¶

group¶

Gets the group of this JobDetailParentInfo.

Returns: The group of this JobDetailParentInfo.
Return type: JobDetailContainer

project¶

Gets the project of this JobDetailParentInfo.

Returns: The project of this JobDetailParentInfo.
Return type: JobDetailContainer

subject¶

Gets the subject of this JobDetailParentInfo.

Returns: The subject of this JobDetailParentInfo.
Return type: JobDetailContainer

session¶

Gets the session of this JobDetailParentInfo.

Returns: The session of this JobDetailParentInfo.
Return type: JobDetailContainer

acquisition¶

Gets the acquisition of this JobDetailParentInfo.

Returns: The acquisition of this JobDetailParentInfo.
Return type: JobDetailContainer

analysis¶

Gets the analysis of this JobDetailParentInfo.

Returns: The analysis of this JobDetailParentInfo.
Return type: JobDetailContainer

JobExecutorInfo¶

class JobExecutorInfo¶

name¶

A machine or instance name, possibly a FQDN

Returns: The name of this JobExecutorInfo.
Return type: char

host¶

The hostname or (more likely) IP address of the engine instance

Returns: The host of this JobExecutorInfo.
Return type: char

instanceType¶

A free form string describing the instance type

Returns: The instanceType of this JobExecutorInfo.
Return type: char

cpuCores¶

The number of CPU cores

Returns: The cpuCores of this JobExecutorInfo.
Return type: integer

gpu¶

Whether or not a GPU is available

Returns: The gpu of this JobExecutorInfo.
Return type: logical

memoryBytes¶

The amount of memory on the system, in bytes

Returns: The memoryBytes of this JobExecutorInfo.
Return type: integer

diskBytes¶

The size of the hard disk on the system, in bytes

Returns: The diskBytes of this JobExecutorInfo.
Return type: integer

swapBytes¶

The available swap space, in bytes

Returns: The swapBytes of this JobExecutorInfo.
Return type: integer

JobFileInput¶

Represents a file-based input to a job Attributes: hierarchy (ContainerReference): The reference to the parent of the file object (File): The file metadata object itself location (Location): The file’s location inside the gear container base (str): The input type

class JobFileInput¶

Represents a file-based input to a job Attributes: hierarchy (ContainerReference): The reference to the parent of the file object (File): The file metadata object itself location (Location): The file’s location inside the gear container base (str): The input type

hierarchy¶

Gets the hierarchy of this JobFileInput.

Returns: The hierarchy of this JobFileInput.
Return type: ContainerReference

object¶

Gets the object of this JobFileInput.

Returns: The object of this JobFileInput.
Return type: JobFileObject

location¶

Gets the location of this JobFileInput.

Returns: The location of this JobFileInput.
Return type: Location

base¶

Gets the base of this JobFileInput.

Returns: The base of this JobFileInput.
Return type: char

JobFileInputListOutput¶

class JobFileInputListOutput¶

hierarchy¶

Gets the hierarchy of this JobFileInputListOutput.

Returns: The hierarchy of this JobFileInputListOutput.
Return type: ContainerReference

object¶

Gets the object of this JobFileInputListOutput.

Returns: The object of this JobFileInputListOutput.
Return type: JobFileObjectListOutput

location¶

Gets the location of this JobFileInputListOutput.

Returns: The location of this JobFileInputListOutput.
Return type: Location

base¶

Gets the base of this JobFileInputListOutput.

Returns: The base of this JobFileInputListOutput.
Return type: char

JobFileObject¶

class JobFileObject¶

type¶

Gets the type of this JobFileObject.

Returns: The type of this JobFileObject.
Return type: char

mimetype¶

Gets the mimetype of this JobFileObject.

Returns: The mimetype of this JobFileObject.
Return type: char

modality¶

Gets the modality of this JobFileObject.

Returns: The modality of this JobFileObject.
Return type: char

classification¶

Gets the classification of this JobFileObject.

Returns: The classification of this JobFileObject.
Return type: containers.Map

tags¶

Gets the tags of this JobFileObject.

Returns: The tags of this JobFileObject.
Return type: vector[char]

info¶

Gets the info of this JobFileObject.

Returns: The info of this JobFileObject.
Return type: containers.Map

size¶

Gets the size of this JobFileObject.

Returns: The size of this JobFileObject.
Return type: integer

zipMemberCount¶

Gets the zipMemberCount of this JobFileObject.

Returns: The zipMemberCount of this JobFileObject.
Return type: integer

version¶

Gets the version of this JobFileObject.

Returns: The version of this JobFileObject.
Return type: integer

fileId¶

Gets the fileId of this JobFileObject.

Returns: The fileId of this JobFileObject.
Return type: char

origin¶

Gets the origin of this JobFileObject.

Returns: The origin of this JobFileObject.
Return type: Origin

JobFileObjectListOutput¶

class JobFileObjectListOutput¶

type¶

Gets the type of this JobFileObjectListOutput.

Returns: The type of this JobFileObjectListOutput.
Return type: char

mimetype¶

Gets the mimetype of this JobFileObjectListOutput.

Returns: The mimetype of this JobFileObjectListOutput.
Return type: char

modality¶

Gets the modality of this JobFileObjectListOutput.

Returns: The modality of this JobFileObjectListOutput.
Return type: char

classification¶

Gets the classification of this JobFileObjectListOutput.

Returns: The classification of this JobFileObjectListOutput.
Return type: containers.Map

tags¶

Gets the tags of this JobFileObjectListOutput.

Returns: The tags of this JobFileObjectListOutput.
Return type: vector[char]

size¶

Gets the size of this JobFileObjectListOutput.

Returns: The size of this JobFileObjectListOutput.
Return type: integer

zipMemberCount¶

Gets the zipMemberCount of this JobFileObjectListOutput.

Returns: The zipMemberCount of this JobFileObjectListOutput.
Return type: integer

origin¶

Gets the origin of this JobFileObjectListOutput.

Returns: The origin of this JobFileObjectListOutput.
Return type: Origin

version¶

Gets the version of this JobFileObjectListOutput.

Returns: The version of this JobFileObjectListOutput.
Return type: integer

fileId¶

Gets the fileId of this JobFileObjectListOutput.

Returns: The fileId of this JobFileObjectListOutput.
Return type: char

JobGearMatch¶

class JobGearMatch¶

JobInputsArrayItem¶

class JobInputsArrayItem¶

type¶

The type of container (e.g. session)

Returns: The type of this JobInputsArrayItem.
Return type: char

id¶

Unique database ID

Returns: The id of this JobInputsArrayItem.
Return type: char

name¶

The name of the file on disk

Returns: The name of this JobInputsArrayItem.
Return type: char

input¶

Gets the input of this JobInputsArrayItem.

Returns: The input of this JobInputsArrayItem.
Return type: char

base¶

Gets the base of this JobInputsArrayItem.

Returns: The base of this JobInputsArrayItem.
Return type: char

found¶

Gets the found of this JobInputsArrayItem.

Returns: The found of this JobInputsArrayItem.
Return type: logical

JobInputsItem¶

class JobInputsItem¶

type¶

Gets the type of this JobInputsItem.

Returns: The type of this JobInputsItem.
Return type: char

uri¶

Gets the uri of this JobInputsItem.

Returns: The uri of this JobInputsItem.
Return type: char

location¶

Gets the location of this JobInputsItem.

Returns: The location of this JobInputsItem.
Return type: char

vu¶

Gets the vu of this JobInputsItem.

Returns: The vu of this JobInputsItem.
Return type: char

JobInputsObject¶

class JobInputsObject¶

JobListEntry¶

class JobListEntry¶

JobListOutput¶

class JobListOutput¶

gearId¶

Gets the gearId of this JobListOutput.

Returns: The gearId of this JobListOutput.
Return type: char

gearInfo¶

Gets the gearInfo of this JobListOutput.

Returns: The gearInfo of this JobListOutput.
Return type: GearInfo

ruleId¶

Gets the ruleId of this JobListOutput.

Returns: The ruleId of this JobListOutput.
Return type: char

roleId¶

Gets the roleId of this JobListOutput.

Returns: The roleId of this JobListOutput.
Return type: char

inputs¶

Gets the inputs of this JobListOutput.

Returns: The inputs of this JobListOutput.
Return type: LegacyInput

destination¶

Gets the destination of this JobListOutput.

Returns: The destination of this JobListOutput.
Return type: ContainerReference

tags¶

Gets the tags of this JobListOutput.

Returns: The tags of this JobListOutput.
Return type: vector[char]

priority¶

Gets the priority of this JobListOutput.

Returns: The priority of this JobListOutput.
Return type: AllOfJobListOutputPriority

attempt¶

Gets the attempt of this JobListOutput.

Returns: The attempt of this JobListOutput.
Return type: integer

previousJobId¶

Gets the previousJobId of this JobListOutput.

Returns: The previousJobId of this JobListOutput.
Return type: char

created¶

Gets the created of this JobListOutput.

Returns: The created of this JobListOutput.
Return type: datetime

modified¶

Gets the modified of this JobListOutput.

Returns: The modified of this JobListOutput.
Return type: datetime

retried¶

Gets the retried of this JobListOutput.

Returns: The retried of this JobListOutput.
Return type: datetime

state¶

Gets the state of this JobListOutput.

Returns: The state of this JobListOutput.
Return type: JobState

request¶

Gets the request of this JobListOutput.

Returns: The request of this JobListOutput.
Return type: JobRequest

id¶

Gets the id of this JobListOutput.

Returns: The id of this JobListOutput.
Return type: char

config¶

Gets the config of this JobListOutput.

Returns: The config of this JobListOutput.
Return type: JobListOutputConfig

origin¶

Gets the origin of this JobListOutput.

Returns: The origin of this JobListOutput.
Return type: Origin

savedFiles¶

Gets the savedFiles of this JobListOutput.

Returns: The savedFiles of this JobListOutput.
Return type: vector[char]

outputs¶

Gets the outputs of this JobListOutput.

Returns: The outputs of this JobListOutput.
Return type: FileListOutput

deletedOutputs¶

Gets the deletedOutputs of this JobListOutput.

Returns: The deletedOutputs of this JobListOutput.
Return type: DeletedFile

batch¶

Gets the batch of this JobListOutput.

Returns: The batch of this JobListOutput.
Return type: char

failedOutputAccepted¶

Gets the failedOutputAccepted of this JobListOutput.

Returns: The failedOutputAccepted of this JobListOutput.
Return type: logical

profile¶

Gets the profile of this JobListOutput.

Returns: The profile of this JobListOutput.
Return type: JobProfile

failureReason¶

Gets the failureReason of this JobListOutput.

Returns: The failureReason of this JobListOutput.
Return type: char

relatedContainerIds¶

Gets the relatedContainerIds of this JobListOutput.

Returns: The relatedContainerIds of this JobListOutput.
Return type: vector[char]

label¶

Gets the label of this JobListOutput.

Returns: The label of this JobListOutput.
Return type: char

computeProviderId¶

Gets the computeProviderId of this JobListOutput.

Returns: The computeProviderId of this JobListOutput.
Return type: char

parents¶

Gets the parents of this JobListOutput.

Returns: The parents of this JobListOutput.
Return type: JobParents

parentInfo¶

Gets the parentInfo of this JobListOutput.

Returns: The parentInfo of this JobListOutput.
Return type: JobDetailParentInfo

transitions¶

Gets the transitions of this JobListOutput.

Returns: The transitions of this JobListOutput.
Return type: AllOfJobListOutputTransitions

JobListOutputConfig¶

class JobListOutputConfig¶

destination¶

Gets the destination of this JobListOutputConfig.

Returns: The destination of this JobListOutputConfig.
Return type: ContainerReference

inputs¶

Gets the inputs of this JobListOutputConfig.

Returns: The inputs of this JobListOutputConfig.
Return type: Object

config¶

Gets the config of this JobListOutputConfig.

Returns: The config of this JobListOutputConfig.
Return type: containers.Map

JobLog¶

class JobLog¶

fd¶

Gets the fd of this JobLog.

Returns: The fd of this JobLog.
Return type: integer

msg¶

Gets the msg of this JobLog.

Returns: The msg of this JobLog.
Return type: char

JobLogColumn¶

An enumeration.

class JobLogColumn¶: An enumeration.

JobLogRecord¶

class JobLogRecord¶

id¶

Gets the id of this JobLogRecord.

Returns: The id of this JobLogRecord.
Return type: char

logs¶

Gets the logs of this JobLogRecord.

Returns: The logs of this JobLogRecord.
Return type: JobLog

JobModify¶

class JobModify¶

state¶

Gets the state of this JobModify.

Returns: The state of this JobModify.
Return type: JobState

failureReason¶

Gets the failureReason of this JobModify.

Returns: The failureReason of this JobModify.
Return type: char

JobOrigin¶

class JobOrigin¶

type¶

Gets the type of this JobOrigin.

Returns: The type of this JobOrigin.
Return type: char

id¶

Gets the id of this JobOrigin.

Returns: The id of this JobOrigin.
Return type: char

JobOutput¶

Output of a Job

class JobOutput¶

Output of a Job

gearId¶

Gets the gearId of this JobOutput.

Returns: The gearId of this JobOutput.
Return type: char

gearInfo¶

Gets the gearInfo of this JobOutput.

Returns: The gearInfo of this JobOutput.
Return type: GearInfo

ruleId¶

Gets the ruleId of this JobOutput.

Returns: The ruleId of this JobOutput.
Return type: char

roleId¶

Gets the roleId of this JobOutput.

Returns: The roleId of this JobOutput.
Return type: char

inputs¶

Gets the inputs of this JobOutput.

Returns: The inputs of this JobOutput.
Return type: FileReference

destination¶

Gets the destination of this JobOutput.

Returns: The destination of this JobOutput.
Return type: ContainerReference

tags¶

Gets the tags of this JobOutput.

Returns: The tags of this JobOutput.
Return type: vector[char]

priority¶

Gets the priority of this JobOutput.

Returns: The priority of this JobOutput.
Return type: AllOfJobOutputPriority

attempt¶

Gets the attempt of this JobOutput.

Returns: The attempt of this JobOutput.
Return type: integer

previousJobId¶

Gets the previousJobId of this JobOutput.

Returns: The previousJobId of this JobOutput.
Return type: char

created¶

Gets the created of this JobOutput.

Returns: The created of this JobOutput.
Return type: datetime

modified¶

Gets the modified of this JobOutput.

Returns: The modified of this JobOutput.
Return type: datetime

retried¶

Gets the retried of this JobOutput.

Returns: The retried of this JobOutput.
Return type: datetime

state¶

Gets the state of this JobOutput.

Returns: The state of this JobOutput.
Return type: JobState

request¶

Gets the request of this JobOutput.

Returns: The request of this JobOutput.
Return type: JobRequest

id¶

Gets the id of this JobOutput.

Returns: The id of this JobOutput.
Return type: char

config¶

Gets the config of this JobOutput.

Returns: The config of this JobOutput.
Return type: JobOutputConfig

origin¶

Gets the origin of this JobOutput.

Returns: The origin of this JobOutput.
Return type: Origin

savedFiles¶

Gets the savedFiles of this JobOutput.

Returns: The savedFiles of this JobOutput.
Return type: vector[char]

outputs¶

Gets the outputs of this JobOutput.

Returns: The outputs of this JobOutput.
Return type: FileOutput

deletedOutputs¶

Gets the deletedOutputs of this JobOutput.

Returns: The deletedOutputs of this JobOutput.
Return type: DeletedFile

producedMetadata¶

Gets the producedMetadata of this JobOutput.

Returns: The producedMetadata of this JobOutput.
Return type: containers.Map

batch¶

Gets the batch of this JobOutput.

Returns: The batch of this JobOutput.
Return type: char

failedOutputAccepted¶

Gets the failedOutputAccepted of this JobOutput.

Returns: The failedOutputAccepted of this JobOutput.
Return type: logical

profile¶

Gets the profile of this JobOutput.

Returns: The profile of this JobOutput.
Return type: JobProfile

failureReason¶

Gets the failureReason of this JobOutput.

Returns: The failureReason of this JobOutput.
Return type: char

relatedContainerIds¶

Gets the relatedContainerIds of this JobOutput.

Returns: The relatedContainerIds of this JobOutput.
Return type: vector[char]

label¶

Gets the label of this JobOutput.

Returns: The label of this JobOutput.
Return type: char

computeProviderId¶

Gets the computeProviderId of this JobOutput.

Returns: The computeProviderId of this JobOutput.
Return type: char

parents¶

Gets the parents of this JobOutput.

Returns: The parents of this JobOutput.
Return type: JobParents

transitions¶

Gets the transitions of this JobOutput.

Returns: The transitions of this JobOutput.
Return type: AllOfJobOutputTransitions

parentInfo¶

Gets the parentInfo of this JobOutput.

Returns: The parentInfo of this JobOutput.
Return type: JobDetailParentInfo

JobOutputConfig¶

class JobOutputConfig¶

destination¶

Gets the destination of this JobOutputConfig.

Returns: The destination of this JobOutputConfig.
Return type: ContainerReference

inputs¶

Gets the inputs of this JobOutputConfig.

Returns: The inputs of this JobOutputConfig.
Return type: Object

config¶

Gets the config of this JobOutputConfig.

Returns: The config of this JobOutputConfig.
Return type: containers.Map

JobParents¶

class JobParents¶

group¶

Gets the group of this JobParents.

Returns: The group of this JobParents.
Return type: char

project¶

Gets the project of this JobParents.

Returns: The project of this JobParents.
Return type: char

subject¶

Gets the subject of this JobParents.

Returns: The subject of this JobParents.
Return type: char

session¶

Gets the session of this JobParents.

Returns: The session of this JobParents.
Return type: char

acquisition¶

Gets the acquisition of this JobParents.

Returns: The acquisition of this JobParents.
Return type: char

analysis¶

Gets the analysis of this JobParents.

Returns: The analysis of this JobParents.
Return type: char

JobPriority¶

An enumeration.

class JobPriority¶: An enumeration.

JobPriorityUpdate¶

class JobPriorityUpdate¶

jobIds¶

Gets the jobIds of this JobPriorityUpdate.

Returns: The jobIds of this JobPriorityUpdate.
Return type: vector[char]

priority¶

Gets the priority of this JobPriorityUpdate.

Returns: The priority of this JobPriorityUpdate.
Return type: char

JobProfile¶

class JobProfile¶

totalInputFiles¶

The number of input files

Returns: The totalInputFiles of this JobProfile.
Return type: integer

totalInputSizeBytes¶

The combined size of all input files, in bytes

Returns: The totalInputSizeBytes of this JobProfile.
Return type: integer

totalOutputFiles¶

The number of output files

Returns: The totalOutputFiles of this JobProfile.
Return type: integer

totalOutputSizeBytes¶

The combined size of all output files, in bytes

Returns: The totalOutputSizeBytes of this JobProfile.
Return type: integer

preparationTimeMs¶

The length of time taken to download gear container and inputs, in milliseconds

Returns: The preparationTimeMs of this JobProfile.
Return type: integer

elapsedTimeMs¶

The runtime of the job, in milliseconds

Returns: The elapsedTimeMs of this JobProfile.
Return type: integer

uploadTimeMs¶

The length of time taken to upload the job’s outputs, in milliseconds

Returns: The uploadTimeMs of this JobProfile.
Return type: integer

totalTimeMs¶

The total length of time from start to finish, in milliseconds

Returns: The totalTimeMs of this JobProfile.
Return type: integer

versions¶

Gets the versions of this JobProfile.

Returns: The versions of this JobProfile.
Return type: JobVersionInfo

executor¶

Gets the executor of this JobProfile.

Returns: The executor of this JobProfile.
Return type: JobExecutorInfo

JobProfileInput¶

class JobProfileInput¶

JobRequest¶

class JobRequest¶

inputs¶

Gets the inputs of this JobRequest.

Returns: The inputs of this JobRequest.
Return type: JobInputsItem

target¶

Gets the target of this JobRequest.

Returns: The target of this JobRequest.
Return type: containers.Map

outputs¶

Gets the outputs of this JobRequest.

Returns: The outputs of this JobRequest.
Return type: vector[containers.Map]

JobRequestItem¶

Representation of a request input item that the engine must download Attributes: type (JobRequestItemType): The type of request to be made uri (str): The uri to make the request to location (str): Where to download the the input to vu (Optional[str]): Absolutely no idea

class JobRequestItem¶

Representation of a request input item that the engine must download Attributes: type (JobRequestItemType): The type of request to be made uri (str): The uri to make the request to location (str): Where to download the the input to vu (Optional[str]): Absolutely no idea

type¶

Gets the type of this JobRequestItem.

Returns: The type of this JobRequestItem.
Return type: JobRequestItemType

uri¶

Gets the uri of this JobRequestItem.

Returns: The uri of this JobRequestItem.
Return type: char

location¶

Gets the location of this JobRequestItem.

Returns: The location of this JobRequestItem.
Return type: char

vu¶

Gets the vu of this JobRequestItem.

Returns: The vu of this JobRequestItem.
Return type: char

JobRequestItemType¶

An enumeration.

class JobRequestItemType¶: An enumeration.

JobRequestTarget¶

Represents the information needed to run the gear Attributes: command (List[str]): The command run inside the docker container to run the gear environment (Dict[str, str]): The environment variables to set inside the container uid (Optional[int]): The uid gid (Optional[int]): The gid dir (str): The directory to place assets under

class JobRequestTarget¶

Represents the information needed to run the gear Attributes: command (List[str]): The command run inside the docker container to run the gear environment (Dict[str, str]): The environment variables to set inside the container uid (Optional[int]): The uid gid (Optional[int]): The gid dir (str): The directory to place assets under

command¶

Gets the command of this JobRequestTarget.

Returns: The command of this JobRequestTarget.
Return type: vector[char]

env¶

Gets the env of this JobRequestTarget.

Returns: The env of this JobRequestTarget.
Return type: containers.Map[String, char]

uid¶

Gets the uid of this JobRequestTarget.

Returns: The uid of this JobRequestTarget.
Return type: integer

gid¶

Gets the gid of this JobRequestTarget.

Returns: The gid of this JobRequestTarget.
Return type: integer

dir¶

Gets the dir of this JobRequestTarget.

Returns: The dir of this JobRequestTarget.
Return type: char

JobState¶

The valid states of a job

class JobState¶: The valid states of a job

JobStateCounts¶

class JobStateCounts¶

JobStatsByState¶

class JobStatsByState¶

JobTicketOutput¶

class JobTicketOutput¶

ticket¶

The ticket to use to perform file uploads to a job

Returns: The ticket of this JobTicketOutput.
Return type: char

JobTransitionTimes¶

class JobTransitionTimes¶

running¶

The timestamp when the job transitioned into the running state

Returns: The running of this JobTransitionTimes.
Return type: datetime

failed¶

The timestamp when the job transitioned into the failed state

Returns: The failed of this JobTransitionTimes.
Return type: datetime

complete¶

The timestamp when the job transitioned into the complete state

Returns: The complete of this JobTransitionTimes.
Return type: datetime

cancelled¶

The timestamp when the job transitioned into the cancelled state

Returns: The cancelled of this JobTransitionTimes.
Return type: datetime

JobVersionInfo¶

An object that contains known version info for components involved in the job

class JobVersionInfo¶: An object that contains known version info for components involved in the job

JobsByState¶

Represents the count of jobs in each state Attributes: pending (int): Number of jobs pending running (int): Number of jobs running failed (int): Number of jobs failed complete (int): Number of jobs complete cancelled (int): Number of jobs cancelled

class JobsByState¶

Represents the count of jobs in each state Attributes: pending (int): Number of jobs pending running (int): Number of jobs running failed (int): Number of jobs failed complete (int): Number of jobs complete cancelled (int): Number of jobs cancelled

pending¶

Gets the pending of this JobsByState.

Returns: The pending of this JobsByState.
Return type: integer

running¶

Gets the running of this JobsByState.

Returns: The running of this JobsByState.
Return type: integer

failed¶

Gets the failed of this JobsByState.

Returns: The failed of this JobsByState.
Return type: integer

complete¶

Gets the complete of this JobsByState.

Returns: The complete of this JobsByState.
Return type: integer

cancelled¶

Gets the cancelled of this JobsByState.

Returns: The cancelled of this JobsByState.
Return type: integer

JobsList¶

class JobsList¶

jobs¶

Gets the jobs of this JobsList.

Returns: The jobs of this JobsList.
Return type: JobListOutput

JoinOriginDevice¶

class JoinOriginDevice¶

name¶

Gets the name of this JoinOriginDevice.

Returns: The name of this JoinOriginDevice.
Return type: char

JoinOriginJob¶

class JoinOriginJob¶

created¶

Gets the created of this JoinOriginJob.

Returns: The created of this JoinOriginJob.
Return type: datetime

modified¶

Gets the modified of this JoinOriginJob.

Returns: The modified of this JoinOriginJob.
Return type: datetime

gearInfo¶

Gets the gearInfo of this JoinOriginJob.

Returns: The gearInfo of this JoinOriginJob.
Return type: GearInfo

JoinOriginUser¶

class JoinOriginUser¶

firstname¶

Gets the firstname of this JoinOriginUser.

Returns: The firstname of this JoinOriginUser.
Return type: char

lastname¶

Gets the lastname of this JoinOriginUser.

Returns: The lastname of this JoinOriginUser.
Return type: char

JoinOrigins¶

class JoinOrigins¶

device¶

Gets the device of this JoinOrigins.

Returns: The device of this JoinOrigins.
Return type: JoinOriginDevice

job¶

Gets the job of this JoinOrigins.

Returns: The job of this JoinOrigins.
Return type: JoinOriginJob

user¶

Gets the user of this JoinOrigins.

Returns: The user of this JoinOrigins.
Return type: JoinOriginUser

JoinType¶

An enumeration.

class JoinType¶: An enumeration.

LdapSync¶

class LdapSync¶

groupDn¶

Gets the groupDn of this LdapSync.

Returns: The groupDn of this LdapSync.
Return type: char

syncError¶

Gets the syncError of this LdapSync.

Returns: The syncError of this LdapSync.
Return type: char

lastAttempt¶

Gets the lastAttempt of this LdapSync.

Returns: The lastAttempt of this LdapSync.
Return type: char

lastSuccess¶

Gets the lastSuccess of this LdapSync.

Returns: The lastSuccess of this LdapSync.
Return type: char

LdapSyncConfig¶

LDAP sync configuration / user input

class LdapSyncConfig¶

LDAP sync configuration / user input

groupDn¶

Gets the groupDn of this LdapSyncConfig.

Returns: The groupDn of this LdapSyncConfig.
Return type: char

LdapSyncInput¶

class LdapSyncInput¶

LdapSyncStatus¶

LDAP sync status embedded in site settings / projects

class LdapSyncStatus¶

LDAP sync status embedded in site settings / projects

groupDn¶

Gets the groupDn of this LdapSyncStatus.

Returns: The groupDn of this LdapSyncStatus.
Return type: char

lastAttempt¶

Gets the lastAttempt of this LdapSyncStatus.

Returns: The lastAttempt of this LdapSyncStatus.
Return type: datetime

lastSuccess¶

Gets the lastSuccess of this LdapSyncStatus.

Returns: The lastSuccess of this LdapSyncStatus.
Return type: datetime

syncError¶

Gets the syncError of this LdapSyncStatus.

Returns: The syncError of this LdapSyncStatus.
Return type: char

LegacyApiKeyOutput¶

class LegacyApiKeyOutput¶

label¶

Gets the label of this LegacyApiKeyOutput.

Returns: The label of this LegacyApiKeyOutput.
Return type: char

key¶

Gets the key of this LegacyApiKeyOutput.

Returns: The key of this LegacyApiKeyOutput.
Return type: char

created¶

Gets the created of this LegacyApiKeyOutput.

Returns: The created of this LegacyApiKeyOutput.
Return type: datetime

lastUsed¶

Gets the lastUsed of this LegacyApiKeyOutput.

Returns: The lastUsed of this LegacyApiKeyOutput.
Return type: datetime

unencryptedSecret¶

Gets the unencryptedSecret of this LegacyApiKeyOutput.

Returns: The unencryptedSecret of this LegacyApiKeyOutput.
Return type: char

LegacyInput¶

Represent a legacy form of the input, when inputs are in arrays Attributes: input (str): The input key in the gear type (ContainerType): The type of container the file is in id (str): The id of the container the file is in name (str): The name of the file

class LegacyInput¶

Represent a legacy form of the input, when inputs are in arrays Attributes: input (str): The input key in the gear type (ContainerType): The type of container the file is in id (str): The id of the container the file is in name (str): The name of the file

input¶

Gets the input of this LegacyInput.

Returns: The input of this LegacyInput.
Return type: char

type¶

Gets the type of this LegacyInput.

Returns: The type of this LegacyInput.
Return type: ContainerType

id¶

Gets the id of this LegacyInput.

Returns: The id of this LegacyInput.
Return type: char

name¶

Gets the name of this LegacyInput.

Returns: The name of this LegacyInput.
Return type: char

LocalStorage¶

class LocalStorage¶

path¶

Gets the path of this LocalStorage.

Returns: The path of this LocalStorage.
Return type: char

configType¶

Gets the configType of this LocalStorage.

Returns: The configType of this LocalStorage.
Return type: char

configClass¶

Gets the configClass of this LocalStorage.

Returns: The configClass of this LocalStorage.
Return type: char

Location¶

Representation of a file’s location inside the gear container Attributes: path (str): The path to the file inside the gear container name (str): The name of the file

class Location¶

Representation of a file’s location inside the gear container Attributes: path (str): The path to the file inside the gear container name (str): The name of the file

path¶

Gets the path of this Location.

Returns: The path of this Location.
Return type: char

name¶

Gets the name of this Location.

Returns: The name of this Location.
Return type: char

Locked¶

class Locked¶

reason¶

Gets the reason of this Locked.

Returns: The reason of this Locked.
Return type: ProjectLockingReason

timestamp¶

Gets the timestamp of this Locked.

Returns: The timestamp of this Locked.
Return type: datetime

origin¶

Gets the origin of this Locked.

Returns: The origin of this Locked.
Return type: Origin

MLSetFilter¶

class MLSetFilter¶

plus¶

Gets the plus of this MLSetFilter.

Returns: The plus of this MLSetFilter.
Return type: MLType

minus¶

Gets the minus of this MLSetFilter.

Returns: The minus of this MLSetFilter.
Return type: MLType

MLType¶

An enumeration.

class MLType¶: An enumeration.

MasterSubjectCodeDobInput¶

class MasterSubjectCodeDobInput¶

firstName¶

First name

Returns: The firstName of this MasterSubjectCodeDobInput.
Return type: char

lastName¶

Last name

Returns: The lastName of this MasterSubjectCodeDobInput.
Return type: char

dateOfBirth¶

Date of birth in YYYY-MM-DD format

Returns: The dateOfBirth of this MasterSubjectCodeDobInput.
Return type: char

patientId¶

Patient id

Returns: The patientId of this MasterSubjectCodeDobInput.
Return type: char

usePatientId¶

Use patient ID for identification or first name, last name, DOB

Returns: The usePatientId of this MasterSubjectCodeDobInput.
Return type: logical

MasterSubjectCodeInput¶

class MasterSubjectCodeInput¶

patientId¶

Patient id

Returns: The patientId of this MasterSubjectCodeInput.
Return type: char

usePatientId¶

Use patient ID for identification or first name, last name, DOB

Returns: The usePatientId of this MasterSubjectCodeInput.
Return type: logical

firstName¶

First name

Returns: The firstName of this MasterSubjectCodeInput.
Return type: char

lastName¶

Last name

Returns: The lastName of this MasterSubjectCodeInput.
Return type: char

dateOfBirth¶

Date of birth in YYYY-MM-DD format

Returns: The dateOfBirth of this MasterSubjectCodeInput.
Return type: char

MasterSubjectCodeOutput¶

class MasterSubjectCodeOutput¶

code¶

Master subject code

Returns: The code of this MasterSubjectCodeOutput.
Return type: char

MatchedAcquisitionOutput¶

Representation of the matched acquisition Attributes: id (str): The id of the acquisition parents (AcquisitionParents): The mapping of parents to parent id for the acquisition label (str): The label of the acquisition metadata (Optional[dict]): TODO: description session (str): The parent session [dropped, still in input/output models] acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp created (datetime.datetime): The time the acquisition was created in flywheel modified (datetime.datetime): The last modified time of the acquisition revision (int): The revision number of the acquisition permissions (List[RolePermission]): The list of permissions on the acquisition tags (List[str]): The list of tags analyses (List[Analysis]): The list of analyses children of the acquisition collections (List[str]): The collections the acquisition is a part of inputs: job inputs model to create the job for this container

class MatchedAcquisitionOutput¶

Representation of the matched acquisition Attributes: id (str): The id of the acquisition parents (AcquisitionParents): The mapping of parents to parent id for the acquisition label (str): The label of the acquisition metadata (Optional[dict]): TODO: description session (str): The parent session [dropped, still in input/output models] acquisition timestamp (Optional[datetime.datetime]): The timestamp of the acquisition timezone (Optional[str]): The timezone of the timestamp created (datetime.datetime): The time the acquisition was created in flywheel modified (datetime.datetime): The last modified time of the acquisition revision (int): The revision number of the acquisition permissions (List[RolePermission]): The list of permissions on the acquisition tags (List[str]): The list of tags analyses (List[Analysis]): The list of analyses children of the acquisition collections (List[str]): The collections the acquisition is a part of inputs: job inputs model to create the job for this container

id¶

Gets the id of this MatchedAcquisitionOutput.

Returns: The id of this MatchedAcquisitionOutput.
Return type: char

parents¶

Gets the parents of this MatchedAcquisitionOutput.

Returns: The parents of this MatchedAcquisitionOutput.
Return type: AcquisitionParents

label¶

Gets the label of this MatchedAcquisitionOutput.

Returns: The label of this MatchedAcquisitionOutput.
Return type: char

metadata¶

Gets the metadata of this MatchedAcquisitionOutput.

Returns: The metadata of this MatchedAcquisitionOutput.
Return type: containers.Map

timestamp¶

Gets the timestamp of this MatchedAcquisitionOutput.

Returns: The timestamp of this MatchedAcquisitionOutput.
Return type: datetime

timezone¶

Gets the timezone of this MatchedAcquisitionOutput.

Returns: The timezone of this MatchedAcquisitionOutput.
Return type: char

created¶

Gets the created of this MatchedAcquisitionOutput.

Returns: The created of this MatchedAcquisitionOutput.
Return type: datetime

modified¶

Gets the modified of this MatchedAcquisitionOutput.

Returns: The modified of this MatchedAcquisitionOutput.
Return type: datetime

revision¶

Gets the revision of this MatchedAcquisitionOutput.

Returns: The revision of this MatchedAcquisitionOutput.
Return type: integer

permissions¶

Gets the permissions of this MatchedAcquisitionOutput.

Returns: The permissions of this MatchedAcquisitionOutput.
Return type: RolePermission

tags¶

Gets the tags of this MatchedAcquisitionOutput.

Returns: The tags of this MatchedAcquisitionOutput.
Return type: vector[char]

analyses¶

Gets the analyses of this MatchedAcquisitionOutput.

Returns: The analyses of this MatchedAcquisitionOutput.
Return type: Analysis

collections¶

Gets the collections of this MatchedAcquisitionOutput.

Returns: The collections of this MatchedAcquisitionOutput.
Return type: vector[char]

inputs¶

Gets the inputs of this MatchedAcquisitionOutput.

Returns: The inputs of this MatchedAcquisitionOutput.
Return type: Object

Modality¶

class Modality¶

id¶

Unique database ID

Returns: The id of this Modality.
Return type: char

classification¶

Gets the classification of this Modality.

Returns: The classification of this Modality.
Return type: CommonClassification

description¶

Gets the description of this Modality.

Returns: The description of this Modality.
Return type: char

active¶

Gets the active of this Modality.

Returns: The active of this Modality.
Return type: logical

ModalityInput¶

class ModalityInput¶

classification¶

Gets the classification of this ModalityInput.

Returns: The classification of this ModalityInput.
Return type: containers.Map[String, vector[char]]

active¶

Gets the active of this ModalityInput.

Returns: The active of this ModalityInput.
Return type: logical

description¶

Gets the description of this ModalityInput.

Returns: The description of this ModalityInput.
Return type: char

id¶

Gets the id of this ModalityInput.

Returns: The id of this ModalityInput.
Return type: char

ModalityModify¶

class ModalityModify¶

classification¶

Gets the classification of this ModalityModify.

Returns: The classification of this ModalityModify.
Return type: containers.Map[String, vector[char]]

active¶

Gets the active of this ModalityModify.

Returns: The active of this ModalityModify.
Return type: logical

description¶

Gets the description of this ModalityModify.

Returns: The description of this ModalityModify.
Return type: char

ModalityOutput¶

class ModalityOutput¶

id¶

Unique database ID

Returns: The id of this ModalityOutput.
Return type: char

classification¶

Gets the classification of this ModalityOutput.

Returns: The classification of this ModalityOutput.
Return type: containers.Map[String, vector[char]]

active¶

Gets the active of this ModalityOutput.

Returns: The active of this ModalityOutput.
Return type: logical

description¶

Gets the description of this ModalityOutput.

Returns: The description of this ModalityOutput.
Return type: char

rtsManaged¶

Gets the rtsManaged of this ModalityOutput.

Returns: The rtsManaged of this ModalityOutput.
Return type: logical

ModifiedResult¶

class ModifiedResult¶

modified¶

Gets the modified of this ModifiedResult.

Returns: The modified of this ModifiedResult.
Return type: integer

jobsSpawned¶

Gets the jobsSpawned of this ModifiedResult.

Returns: The jobsSpawned of this ModifiedResult.
Return type: integer

ModifyReportInput¶

class ModifyReportInput¶

status¶

Gets the status of this ModifyReportInput.

Returns: The status of this ModifyReportInput.
Return type: AuditTrailReportStatus

ModifyUserInput¶

class ModifyUserInput¶

firstname¶

Gets the firstname of this ModifyUserInput.

Returns: The firstname of this ModifyUserInput.
Return type: char

lastname¶

Gets the lastname of this ModifyUserInput.

Returns: The lastname of this ModifyUserInput.
Return type: char

email¶

Gets the email of this ModifyUserInput.

Returns: The email of this ModifyUserInput.
Return type: char

avatars¶

Gets the avatars of this ModifyUserInput.

Returns: The avatars of this ModifyUserInput.
Return type: Avatars

avatar¶

Gets the avatar of this ModifyUserInput.

Returns: The avatar of this ModifyUserInput.
Return type: char

roles¶

Gets the roles of this ModifyUserInput.

Returns: The roles of this ModifyUserInput.
Return type: RoleType

disabled¶

Gets the disabled of this ModifyUserInput.

Returns: The disabled of this ModifyUserInput.
Return type: logical

preferences¶

Gets the preferences of this ModifyUserInput.

Returns: The preferences of this ModifyUserInput.
Return type: UserPreferences

root¶

Gets the root of this ModifyUserInput.

Returns: The root of this ModifyUserInput.
Return type: logical

password¶

Gets the password of this ModifyUserInput.

Returns: The password of this ModifyUserInput.
Return type: char

multifactor¶

Gets the multifactor of this ModifyUserInput.

Returns: The multifactor of this ModifyUserInput.
Return type: MultifactorAccount

MultifactorAccount¶

class MultifactorAccount¶

authyId¶

Gets the authyId of this MultifactorAccount.

Returns: The authyId of this MultifactorAccount.
Return type: char

preferredChannel¶

Gets the preferredChannel of this MultifactorAccount.

Returns: The preferredChannel of this MultifactorAccount.
Return type: AllOfMultifactorAccountPreferredChannel

verified¶

Gets the verified of this MultifactorAccount.

Returns: The verified of this MultifactorAccount.
Return type: logical

Note¶

class Note¶

id¶

Unique database ID

Returns: The id of this Note.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this Note.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Note.
Return type: datetime

timestamp¶

Gets the timestamp of this Note.

Returns: The timestamp of this Note.
Return type: datetime

firstname¶

Gets the firstname of this Note.

Returns: The firstname of this Note.
Return type: char

lastname¶

Gets the lastname of this Note.

Returns: The lastname of this Note.
Return type: char

text¶

The actual contents of the note

Returns: The text of this Note.
Return type: char

user¶

Database ID of a user

Returns: The user of this Note.
Return type: char

avatar¶

Last modification time (automatically updated)

Returns: The avatar of this Note.
Return type: char

NoteInput¶

class NoteInput¶

text¶

Gets the text of this NoteInput.

Returns: The text of this NoteInput.
Return type: char

OpenTracing¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

class OpenTracing¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

agentHost¶

Gets the agentHost of this OpenTracing.

Returns: The agentHost of this OpenTracing.
Return type: char

agentPort¶

Gets the agentPort of this OpenTracing.

Returns: The agentPort of this OpenTracing.
Return type: integer

samplerType¶

Gets the samplerType of this OpenTracing.

Returns: The samplerType of this OpenTracing.
Return type: char

samplerParam¶

Gets the samplerParam of this OpenTracing.

Returns: The samplerParam of this OpenTracing.
Return type: float

OptionalInputPolicy¶

The policies to set inputs when running jobs Attributes: 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.

class OptionalInputPolicy¶: The policies to set inputs when running jobs Attributes: 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.

Order¶

An enumeration.

class Order¶: An enumeration.

OrganSystem¶

An enumeration.

class OrganSystem¶: An enumeration.

Origin¶

class Origin¶

type¶

Gets the type of this Origin.

Returns: The type of this Origin.
Return type: char

id¶

Gets the id of this Origin.

Returns: The id of this Origin.
Return type: char

OriginType¶

An enumeration.

class OriginType¶: An enumeration.

OrphanedCount¶

class OrphanedCount¶

orphaned¶

Gets the orphaned of this OrphanedCount.

Returns: The orphaned of this OrphanedCount.
Return type: integer

OutputUserPage¶

Generic model of a page.

class OutputUserPage¶

Generic model of a page.

count¶

Gets the count of this OutputUserPage.

Returns: The count of this OutputUserPage.
Return type: integer

total¶

Gets the total of this OutputUserPage.

Returns: The total of this OutputUserPage.
Return type: integer

results¶

Gets the results of this OutputUserPage.

Returns: The results of this OutputUserPage.
Return type: UserOutput

PackfileCleanupOutput¶

class PackfileCleanupOutput¶

removed¶

Gets the removed of this PackfileCleanupOutput.

Returns: The removed of this PackfileCleanupOutput.
Return type: PackfileRemovedOutput

PackfileRemovedOutput¶

class PackfileRemovedOutput¶

tokens¶

Gets the tokens of this PackfileRemovedOutput.

Returns: The tokens of this PackfileRemovedOutput.
Return type: integer

files¶

Gets the files of this PackfileRemovedOutput.

Returns: The files of this PackfileRemovedOutput.
Return type: integer

PackfileStart¶

class PackfileStart¶

Page¶

Generic model of a page.

class Page¶

Generic model of a page.

count¶

Gets the count of this Page.

Returns: The count of this Page.
Return type: integer

total¶

Gets the total of this Page.

Returns: The total of this Page.
Return type: integer

results¶

Gets the results of this Page.

Returns: The results of this Page.
Return type: Object

PageFileOutput ¶

Generic model of a page.

class PageFileOutput_¶

Generic model of a page.

count¶

Gets the count of this PageFileOutput.

Returns: The count of this PageFileOutput.
Return type: integer

total¶

Gets the total of this PageFileOutput.

Returns: The total of this PageFileOutput.
Return type: integer

results¶

Gets the results of this PageFileOutput.

Returns: The results of this PageFileOutput.
Return type: FileOutput

ParsedQueryResponse¶

class ParsedQueryResponse¶

valid¶

Whether the structured query was valid or not

Returns: The valid of this ParsedQueryResponse.
Return type: logical

errors¶

Gets the errors of this ParsedQueryResponse.

Returns: The errors of this ParsedQueryResponse.
Return type: SearchParseError

PermissionAccessPermission¶

class PermissionAccessPermission¶

PremadeJobsBatchJobOutput¶

class PremadeJobsBatchJobOutput¶

id¶

Gets the id of this PremadeJobsBatchJobOutput.

Returns: The id of this PremadeJobsBatchJobOutput.
Return type: char

origin¶

Gets the origin of this PremadeJobsBatchJobOutput.

Returns: The origin of this PremadeJobsBatchJobOutput.
Return type: Origin

jobs¶

Gets the jobs of this PremadeJobsBatchJobOutput.

Returns: The jobs of this PremadeJobsBatchJobOutput.
Return type: vector[char]

state¶

Gets the state of this PremadeJobsBatchJobOutput.

Returns: The state of this PremadeJobsBatchJobOutput.
Return type: JobState

created¶

Gets the created of this PremadeJobsBatchJobOutput.

Returns: The created of this PremadeJobsBatchJobOutput.
Return type: datetime

modified¶

Gets the modified of this PremadeJobsBatchJobOutput.

Returns: The modified of this PremadeJobsBatchJobOutput.
Return type: datetime

PremadeJobsBatchJobOutputInflatedJobs¶

class PremadeJobsBatchJobOutputInflatedJobs¶

id¶

Gets the id of this PremadeJobsBatchJobOutputInflatedJobs.

Returns: The id of this PremadeJobsBatchJobOutputInflatedJobs.
Return type: char

origin¶

Gets the origin of this PremadeJobsBatchJobOutputInflatedJobs.

Returns: The origin of this PremadeJobsBatchJobOutputInflatedJobs.
Return type: Origin

jobs¶

Gets the jobs of this PremadeJobsBatchJobOutputInflatedJobs.

Returns: The jobs of this PremadeJobsBatchJobOutputInflatedJobs.
Return type: Job

state¶

Gets the state of this PremadeJobsBatchJobOutputInflatedJobs.

Returns: The state of this PremadeJobsBatchJobOutputInflatedJobs.
Return type: JobState

created¶

Gets the created of this PremadeJobsBatchJobOutputInflatedJobs.

Returns: The created of this PremadeJobsBatchJobOutputInflatedJobs.
Return type: datetime

modified¶

Gets the modified of this PremadeJobsBatchJobOutputInflatedJobs.

Returns: The modified of this PremadeJobsBatchJobOutputInflatedJobs.
Return type: datetime

PremadeJobsBatchProposal¶

class PremadeJobsBatchProposal¶

id¶

Unique database ID

Returns: The id of this PremadeJobsBatchProposal.
Return type: char

proposal¶

Gets the proposal of this PremadeJobsBatchProposal.

Returns: The proposal of this PremadeJobsBatchProposal.
Return type: PremadeJobsBatchProposalDetail

origin¶

Gets the origin of this PremadeJobsBatchProposal.

Returns: The origin of this PremadeJobsBatchProposal.
Return type: Origin

jobs¶

Gets the jobs of this PremadeJobsBatchProposal.

Returns: The jobs of this PremadeJobsBatchProposal.
Return type: vector[char]

state¶

Gets the state of this PremadeJobsBatchProposal.

Returns: The state of this PremadeJobsBatchProposal.
Return type: JobState

created¶

Creation time (automatically set)

Returns: The created of this PremadeJobsBatchProposal.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this PremadeJobsBatchProposal.
Return type: datetime

PremadeJobsBatchProposalDetail¶

class PremadeJobsBatchProposalDetail¶

preconstructedJobs¶

Gets the preconstructedJobs of this PremadeJobsBatchProposalDetail.

Returns: The preconstructedJobs of this PremadeJobsBatchProposalDetail.
Return type: InputJob

PremadeJobsBatchProposalInput¶

Set of jobs to be run as a batch

class PremadeJobsBatchProposalInput¶

Set of jobs to be run as a batch

jobs¶

Gets the jobs of this PremadeJobsBatchProposalInput.

Returns: The jobs of this PremadeJobsBatchProposalInput.
Return type: InputJob

Project¶

class Project¶

ProjectAET¶

Create new ProjectAET enabling DIMSE C-FIND on a FW project. Args: project_id (str|ObjectId): The Flywheel project the AET refers to.

class ProjectAET¶

Create new ProjectAET enabling DIMSE C-FIND on a FW project. Args: project_id (str|ObjectId): The Flywheel project the AET refers to.

id¶

Gets the id of this ProjectAET.

Returns: The id of this ProjectAET.
Return type: char

created¶

Gets the created of this ProjectAET.

Returns: The created of this ProjectAET.
Return type: datetime

aet¶

DICOM Application Entity Title

Returns: The aet of this ProjectAET.
Return type: char

creator¶

Database ID of a user

Returns: The creator of this ProjectAET.
Return type: char

host¶

DICOM service hostname or IP

Returns: The host of this ProjectAET.
Return type: char

port¶

DICOM service port number

Returns: The port of this ProjectAET.
Return type: integer

projectId¶

Unique database ID

Returns: The projectId of this ProjectAET.
Return type: char

ProjectAETInput¶

class ProjectAETInput¶

aet¶

DICOM Application Entity Title

Returns: The aet of this ProjectAETInput.
Return type: char

created¶

Gets the created of this ProjectAETInput.

Returns: The created of this ProjectAETInput.
Return type: datetime

creator¶

Gets the creator of this ProjectAETInput.

Returns: The creator of this ProjectAETInput.
Return type: char

projectId¶

Unique database ID

Returns: The projectId of this ProjectAETInput.
Return type: char

ProjectAcquisitionUpsertInput¶

class ProjectAcquisitionUpsertInput¶

ProjectAcquisitionUpsertOutput¶

class ProjectAcquisitionUpsertOutput¶

ProjectCatalogListOutput¶

class ProjectCatalogListOutput¶

ProjectContact¶

class ProjectContact¶

name¶

Gets the name of this ProjectContact.

Returns: The name of this ProjectContact.
Return type: char

email¶

Gets the email of this ProjectContact.

Returns: The email of this ProjectContact.
Return type: char

ProjectContainerOutput¶

class ProjectContainerOutput¶

id¶

Gets the id of this ProjectContainerOutput.

Returns: The id of this ProjectContainerOutput.
Return type: char

label¶

Gets the label of this ProjectContainerOutput.

Returns: The label of this ProjectContainerOutput.
Return type: char

description¶

Gets the description of this ProjectContainerOutput.

Returns: The description of this ProjectContainerOutput.
Return type: char

group¶

Gets the group of this ProjectContainerOutput.

Returns: The group of this ProjectContainerOutput.
Return type: char

parents¶

Gets the parents of this ProjectContainerOutput.

Returns: The parents of this ProjectContainerOutput.
Return type: ProjectParents

editions¶

Gets the editions of this ProjectContainerOutput.

Returns: The editions of this ProjectContainerOutput.
Return type: Edition

providers¶

Gets the providers of this ProjectContainerOutput.

Returns: The providers of this ProjectContainerOutput.
Return type: Providers

ldapSync¶

Gets the ldapSync of this ProjectContainerOutput.

Returns: The ldapSync of this ProjectContainerOutput.
Return type: LdapSyncStatus

permissions¶

Gets the permissions of this ProjectContainerOutput.

Returns: The permissions of this ProjectContainerOutput.
Return type: RolePermission

files¶

Gets the files of this ProjectContainerOutput.

Returns: The files of this ProjectContainerOutput.
Return type: FileOutput

info¶

Gets the info of this ProjectContainerOutput.

Returns: The info of this ProjectContainerOutput.
Return type: containers.Map

infoExists¶

Gets the infoExists of this ProjectContainerOutput.

Returns: The infoExists of this ProjectContainerOutput.
Return type: logical

notes¶

Gets the notes of this ProjectContainerOutput.

Returns: The notes of this ProjectContainerOutput.
Return type: Note

tags¶

Gets the tags of this ProjectContainerOutput.

Returns: The tags of this ProjectContainerOutput.
Return type: vector[char]

templates¶

Gets the templates of this ProjectContainerOutput.

Returns: The templates of this ProjectContainerOutput.
Return type: ProjectTemplate

noncompliantSessionCount¶

Gets the noncompliantSessionCount of this ProjectContainerOutput.

Returns: The noncompliantSessionCount of this ProjectContainerOutput.
Return type: integer

joinOrigin¶

Gets the joinOrigin of this ProjectContainerOutput.

Returns: The joinOrigin of this ProjectContainerOutput.
Return type: JoinOrigins

analyses¶

Gets the analyses of this ProjectContainerOutput.

Returns: The analyses of this ProjectContainerOutput.
Return type: Object

settings¶

Gets the settings of this ProjectContainerOutput.

Returns: The settings of this ProjectContainerOutput.
Return type: ProjectSettingsOutput

locked¶

Gets the locked of this ProjectContainerOutput.

Returns: The locked of this ProjectContainerOutput.
Return type: Locked

revision¶

Gets the revision of this ProjectContainerOutput.

Returns: The revision of this ProjectContainerOutput.
Return type: integer

modified¶

Gets the modified of this ProjectContainerOutput.

Returns: The modified of this ProjectContainerOutput.
Return type: datetime

created¶

Gets the created of this ProjectContainerOutput.

Returns: The created of this ProjectContainerOutput.
Return type: datetime

copyable¶

Gets the copyable of this ProjectContainerOutput.

Returns: The copyable of this ProjectContainerOutput.
Return type: logical

copyStatus¶

Gets the copyStatus of this ProjectContainerOutput.

Returns: The copyStatus of this ProjectContainerOutput.
Return type: ProjectCopyStatus

copyFailureReason¶

Gets the copyFailureReason of this ProjectContainerOutput.

Returns: The copyFailureReason of this ProjectContainerOutput.
Return type: char

copyOf¶

Gets the copyOf of this ProjectContainerOutput.

Returns: The copyOf of this ProjectContainerOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this ProjectContainerOutput.

Returns: The originalCopyOf of this ProjectContainerOutput.
Return type: char

stats¶

Gets the stats of this ProjectContainerOutput.

Returns: The stats of this ProjectContainerOutput.
Return type: ProjectStats

containerType¶

Gets the containerType of this ProjectContainerOutput.

Returns: The containerType of this ProjectContainerOutput.
Return type: AllOfProjectContainerOutputContainerType

ProjectCopyFilter¶

class ProjectCopyFilter¶

excludeAnalysis¶

Gets the excludeAnalysis of this ProjectCopyFilter.

Returns: The excludeAnalysis of this ProjectCopyFilter.
Return type: logical

excludeNotes¶

Gets the excludeNotes of this ProjectCopyFilter.

Returns: The excludeNotes of this ProjectCopyFilter.
Return type: logical

excludeTags¶

Gets the excludeTags of this ProjectCopyFilter.

Returns: The excludeTags of this ProjectCopyFilter.
Return type: logical

includeRules¶

Gets the includeRules of this ProjectCopyFilter.

Returns: The includeRules of this ProjectCopyFilter.
Return type: vector[char]

excludeRules¶

Gets the excludeRules of this ProjectCopyFilter.

Returns: The excludeRules of this ProjectCopyFilter.
Return type: vector[char]

ProjectCopyInput¶

class ProjectCopyInput¶

groupId¶

Gets the groupId of this ProjectCopyInput.

Returns: The groupId of this ProjectCopyInput.
Return type: char

projectLabel¶

Gets the projectLabel of this ProjectCopyInput.

Returns: The projectLabel of this ProjectCopyInput.
Return type: char

filter¶

Gets the filter of this ProjectCopyInput.

Returns: The filter of this ProjectCopyInput.
Return type: ProjectCopyFilter

ProjectCopyOutput¶

class ProjectCopyOutput¶

taskId¶

Gets the taskId of this ProjectCopyOutput.

Returns: The taskId of this ProjectCopyOutput.
Return type: char

snapshotId¶

Gets the snapshotId of this ProjectCopyOutput.

Returns: The snapshotId of this ProjectCopyOutput.
Return type: char

projectId¶

Gets the projectId of this ProjectCopyOutput.

Returns: The projectId of this ProjectCopyOutput.
Return type: char

ProjectCopyStatus¶

An enumeration.

class ProjectCopyStatus¶: An enumeration.

ProjectCounters¶

class ProjectCounters¶

subjects¶

Gets the subjects of this ProjectCounters.

Returns: The subjects of this ProjectCounters.
Return type: integer

sessions¶

Gets the sessions of this ProjectCounters.

Returns: The sessions of this ProjectCounters.
Return type: integer

acquisitions¶

Gets the acquisitions of this ProjectCounters.

Returns: The acquisitions of this ProjectCounters.
Return type: integer

files¶

Gets the files of this ProjectCounters.

Returns: The files of this ProjectCounters.
Return type: integer

jobs¶

Gets the jobs of this ProjectCounters.

Returns: The jobs of this ProjectCounters.
Return type: integer

analyses¶

Gets the analyses of this ProjectCounters.

Returns: The analyses of this ProjectCounters.
Return type: integer

acquisitionFiles¶

Gets the acquisitionFiles of this ProjectCounters.

Returns: The acquisitionFiles of this ProjectCounters.
Return type: integer

compliantSessions¶

Gets the compliantSessions of this ProjectCounters.

Returns: The compliantSessions of this ProjectCounters.
Return type: integer

ProjectHierarchyInput¶

class ProjectHierarchyInput¶

origin¶

Gets the origin of this ProjectHierarchyInput.

Returns: The origin of this ProjectHierarchyInput.
Return type: Origin

subject¶

Gets the subject of this ProjectHierarchyInput.

Returns: The subject of this ProjectHierarchyInput.
Return type: SubjectUpsertInput

session¶

Gets the session of this ProjectHierarchyInput.

Returns: The session of this ProjectHierarchyInput.
Return type: SessionUpsertInput

acquisition¶

Gets the acquisition of this ProjectHierarchyInput.

Returns: The acquisition of this ProjectHierarchyInput.
Return type: AcquisitionUpsertInput

ProjectHierarchyOutput¶

class ProjectHierarchyOutput¶

subject¶

Gets the subject of this ProjectHierarchyOutput.

Returns: The subject of this ProjectHierarchyOutput.
Return type: SubjectUpsertOutput

session¶

Gets the session of this ProjectHierarchyOutput.

Returns: The session of this ProjectHierarchyOutput.
Return type: SessionUpsertOutput

acquisition¶

Gets the acquisition of this ProjectHierarchyOutput.

Returns: The acquisition of this ProjectHierarchyOutput.
Return type: AcquisitionUpsertOutput

ProjectHierarchyUpsertInput¶

class ProjectHierarchyUpsertInput¶

ProjectHierarchyUpsertOutput¶

class ProjectHierarchyUpsertOutput¶

ProjectInput¶

class ProjectInput¶

label¶

Gets the label of this ProjectInput.

Returns: The label of this ProjectInput.
Return type: char

description¶

Gets the description of this ProjectInput.

Returns: The description of this ProjectInput.
Return type: char

group¶

Gets the group of this ProjectInput.

Returns: The group of this ProjectInput.
Return type: char

editions¶

Gets the editions of this ProjectInput.

Returns: The editions of this ProjectInput.
Return type: Edition

providers¶

Gets the providers of this ProjectInput.

Returns: The providers of this ProjectInput.
Return type: Providers

ldapSync¶

Gets the ldapSync of this ProjectInput.

Returns: The ldapSync of this ProjectInput.
Return type: LdapSyncConfig

permissions¶

Gets the permissions of this ProjectInput.

Returns: The permissions of this ProjectInput.
Return type: RolePermission

copyable¶

Gets the copyable of this ProjectInput.

Returns: The copyable of this ProjectInput.
Return type: logical

info¶

Gets the info of this ProjectInput.

Returns: The info of this ProjectInput.
Return type: containers.Map

ProjectInstitution¶

class ProjectInstitution¶

name¶

Gets the name of this ProjectInstitution.

Returns: The name of this ProjectInstitution.
Return type: char

url¶

Gets the url of this ProjectInstitution.

Returns: The url of this ProjectInstitution.
Return type: char

ProjectListOutput¶

class ProjectListOutput¶

id¶

Gets the id of this ProjectListOutput.

Returns: The id of this ProjectListOutput.
Return type: char

label¶

Gets the label of this ProjectListOutput.

Returns: The label of this ProjectListOutput.
Return type: char

description¶

Gets the description of this ProjectListOutput.

Returns: The description of this ProjectListOutput.
Return type: char

group¶

Gets the group of this ProjectListOutput.

Returns: The group of this ProjectListOutput.
Return type: char

parents¶

Gets the parents of this ProjectListOutput.

Returns: The parents of this ProjectListOutput.
Return type: ProjectParents

editions¶

Gets the editions of this ProjectListOutput.

Returns: The editions of this ProjectListOutput.
Return type: Edition

providers¶

Gets the providers of this ProjectListOutput.

Returns: The providers of this ProjectListOutput.
Return type: Providers

ldapSync¶

Gets the ldapSync of this ProjectListOutput.

Returns: The ldapSync of this ProjectListOutput.
Return type: LdapSyncStatus

permissions¶

Gets the permissions of this ProjectListOutput.

Returns: The permissions of this ProjectListOutput.
Return type: RolePermission

files¶

Gets the files of this ProjectListOutput.

Returns: The files of this ProjectListOutput.
Return type: FileListOutput

info¶

Gets the info of this ProjectListOutput.

Returns: The info of this ProjectListOutput.
Return type: containers.Map

infoExists¶

Gets the infoExists of this ProjectListOutput.

Returns: The infoExists of this ProjectListOutput.
Return type: logical

notes¶

Gets the notes of this ProjectListOutput.

Returns: The notes of this ProjectListOutput.
Return type: Note

tags¶

Gets the tags of this ProjectListOutput.

Returns: The tags of this ProjectListOutput.
Return type: vector[char]

templates¶

Gets the templates of this ProjectListOutput.

Returns: The templates of this ProjectListOutput.
Return type: ProjectTemplate

joinOrigin¶

Gets the joinOrigin of this ProjectListOutput.

Returns: The joinOrigin of this ProjectListOutput.
Return type: JoinOrigins

analyses¶

Gets the analyses of this ProjectListOutput.

Returns: The analyses of this ProjectListOutput.
Return type: Object

locked¶

Gets the locked of this ProjectListOutput.

Returns: The locked of this ProjectListOutput.
Return type: Locked

copyable¶

Gets the copyable of this ProjectListOutput.

Returns: The copyable of this ProjectListOutput.
Return type: logical

copyStatus¶

Gets the copyStatus of this ProjectListOutput.

Returns: The copyStatus of this ProjectListOutput.
Return type: char

copyFailureReason¶

Gets the copyFailureReason of this ProjectListOutput.

Returns: The copyFailureReason of this ProjectListOutput.
Return type: char

copyOf¶

Gets the copyOf of this ProjectListOutput.

Returns: The copyOf of this ProjectListOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this ProjectListOutput.

Returns: The originalCopyOf of this ProjectListOutput.
Return type: char

stats¶

Gets the stats of this ProjectListOutput.

Returns: The stats of this ProjectListOutput.
Return type: ProjectStats

revision¶

Gets the revision of this ProjectListOutput.

Returns: The revision of this ProjectListOutput.
Return type: integer

modified¶

Gets the modified of this ProjectListOutput.

Returns: The modified of this ProjectListOutput.
Return type: datetime

created¶

Gets the created of this ProjectListOutput.

Returns: The created of this ProjectListOutput.
Return type: datetime

settings¶

Gets the settings of this ProjectListOutput.

Returns: The settings of this ProjectListOutput.
Return type: ProjectSettingsOutput

ProjectLockingReason¶

An enumeration.

class ProjectLockingReason¶: An enumeration.

ProjectModify¶

class ProjectModify¶

label¶

Gets the label of this ProjectModify.

Returns: The label of this ProjectModify.
Return type: char

group¶

Gets the group of this ProjectModify.

Returns: The group of this ProjectModify.
Return type: char

description¶

Gets the description of this ProjectModify.

Returns: The description of this ProjectModify.
Return type: char

editions¶

Gets the editions of this ProjectModify.

Returns: The editions of this ProjectModify.
Return type: Edition

providers¶

Gets the providers of this ProjectModify.

Returns: The providers of this ProjectModify.
Return type: Providers

ldapSync¶

Gets the ldapSync of this ProjectModify.

Returns: The ldapSync of this ProjectModify.
Return type: LdapSyncStatus

info¶

Gets the info of this ProjectModify.

Returns: The info of this ProjectModify.
Return type: containers.Map

copyable¶

Gets the copyable of this ProjectModify.

Returns: The copyable of this ProjectModify.
Return type: logical

copyStatus¶

Gets the copyStatus of this ProjectModify.

Returns: The copyStatus of this ProjectModify.
Return type: ProjectCopyStatus

copyFailureReason¶

Gets the copyFailureReason of this ProjectModify.

Returns: The copyFailureReason of this ProjectModify.
Return type: char

ProjectNode¶

class ProjectNode¶

id¶

Gets the id of this ProjectNode.

Returns: The id of this ProjectNode.
Return type: char

label¶

Gets the label of this ProjectNode.

Returns: The label of this ProjectNode.
Return type: char

description¶

Gets the description of this ProjectNode.

Returns: The description of this ProjectNode.
Return type: char

group¶

Gets the group of this ProjectNode.

Returns: The group of this ProjectNode.
Return type: char

parents¶

Gets the parents of this ProjectNode.

Returns: The parents of this ProjectNode.
Return type: ProjectParents

editions¶

Gets the editions of this ProjectNode.

Returns: The editions of this ProjectNode.
Return type: Edition

providers¶

Gets the providers of this ProjectNode.

Returns: The providers of this ProjectNode.
Return type: Providers

ldapSync¶

Gets the ldapSync of this ProjectNode.

Returns: The ldapSync of this ProjectNode.
Return type: LdapSyncStatus

permissions¶

Gets the permissions of this ProjectNode.

Returns: The permissions of this ProjectNode.
Return type: RolePermission

files¶

Gets the files of this ProjectNode.

Returns: The files of this ProjectNode.
Return type: FileOutput

info¶

Gets the info of this ProjectNode.

Returns: The info of this ProjectNode.
Return type: containers.Map

infoExists¶

Gets the infoExists of this ProjectNode.

Returns: The infoExists of this ProjectNode.
Return type: logical

notes¶

Gets the notes of this ProjectNode.

Returns: The notes of this ProjectNode.
Return type: Note

tags¶

Gets the tags of this ProjectNode.

Returns: The tags of this ProjectNode.
Return type: vector[char]

templates¶

Gets the templates of this ProjectNode.

Returns: The templates of this ProjectNode.
Return type: ProjectTemplate

joinOrigin¶

Gets the joinOrigin of this ProjectNode.

Returns: The joinOrigin of this ProjectNode.
Return type: JoinOrigins

analyses¶

Gets the analyses of this ProjectNode.

Returns: The analyses of this ProjectNode.
Return type: Object

settings¶

Gets the settings of this ProjectNode.

Returns: The settings of this ProjectNode.
Return type: ProjectSettingsOutput

locked¶

Gets the locked of this ProjectNode.

Returns: The locked of this ProjectNode.
Return type: Locked

revision¶

Gets the revision of this ProjectNode.

Returns: The revision of this ProjectNode.
Return type: integer

modified¶

Gets the modified of this ProjectNode.

Returns: The modified of this ProjectNode.
Return type: datetime

created¶

Gets the created of this ProjectNode.

Returns: The created of this ProjectNode.
Return type: datetime

copyable¶

Gets the copyable of this ProjectNode.

Returns: The copyable of this ProjectNode.
Return type: logical

copyStatus¶

Gets the copyStatus of this ProjectNode.

Returns: The copyStatus of this ProjectNode.
Return type: ProjectCopyStatus

copyFailureReason¶

Gets the copyFailureReason of this ProjectNode.

Returns: The copyFailureReason of this ProjectNode.
Return type: char

copyOf¶

Gets the copyOf of this ProjectNode.

Returns: The copyOf of this ProjectNode.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this ProjectNode.

Returns: The originalCopyOf of this ProjectNode.
Return type: char

stats¶

Gets the stats of this ProjectNode.

Returns: The stats of this ProjectNode.
Return type: ProjectStats

ProjectOutput¶

class ProjectOutput¶

id¶

Gets the id of this ProjectOutput.

Returns: The id of this ProjectOutput.
Return type: char

label¶

Gets the label of this ProjectOutput.

Returns: The label of this ProjectOutput.
Return type: char

description¶

Gets the description of this ProjectOutput.

Returns: The description of this ProjectOutput.
Return type: char

group¶

Gets the group of this ProjectOutput.

Returns: The group of this ProjectOutput.
Return type: char

parents¶

Gets the parents of this ProjectOutput.

Returns: The parents of this ProjectOutput.
Return type: ProjectParents

editions¶

Gets the editions of this ProjectOutput.

Returns: The editions of this ProjectOutput.
Return type: Edition

providers¶

Gets the providers of this ProjectOutput.

Returns: The providers of this ProjectOutput.
Return type: Providers

ldapSync¶

Gets the ldapSync of this ProjectOutput.

Returns: The ldapSync of this ProjectOutput.
Return type: LdapSyncStatus

permissions¶

Gets the permissions of this ProjectOutput.

Returns: The permissions of this ProjectOutput.
Return type: RolePermission

files¶

Gets the files of this ProjectOutput.

Returns: The files of this ProjectOutput.
Return type: FileOutput

info¶

Gets the info of this ProjectOutput.

Returns: The info of this ProjectOutput.
Return type: containers.Map

infoExists¶

Gets the infoExists of this ProjectOutput.

Returns: The infoExists of this ProjectOutput.
Return type: logical

notes¶

Gets the notes of this ProjectOutput.

Returns: The notes of this ProjectOutput.
Return type: Note

tags¶

Gets the tags of this ProjectOutput.

Returns: The tags of this ProjectOutput.
Return type: vector[char]

templates¶

Gets the templates of this ProjectOutput.

Returns: The templates of this ProjectOutput.
Return type: ProjectTemplate

joinOrigin¶

Gets the joinOrigin of this ProjectOutput.

Returns: The joinOrigin of this ProjectOutput.
Return type: JoinOrigins

analyses¶

Gets the analyses of this ProjectOutput.

Returns: The analyses of this ProjectOutput.
Return type: Object

settings¶

Gets the settings of this ProjectOutput.

Returns: The settings of this ProjectOutput.
Return type: ProjectSettingsOutput

locked¶

Gets the locked of this ProjectOutput.

Returns: The locked of this ProjectOutput.
Return type: Locked

revision¶

Gets the revision of this ProjectOutput.

Returns: The revision of this ProjectOutput.
Return type: integer

modified¶

Gets the modified of this ProjectOutput.

Returns: The modified of this ProjectOutput.
Return type: datetime

created¶

Gets the created of this ProjectOutput.

Returns: The created of this ProjectOutput.
Return type: datetime

copyable¶

Gets the copyable of this ProjectOutput.

Returns: The copyable of this ProjectOutput.
Return type: logical

copyStatus¶

Gets the copyStatus of this ProjectOutput.

Returns: The copyStatus of this ProjectOutput.
Return type: ProjectCopyStatus

copyFailureReason¶

Gets the copyFailureReason of this ProjectOutput.

Returns: The copyFailureReason of this ProjectOutput.
Return type: char

copyOf¶

Gets the copyOf of this ProjectOutput.

Returns: The copyOf of this ProjectOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this ProjectOutput.

Returns: The originalCopyOf of this ProjectOutput.
Return type: char

stats¶

Gets the stats of this ProjectOutput.

Returns: The stats of this ProjectOutput.
Return type: ProjectStats

ProjectParents¶

class ProjectParents¶

group¶

Gets the group of this ProjectParents.

Returns: The group of this ProjectParents.
Return type: char

ProjectReport¶

class ProjectReport¶

name¶

Application-specific label

Returns: The name of this ProjectReport.
Return type: char

groupName¶

Gets the groupName of this ProjectReport.

Returns: The groupName of this ProjectReport.
Return type: char

admins¶

Gets the admins of this ProjectReport.

Returns: The admins of this ProjectReport.
Return type: vector[containers.Map]

sessionCount¶

Gets the sessionCount of this ProjectReport.

Returns: The sessionCount of this ProjectReport.
Return type: integer

subjectsCount¶

Gets the subjectsCount of this ProjectReport.

Returns: The subjectsCount of this ProjectReport.
Return type: integer

femaleCount¶

Gets the femaleCount of this ProjectReport.

Returns: The femaleCount of this ProjectReport.
Return type: integer

maleCount¶

Gets the maleCount of this ProjectReport.

Returns: The maleCount of this ProjectReport.
Return type: integer

otherCount¶

Gets the otherCount of this ProjectReport.

Returns: The otherCount of this ProjectReport.
Return type: integer

demographicsGrid¶

Gets the demographicsGrid of this ProjectReport.

Returns: The demographicsGrid of this ProjectReport.
Return type: containers.Map

demographicsTotal¶

Gets the demographicsTotal of this ProjectReport.

Returns: The demographicsTotal of this ProjectReport.
Return type: integer

over18Count¶

Gets the over18Count of this ProjectReport.

Returns: The over18Count of this ProjectReport.
Return type: integer

under18Count¶

Gets the under18Count of this ProjectReport.

Returns: The under18Count of this ProjectReport.
Return type: integer

ProjectReportList¶

class ProjectReportList¶

projects¶

Gets the projects of this ProjectReportList.

Returns: The projects of this ProjectReportList.
Return type: ProjectReport

ProjectSessionUpsertInput¶

class ProjectSessionUpsertInput¶

ProjectSessionUpsertOutput¶

class ProjectSessionUpsertOutput¶

ProjectSettingsInput¶

class ProjectSettingsInput¶

viewerApps¶

Gets the viewerApps of this ProjectSettingsInput.

Returns: The viewerApps of this ProjectSettingsInput.
Return type: ViewerApp

deidProfile¶

Gets the deidProfile of this ProjectSettingsInput.

Returns: The deidProfile of this ProjectSettingsInput.
Return type: AnyOfProjectSettingsInputDeidProfile

forms¶

Gets the forms of this ProjectSettingsInput.

Returns: The forms of this ProjectSettingsInput.
Return type: containers.Map[String, vector[FormDefinition]]

externalRoutingId¶

Gets the externalRoutingId of this ProjectSettingsInput.

Returns: The externalRoutingId of this ProjectSettingsInput.
Return type: char

sharing¶

Gets the sharing of this ProjectSettingsInput.

Returns: The sharing of this ProjectSettingsInput.
Return type: ProjectSettingsSharingInput

ProjectSettingsOutput¶

class ProjectSettingsOutput¶

viewerApps¶

Gets the viewerApps of this ProjectSettingsOutput.

Returns: The viewerApps of this ProjectSettingsOutput.
Return type: ViewerApp

deidProfile¶

Gets the deidProfile of this ProjectSettingsOutput.

Returns: The deidProfile of this ProjectSettingsOutput.
Return type: containers.Map

forms¶

Gets the forms of this ProjectSettingsOutput.

Returns: The forms of this ProjectSettingsOutput.
Return type: containers.Map[String, vector[FormDefinition]]

externalRoutingId¶

Gets the externalRoutingId of this ProjectSettingsOutput.

Returns: The externalRoutingId of this ProjectSettingsOutput.
Return type: char

sharing¶

Gets the sharing of this ProjectSettingsOutput.

Returns: The sharing of this ProjectSettingsOutput.
Return type: ProjectSettingsSharing

ProjectSettingsSharing¶

class ProjectSettingsSharing¶

shareLevel¶

Gets the shareLevel of this ProjectSettingsSharing.

Returns: The shareLevel of this ProjectSettingsSharing.
Return type: ProjectShareLevel

projectInstitutions¶

Gets the projectInstitutions of this ProjectSettingsSharing.

Returns: The projectInstitutions of this ProjectSettingsSharing.
Return type: ProjectInstitution

projectContacts¶

Gets the projectContacts of this ProjectSettingsSharing.

Returns: The projectContacts of this ProjectSettingsSharing.
Return type: ProjectContact

summary¶

Gets the summary of this ProjectSettingsSharing.

Returns: The summary of this ProjectSettingsSharing.
Return type: char

therapeuticAreas¶

Gets the therapeuticAreas of this ProjectSettingsSharing.

Returns: The therapeuticAreas of this ProjectSettingsSharing.
Return type: TherapeuticArea

bodyRegions¶

Gets the bodyRegions of this ProjectSettingsSharing.

Returns: The bodyRegions of this ProjectSettingsSharing.
Return type: BodyRegion

organSystems¶

Gets the organSystems of this ProjectSettingsSharing.

Returns: The organSystems of this ProjectSettingsSharing.
Return type: OrganSystem

ProjectSettingsSharingInput¶

class ProjectSettingsSharingInput¶

shareLevel¶

Gets the shareLevel of this ProjectSettingsSharingInput.

Returns: The shareLevel of this ProjectSettingsSharingInput.
Return type: ProjectShareLevel

projectInstitutions¶

Gets the projectInstitutions of this ProjectSettingsSharingInput.

Returns: The projectInstitutions of this ProjectSettingsSharingInput.
Return type: ProjectInstitution

projectContacts¶

Gets the projectContacts of this ProjectSettingsSharingInput.

Returns: The projectContacts of this ProjectSettingsSharingInput.
Return type: ProjectContact

summary¶

Gets the summary of this ProjectSettingsSharingInput.

Returns: The summary of this ProjectSettingsSharingInput.
Return type: char

therapeuticAreas¶

Gets the therapeuticAreas of this ProjectSettingsSharingInput.

Returns: The therapeuticAreas of this ProjectSettingsSharingInput.
Return type: TherapeuticArea

bodyRegions¶

Gets the bodyRegions of this ProjectSettingsSharingInput.

Returns: The bodyRegions of this ProjectSettingsSharingInput.
Return type: BodyRegion

organSystems¶

Gets the organSystems of this ProjectSettingsSharingInput.

Returns: The organSystems of this ProjectSettingsSharingInput.
Return type: OrganSystem

ProjectShareLevel¶

An enumeration.

class ProjectShareLevel¶: An enumeration.

ProjectSharingSettingsProjectContact¶

class ProjectSharingSettingsProjectContact¶

ProjectSharingSettingsProjectInstitution¶

class ProjectSharingSettingsProjectInstitution¶

ProjectSharingSettingsProjectSettingsInput¶

class ProjectSharingSettingsProjectSettingsInput¶

ProjectSharingSettingsProjectSettingsOutput¶

class ProjectSharingSettingsProjectSettingsOutput¶

ProjectSharingSettingsProjectSettingsSharing¶

class ProjectSharingSettingsProjectSettingsSharing¶

ProjectSharingSettingsProjectSettingsSharingInput¶

class ProjectSharingSettingsProjectSettingsSharingInput¶

ProjectStats¶

class ProjectStats¶

numberOf¶

Gets the numberOf of this ProjectStats.

Returns: The numberOf of this ProjectStats.
Return type: ProjectCounters

ageGroups¶

Gets the ageGroups of this ProjectStats.

Returns: The ageGroups of this ProjectStats.
Return type: vector[char]

measurements¶

Gets the measurements of this ProjectStats.

Returns: The measurements of this ProjectStats.
Return type: vector[char]

modalities¶

Gets the modalities of this ProjectStats.

Returns: The modalities of this ProjectStats.
Return type: vector[char]

fileTypes¶

Gets the fileTypes of this ProjectStats.

Returns: The fileTypes of this ProjectStats.
Return type: vector[char]

ProjectSubjectUpsertInput¶

class ProjectSubjectUpsertInput¶

ProjectSubjectUpsertOutput¶

class ProjectSubjectUpsertOutput¶

ProjectTemplate¶

class ProjectTemplate¶

session¶

Gets the session of this ProjectTemplate.

Returns: The session of this ProjectTemplate.
Return type: SessionTemplateOptions

acquisitions¶

Gets the acquisitions of this ProjectTemplate.

Returns: The acquisitions of this ProjectTemplate.
Return type: AcquisitionTemplateOptions

ProjectTemplateInput¶

class ProjectTemplateInput¶

session¶

Gets the session of this ProjectTemplateInput.

Returns: The session of this ProjectTemplateInput.
Return type: SessionTemplateOptions

acquisitions¶

Gets the acquisitions of this ProjectTemplateInput.

Returns: The acquisitions of this ProjectTemplateInput.
Return type: AcquisitionTemplateOptions

ProjectTemplateListInput¶

class ProjectTemplateListInput¶

templates¶

Gets the templates of this ProjectTemplateListInput.

Returns: The templates of this ProjectTemplateListInput.
Return type: ProjectTemplateInput

ProjectTemplateSessionTemplate¶

class ProjectTemplateSessionTemplate¶

Provider¶

Instantiable provider class that contains a full detail to utilize a provider

class Provider¶

Instantiable provider class that contains a full detail to utilize a provider

id¶

Gets the id of this Provider.

Returns: The id of this Provider.
Return type: char

label¶

Gets the label of this Provider.

Returns: The label of this Provider.
Return type: char

providerClass¶

Gets the providerClass of this Provider.

Returns: The providerClass of this Provider.
Return type: ProviderClass

providerType¶

Gets the providerType of this Provider.

Returns: The providerType of this Provider.
Return type: ProviderType

creds¶

Gets the creds of this Provider.

Returns: The creds of this Provider.
Return type: AnyOfProviderCreds

origin¶

Gets the origin of this Provider.

Returns: The origin of this Provider.
Return type: Origin

config¶

Gets the config of this Provider.

Returns: The config of this Provider.
Return type: AnyOfProviderConfig

created¶

Gets the created of this Provider.

Returns: The created of this Provider.
Return type: datetime

modified¶

Gets the modified of this Provider.

Returns: The modified of this Provider.
Return type: datetime

accessType¶

Gets the accessType of this Provider.

Returns: The accessType of this Provider.
Return type: ProviderAccessType

ProviderAccessType¶

An enumeration.

class ProviderAccessType¶: An enumeration.

ProviderClass¶

An enumeration.

class ProviderClass¶: An enumeration.

ProviderInput¶

class ProviderInput¶

ProviderLinks¶

Links to providers for containers

class ProviderLinks¶

Links to providers for containers

compute¶

Unique database ID

Returns: The compute of this ProviderLinks.
Return type: char

storage¶

Unique database ID

Returns: The storage of this ProviderLinks.
Return type: char

accessLog¶

Unique database ID

Returns: The accessLog of this ProviderLinks.
Return type: char

changeLog¶

Unique database ID

Returns: The changeLog of this ProviderLinks.
Return type: char

jobLogs¶

Unique database ID

Returns: The jobLogs of this ProviderLinks.
Return type: char

ProviderType¶

Represents all types that can be instantiated. Not all combinations are valid as addressed in service layer

class ProviderType¶: Represents all types that can be instantiated. Not all combinations are valid as addressed in service layer

Providers¶

Lists the IDs of the various providers used by site settings

class Providers¶

Lists the IDs of the various providers used by site settings

storage¶

Gets the storage of this Providers.

Returns: The storage of this Providers.
Return type: char

compute¶

Gets the compute of this Providers.

Returns: The compute of this Providers.
Return type: char

changeLog¶

Gets the changeLog of this Providers.

Returns: The changeLog of this Providers.
Return type: char

jobLogs¶

Gets the jobLogs of this Providers.

Returns: The jobLogs of this Providers.
Return type: char

accessLog¶

Gets the accessLog of this Providers.

Returns: The accessLog of this Providers.
Return type: char

ReportAccessLogContext¶

The context for a logged request, describing the members of the accessed hierarchy

class ReportAccessLogContext¶

The context for a logged request, describing the members of the accessed hierarchy

group¶

Gets the group of this ReportAccessLogContext.

Returns: The group of this ReportAccessLogContext.
Return type: ReportAccessLogContextEntry

project¶

Gets the project of this ReportAccessLogContext.

Returns: The project of this ReportAccessLogContext.
Return type: ReportAccessLogContextEntry

subject¶

Gets the subject of this ReportAccessLogContext.

Returns: The subject of this ReportAccessLogContext.
Return type: ReportAccessLogContextEntry

session¶

Gets the session of this ReportAccessLogContext.

Returns: The session of this ReportAccessLogContext.
Return type: ReportAccessLogContextEntry

acquisition¶

Gets the acquisition of this ReportAccessLogContext.

Returns: The acquisition of this ReportAccessLogContext.
Return type: ReportAccessLogContextEntry

file¶

Gets the file of this ReportAccessLogContext.

Returns: The file of this ReportAccessLogContext.
Return type: ReportAccessLogContextFileEntry

ReportAccessLogContextEntry¶

class ReportAccessLogContextEntry¶

id¶

Unique database ID

Returns: The id of this ReportAccessLogContextEntry.
Return type: char

label¶

Application-specific label

Returns: The label of this ReportAccessLogContextEntry.
Return type: char

ReportAccessLogContextFileEntry¶

class ReportAccessLogContextFileEntry¶

name¶

The name of the file on disk

Returns: The name of this ReportAccessLogContextFileEntry.
Return type: char

ReportAccessLogEntry¶

A single entry in the access log report

class ReportAccessLogEntry¶

A single entry in the access log report

id¶

The access log entry id

Returns: The id of this ReportAccessLogEntry.
Return type: char

accessType¶

A named field used in the access log report

Returns: The accessType of this ReportAccessLogEntry.
Return type: char

context¶

Gets the context of this ReportAccessLogEntry.

Returns: The context of this ReportAccessLogEntry.
Return type: ReportAccessLogContext

origin¶

Gets the origin of this ReportAccessLogEntry.

Returns: The origin of this ReportAccessLogEntry.
Return type: ReportAccessLogOrigin

requestMethod¶

The http request method (e.g. GET, PUT, POST, DELETE)

Returns: The requestMethod of this ReportAccessLogEntry.
Return type: char

requestPath¶

The HTTP request path (e.g. /api/projects)

Returns: The requestPath of this ReportAccessLogEntry.
Return type: char

timestamp¶

Gets the timestamp of this ReportAccessLogEntry.

Returns: The timestamp of this ReportAccessLogEntry.
Return type: datetime

ReportAccessLogOrigin¶

The origin of a logged request (e.g. a user id)

class ReportAccessLogOrigin¶

The origin of a logged request (e.g. a user id)

type¶

The origin type (e.g. user)

Returns: The type of this ReportAccessLogOrigin.
Return type: char

id¶

The origin id (e.g. user id)

Returns: The id of this ReportAccessLogOrigin.
Return type: char

ReportDailyUsageEntry¶

An entry in the usage report, describing storage and gear usage by group and project

class ReportDailyUsageEntry¶

An entry in the usage report, describing storage and gear usage by group and project

year¶

The year that this record represents

Returns: The year of this ReportDailyUsageEntry.
Return type: integer

month¶

The month that this record represents

Returns: The month of this ReportDailyUsageEntry.
Return type: integer

day¶

The day that this record represents

Returns: The day of this ReportDailyUsageEntry.
Return type: integer

group¶

The group label

Returns: The group of this ReportDailyUsageEntry.
Return type: char

project¶

Unique database ID

Returns: The project of this ReportDailyUsageEntry.
Return type: char

projectLabel¶

Application-specific label

Returns: The projectLabel of this ReportDailyUsageEntry.
Return type: char

sessionCount¶

The number of sessions that existed at the last collection time

Returns: The sessionCount of this ReportDailyUsageEntry.
Return type: integer

centerJobCount¶

The number of center-designated gear jobs that completed during the time frame (billable to the center)

Returns: The centerJobCount of this ReportDailyUsageEntry.
Return type: integer

groupJobCount¶

The number of non-center-designated (lab) gear jobs that completed during the time frame (billable to the group)

Returns: The groupJobCount of this ReportDailyUsageEntry.
Return type: integer

centerComputeMs¶

The compute time of center-designated gear jobs completed during the time frame (billable to the center)

Returns: The centerComputeMs of this ReportDailyUsageEntry.
Return type: integer

groupComputeMs¶

The compute time of non-center-designated (lab) gear jobs completed during the time frame (billable to the group)

Returns: The groupComputeMs of this ReportDailyUsageEntry.
Return type: integer

centerStorageBytes¶

The total storage used by files originating from devices or center-designated gears on this day (billable to the center)

Returns: The centerStorageBytes of this ReportDailyUsageEntry.
Return type: integer

groupStorageBytes¶

The total storage used by files not originating from devices or non-center-designated (lab) gears on this day (billable to the group)

Returns: The groupStorageBytes of this ReportDailyUsageEntry.
Return type: integer

ReportDemographicsGrid¶

class ReportDemographicsGrid¶

ReportGroupReport¶

class ReportGroupReport¶

projectCount¶

Gets the projectCount of this ReportGroupReport.

Returns: The projectCount of this ReportGroupReport.
Return type: integer

label¶

The group label

Returns: The label of this ReportGroupReport.
Return type: char

sessionCount¶

Gets the sessionCount of this ReportGroupReport.

Returns: The sessionCount of this ReportGroupReport.
Return type: integer

ReportLegacyUsageEntry¶

An entry in the usage report, describing storage and gear usage

class ReportLegacyUsageEntry¶

An entry in the usage report, describing storage and gear usage

fileMbs¶

File storage usage, in megabytes

Returns: The fileMbs of this ReportLegacyUsageEntry.
Return type: float

gearExecutionCount¶

The number of gears executed

Returns: The gearExecutionCount of this ReportLegacyUsageEntry.
Return type: integer

sessionCount¶

The number of sessions created

Returns: The sessionCount of this ReportLegacyUsageEntry.
Return type: integer

year¶

The year portion of the entry date

Returns: The year of this ReportLegacyUsageEntry.
Return type: char

month¶

The month portion of the entry date

Returns: The month of this ReportLegacyUsageEntry.
Return type: char

project¶

Gets the project of this ReportLegacyUsageEntry.

Returns: The project of this ReportLegacyUsageEntry.
Return type: ReportLegacyUsageProjectEntry

ReportLegacyUsageProjectEntry¶

The project that this entry reports on

class ReportLegacyUsageProjectEntry¶

The project that this entry reports on

id¶

Unique database ID

Returns: The id of this ReportLegacyUsageProjectEntry.
Return type: char

label¶

Application-specific label

Returns: The label of this ReportLegacyUsageProjectEntry.
Return type: char

ReportProject¶

class ReportProject¶

ReportSite¶

class ReportSite¶

groupCount¶

Gets the groupCount of this ReportSite.

Returns: The groupCount of this ReportSite.
Return type: integer

groups¶

Gets the groups of this ReportSite.

Returns: The groups of this ReportSite.
Return type: ReportGroupReport

ReportTimePeriod¶

Represents a time-period where report data is available

class ReportTimePeriod¶

Represents a time-period where report data is available

year¶

The year that this report row represents

Returns: The year of this ReportTimePeriod.
Return type: integer

month¶

The month that this report row represents

Returns: The month of this ReportTimePeriod.
Return type: integer

day¶

The day that this report row represents

Returns: The day of this ReportTimePeriod.
Return type: integer

ReportUsageEntry¶

An entry in the usage report, describing monthly storage and gear usage by group and project

class ReportUsageEntry¶

An entry in the usage report, describing monthly storage and gear usage by group and project

group¶

The group label

Returns: The group of this ReportUsageEntry.
Return type: char

project¶

The project ID

Returns: The project of this ReportUsageEntry.
Return type: char

projectLabel¶

The project label

Returns: The projectLabel of this ReportUsageEntry.
Return type: char

sessionCount¶

The number of sessions in the project on the last recorded day of the month

Returns: The sessionCount of this ReportUsageEntry.
Return type: integer

centerJobCount¶

The number of center-designated gear jobs run in this project during the month (billable to the center)

Returns: The centerJobCount of this ReportUsageEntry.
Return type: integer

groupJobCount¶

The number of non-center-designated (lab) gear jobs run in this project during the month (billable to the group)

Returns: The groupJobCount of this ReportUsageEntry.
Return type: integer

totalJobCount¶

The total number of gear jobs run in this project during the month

Returns: The totalJobCount of this ReportUsageEntry.
Return type: integer

centerComputeMs¶

The compute time (in ms) used by center-designated jobs in this project during the month (billable to the center)

Returns: The centerComputeMs of this ReportUsageEntry.
Return type: integer

groupComputeMs¶

The compute time (in ms) used by non-center-designated (lab) gear jobs in this project during the month (billable to the group)

Returns: The groupComputeMs of this ReportUsageEntry.
Return type: integer

totalComputeMs¶

The total compute time (in ms) used by gear jobs in this project during the month

Returns: The totalComputeMs of this ReportUsageEntry.
Return type: integer

centerStorageByteDay¶

The storage, in byte-days, used by files originating from devices or center-designated gears in this project during the month (billable to the center)

Returns: The centerStorageByteDay of this ReportUsageEntry.
Return type: integer

groupStorageByteDay¶

The storage, in byte-days, used by files not originating from devices or non-center-designated (lab) gears in this project during the month (billable to the group)

Returns: The groupStorageByteDay of this ReportUsageEntry.
Return type: integer

totalStorageByteDay¶

The total storage, in byte-days, used by files in this project during the month

Returns: The totalStorageByteDay of this ReportUsageEntry.
Return type: integer

days¶

Number of days captured in this entry (normally the number of days in the month, unless the project was created in that month or it is the current month)

Returns: The days of this ReportUsageEntry.
Return type: integer

ResolveInput¶

class ResolveInput¶

path¶

Gets the path of this ResolveInput.

Returns: The path of this ResolveInput.
Return type: vector[char]

ResolveOutput¶

class ResolveOutput¶

path¶

Gets the path of this ResolveOutput.

Returns: The path of this ResolveOutput.
Return type: ResolverNode

children¶

Gets the children of this ResolveOutput.

Returns: The children of this ResolveOutput.
Return type: ResolverNode

ResolverInput¶

class ResolverInput¶

ResolverNode¶

class ResolverNode¶

containerType¶

Gets the containerType of this ResolverNode.

Returns: The containerType of this ResolverNode.
Return type: char

ResolverOutput¶

class ResolverOutput¶

RoleInput¶

class RoleInput¶

label¶

Gets the label of this RoleInput.

Returns: The label of this RoleInput.
Return type: char

actions¶

Gets the actions of this RoleInput.

Returns: The actions of this RoleInput.
Return type: Action

RoleOutput¶

class RoleOutput¶

id¶

Gets the id of this RoleOutput.

Returns: The id of this RoleOutput.
Return type: char

label¶

Gets the label of this RoleOutput.

Returns: The label of this RoleOutput.
Return type: char

defaultFlywheelRole¶

Gets the defaultFlywheelRole of this RoleOutput.

Returns: The defaultFlywheelRole of this RoleOutput.
Return type: DefaultFlywheelRole

actions¶

Gets the actions of this RoleOutput.

Returns: The actions of this RoleOutput.
Return type: Object

inUse¶

Gets the inUse of this RoleOutput.

Returns: The inUse of this RoleOutput.
Return type: logical

RolePermission¶

Model for a role permission Attributes: id: The id of the user role_ids: List of ids of the roles user has on the resource

class RolePermission¶

Model for a role permission Attributes: id: The id of the user role_ids: List of ids of the roles user has on the resource

id¶

Gets the id of this RolePermission.

Returns: The id of this RolePermission.
Return type: char

roleIds¶

Gets the roleIds of this RolePermission.

Returns: The roleIds of this RolePermission.
Return type: vector[char]

RolePermissionOutput¶

class RolePermissionOutput¶

id¶

Gets the id of this RolePermissionOutput.

Returns: The id of this RolePermissionOutput.
Return type: char

roleIds¶

Gets the roleIds of this RolePermissionOutput.

Returns: The roleIds of this RolePermissionOutput.
Return type: vector[char]

RolePermissionUpdate¶

class RolePermissionUpdate¶

roleIds¶

Gets the roleIds of this RolePermissionUpdate.

Returns: The roleIds of this RolePermissionUpdate.
Return type: vector[char]

RoleType¶

An enumeration.

class RoleType¶: An enumeration.

RoleUpdate¶

class RoleUpdate¶

label¶

Gets the label of this RoleUpdate.

Returns: The label of this RoleUpdate.
Return type: char

actions¶

Gets the actions of this RoleUpdate.

Returns: The actions of this RoleUpdate.
Return type: Action

RolesGroupRolePoolInput¶

class RolesGroupRolePoolInput¶

RolesRole¶

class RolesRole¶

id¶

Unique database ID

Returns: The id of this RolesRole.
Return type: char

label¶

Application-specific label

Returns: The label of this RolesRole.
Return type: char

defaultFlywheelRole¶

Gets the defaultFlywheelRole of this RolesRole.

Returns: The defaultFlywheelRole of this RolesRole.
Return type: char

actions¶

Gets the actions of this RolesRole.

Returns: The actions of this RolesRole.
Return type: vector[char]

inUse¶

Gets the inUse of this RolesRole.

Returns: The inUse of this RolesRole.
Return type: logical

RolesRoleAssignment¶

class RolesRoleAssignment¶

RolesRoleInput¶

class RolesRoleInput¶

label¶

Application-specific label

Returns: The label of this RolesRoleInput.
Return type: char

actions¶

Gets the actions of this RolesRoleInput.

Returns: The actions of this RolesRoleInput.
Return type: vector[char]

Rule¶

class Rule¶

projectId¶

Gets the projectId of this Rule.

Returns: The projectId of this Rule.
Return type: char

gearId¶

Gets the gearId of this Rule.

Returns: The gearId of this Rule.
Return type: char

name¶

Gets the name of this Rule.

Returns: The name of this Rule.
Return type: char

config¶

Gets the config of this Rule.

Returns: The config of this Rule.
Return type: containers.Map

fixedInputs¶

Gets the fixedInputs of this Rule.

Returns: The fixedInputs of this Rule.
Return type: JobInputsArrayItem

autoUpdate¶

Gets the autoUpdate of this Rule.

Returns: The autoUpdate of this Rule.
Return type: logical

any¶

Gets the any of this Rule.

Returns: The any of this Rule.
Return type: RuleAny

all¶

Gets the all of this Rule.

Returns: The all of this Rule.
Return type: RuleAny

not¶

Gets the not of this Rule.

Returns: The not of this Rule.
Return type: RuleAny

disabled¶

Gets the disabled of this Rule.

Returns: The disabled of this Rule.
Return type: logical

computeProviderId¶

Unique database ID

Returns: The computeProviderId of this Rule.
Return type: char

id¶

Gets the id of this Rule.

Returns: The id of this Rule.
Return type: char

RuleAny¶

class RuleAny¶

type¶

Gets the type of this RuleAny.

Returns: The type of this RuleAny.
Return type: char

value¶

Gets the value of this RuleAny.

Returns: The value of this RuleAny.
Return type: containers.Map

regex¶

Gets the regex of this RuleAny.

Returns: The regex of this RuleAny.
Return type: logical

S3CompatStorage¶

class S3CompatStorage¶

region¶

Gets the region of this S3CompatStorage.

Returns: The region of this S3CompatStorage.
Return type: char

bucket¶

Gets the bucket of this S3CompatStorage.

Returns: The bucket of this S3CompatStorage.
Return type: char

path¶

Gets the path of this S3CompatStorage.

Returns: The path of this S3CompatStorage.
Return type: char

endpointUrl¶

Gets the endpointUrl of this S3CompatStorage.

Returns: The endpointUrl of this S3CompatStorage.
Return type: char

verifyCerts¶

Gets the verifyCerts of this S3CompatStorage.

Returns: The verifyCerts of this S3CompatStorage.
Return type: logical

signedUrls¶

Gets the signedUrls of this S3CompatStorage.

Returns: The signedUrls of this S3CompatStorage.
Return type: logical

configType¶

Gets the configType of this S3CompatStorage.

Returns: The configType of this S3CompatStorage.
Return type: char

configClass¶

Gets the configClass of this S3CompatStorage.

Returns: The configClass of this S3CompatStorage.
Return type: char

SearchAcquisitionResponse¶

Fields for acquisition search response

class SearchAcquisitionResponse¶

Fields for acquisition search response

id¶

Unique database ID

Returns: The id of this SearchAcquisitionResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchAcquisitionResponse.
Return type: char

timestamp¶

Gets the timestamp of this SearchAcquisitionResponse.

Returns: The timestamp of this SearchAcquisitionResponse.
Return type: datetime

created¶

Creation time (automatically set)

Returns: The created of this SearchAcquisitionResponse.
Return type: datetime

SearchAnalysisResponse¶

Fields for acquisition search response

class SearchAnalysisResponse¶

Fields for acquisition search response

id¶

Unique database ID

Returns: The id of this SearchAnalysisResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchAnalysisResponse.
Return type: char

user¶

Database ID of a user

Returns: The user of this SearchAnalysisResponse.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this SearchAnalysisResponse.
Return type: datetime

SearchCollectionResponse¶

Fields for collection search response

class SearchCollectionResponse¶

Fields for collection search response

id¶

Unique database ID

Returns: The id of this SearchCollectionResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchCollectionResponse.
Return type: char

curator¶

Database ID of a user

Returns: The curator of this SearchCollectionResponse.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this SearchCollectionResponse.
Return type: datetime

SearchFileResponse¶

Fields for file search response

class SearchFileResponse¶

Fields for file search response

classification¶

Gets the classification of this SearchFileResponse.

Returns: The classification of this SearchFileResponse.
Return type: CommonClassification

created¶

Creation time (automatically set)

Returns: The created of this SearchFileResponse.
Return type: datetime

type¶

A descriptive file type (e.g. dicom, image, document, …)

Returns: The type of this SearchFileResponse.
Return type: char

name¶

The name of the file on disk

Returns: The name of this SearchFileResponse.
Return type: char

size¶

Size of the file, in bytes

Returns: The size of this SearchFileResponse.
Return type: integer

SearchGroupResponse¶

Fields for group search response

class SearchGroupResponse¶

Fields for group search response

id¶

Unique database ID

Returns: The id of this SearchGroupResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchGroupResponse.
Return type: char

SearchParentAnalysis¶

class SearchParentAnalysis¶

SearchParentProject¶

class SearchParentProject¶

SearchParentResponse¶

Fields for parent search response

class SearchParentResponse¶

Fields for parent search response

id¶

Unique database ID

Returns: The id of this SearchParentResponse.
Return type: char

type¶

The type of container (e.g. session)

Returns: The type of this SearchParentResponse.
Return type: char

SearchParentSession¶

class SearchParentSession¶

SearchParseError¶

class SearchParseError¶

line¶

The line number where the error occurred

Returns: The line of this SearchParseError.
Return type: integer

pos¶

The position where the error occurred

Returns: The pos of this SearchParseError.
Return type: integer

offset¶

The absolute offset in the input (from 0) where the error occurred

Returns: The offset of this SearchParseError.
Return type: integer

message¶

The error message

Returns: The message of this SearchParseError.
Return type: char

SearchProjectResponse¶

Fields for project search response

class SearchProjectResponse¶

Fields for project search response

id¶

Unique database ID

Returns: The id of this SearchProjectResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchProjectResponse.
Return type: char

SearchQuery¶

class SearchQuery¶

returnType¶

Sets the type of search results to return

Returns: The returnType of this SearchQuery.
Return type: AllOfSearchQueryReturnType

structuredQuery¶

Represents structured query language search

Returns: The structuredQuery of this SearchQuery.
Return type: char

searchString¶

Represents the plain text search query

Returns: The searchString of this SearchQuery.
Return type: char

allData¶

When set will include all data that the user does not have access to read

Returns: The allData of this SearchQuery.
Return type: logical

filters¶

See https://www.elastic.co/guide/en/elasticsearch/reference/current/term-level-queries.html

Returns: The filters of this SearchQuery.
Return type: vector[containers.Map]

sort¶

Gets the sort of this SearchQuery.

Returns: The sort of this SearchQuery.
Return type: Sort

size¶

Gets the size of this SearchQuery.

Returns: The size of this SearchQuery.
Return type: AnyOfSearchQuerySize

SearchQuerySuggestions¶

class SearchQuerySuggestions¶

from¶

The starting position for the auto-complete replacement

Returns: The from of this SearchQuerySuggestions.
Return type: integer

suggestions¶

The list of suggested replacements

Returns: The suggestions of this SearchQuerySuggestions.
Return type: SearchSuggestion

SearchResponse¶

Single search response entry

class SearchResponse¶

Single search response entry

returnType¶

Gets the returnType of this SearchResponse.

Returns: The returnType of this SearchResponse.
Return type: SearchReturnType

project¶

Gets the project of this SearchResponse.

Returns: The project of this SearchResponse.
Return type: SearchProjectResponse

group¶

Gets the group of this SearchResponse.

Returns: The group of this SearchResponse.
Return type: SearchGroupResponse

session¶

Gets the session of this SearchResponse.

Returns: The session of this SearchResponse.
Return type: SearchSessionResponse

acquisition¶

Gets the acquisition of this SearchResponse.

Returns: The acquisition of this SearchResponse.
Return type: SearchAcquisitionResponse

subject¶

Gets the subject of this SearchResponse.

Returns: The subject of this SearchResponse.
Return type: SearchSubjectResponse

file¶

Gets the file of this SearchResponse.

Returns: The file of this SearchResponse.
Return type: SearchFileResponse

collection¶

Gets the collection of this SearchResponse.

Returns: The collection of this SearchResponse.
Return type: SearchCollectionResponse

analysis¶

Gets the analysis of this SearchResponse.

Returns: The analysis of this SearchResponse.
Return type: SearchAnalysisResponse

parent¶

Gets the parent of this SearchResponse.

Returns: The parent of this SearchResponse.
Return type: SearchParentResponse

permissions¶

Gets the permissions of this SearchResponse.

Returns: The permissions of this SearchResponse.
Return type: RolesRoleAssignment

SearchReturnType¶

An enumeration.

class SearchReturnType¶: An enumeration.

SearchSessionResponse¶

Fields for session search response

class SearchSessionResponse¶

Fields for session search response

id¶

Unique database ID

Returns: The id of this SearchSessionResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchSessionResponse.
Return type: char

timestamp¶

Gets the timestamp of this SearchSessionResponse.

Returns: The timestamp of this SearchSessionResponse.
Return type: datetime

created¶

Creation time (automatically set)

Returns: The created of this SearchSessionResponse.
Return type: datetime

SearchStatus¶

class SearchStatus¶

status¶

Gets the status of this SearchStatus.

Returns: The status of this SearchStatus.
Return type: char

lastSeen¶

Last modification time (automatically updated)

Returns: The lastSeen of this SearchStatus.
Return type: datetime

SearchStructuredSearchQuery¶

class SearchStructuredSearchQuery¶

structuredQuery¶

Represents structured query language search

Returns: The structuredQuery of this SearchStructuredSearchQuery.
Return type: char

SearchSubjectResponse¶

Fields for subject search response

class SearchSubjectResponse¶

Fields for subject search response

code¶

A unique identifier for the subject

Returns: The code of this SearchSubjectResponse.
Return type: char

SearchSuggestion¶

class SearchSuggestion¶

display¶

The display value of the suggestion

Returns: The display of this SearchSuggestion.
Return type: char

value¶

The value to use for replacement

Returns: The value of this SearchSuggestion.
Return type: char

ServiceAET¶

Create new ServiceAET enabling DIMSE C-MOVE to it as a destination. Args: host (str): The DICOM service hostname or IP. port (int): The DICOM service port.

class ServiceAET¶

Create new ServiceAET enabling DIMSE C-MOVE to it as a destination. Args: host (str): The DICOM service hostname or IP. port (int): The DICOM service port.

id¶

Gets the id of this ServiceAET.

Returns: The id of this ServiceAET.
Return type: char

created¶

Gets the created of this ServiceAET.

Returns: The created of this ServiceAET.
Return type: datetime

aet¶

DICOM Application Entity Title

Returns: The aet of this ServiceAET.
Return type: char

creator¶

Database ID of a user

Returns: The creator of this ServiceAET.
Return type: char

host¶

DICOM service hostname or IP

Returns: The host of this ServiceAET.
Return type: char

port¶

DICOM service port number

Returns: The port of this ServiceAET.
Return type: integer

ServiceAETInput¶

class ServiceAETInput¶

aet¶

DICOM Application Entity Title

Returns: The aet of this ServiceAETInput.
Return type: char

created¶

Gets the created of this ServiceAETInput.

Returns: The created of this ServiceAETInput.
Return type: datetime

creator¶

Gets the creator of this ServiceAETInput.

Returns: The creator of this ServiceAETInput.
Return type: char

host¶

DICOM service hostname or IP

Returns: The host of this ServiceAETInput.
Return type: char

port¶

DICOM service port number

Returns: The port of this ServiceAETInput.
Return type: integer

Session¶

class Session¶

SessionContainerOutput¶

class SessionContainerOutput¶

id¶

Gets the id of this SessionContainerOutput.

Returns: The id of this SessionContainerOutput.
Return type: char

group¶

Gets the group of this SessionContainerOutput.

Returns: The group of this SessionContainerOutput.
Return type: char

project¶

Gets the project of this SessionContainerOutput.

Returns: The project of this SessionContainerOutput.
Return type: char

parents¶

Gets the parents of this SessionContainerOutput.

Returns: The parents of this SessionContainerOutput.
Return type: SessionParents

label¶

Gets the label of this SessionContainerOutput.

Returns: The label of this SessionContainerOutput.
Return type: char

info¶

Gets the info of this SessionContainerOutput.

Returns: The info of this SessionContainerOutput.
Return type: containers.Map

uid¶

Gets the uid of this SessionContainerOutput.

Returns: The uid of this SessionContainerOutput.
Return type: char

timestamp¶

Gets the timestamp of this SessionContainerOutput.

Returns: The timestamp of this SessionContainerOutput.
Return type: datetime

timezone¶

Gets the timezone of this SessionContainerOutput.

Returns: The timezone of this SessionContainerOutput.
Return type: char

tags¶

Gets the tags of this SessionContainerOutput.

Returns: The tags of this SessionContainerOutput.
Return type: vector[char]

notes¶

Gets the notes of this SessionContainerOutput.

Returns: The notes of this SessionContainerOutput.
Return type: Note

permissions¶

Gets the permissions of this SessionContainerOutput.

Returns: The permissions of this SessionContainerOutput.
Return type: RolePermission

subject¶

Gets the subject of this SessionContainerOutput.

Returns: The subject of this SessionContainerOutput.
Return type: SubjectOutput

age¶

Gets the age of this SessionContainerOutput.

Returns: The age of this SessionContainerOutput.
Return type: integer

weight¶

Gets the weight of this SessionContainerOutput.

Returns: The weight of this SessionContainerOutput.
Return type: float

operator¶

Gets the operator of this SessionContainerOutput.

Returns: The operator of this SessionContainerOutput.
Return type: char

files¶

Gets the files of this SessionContainerOutput.

Returns: The files of this SessionContainerOutput.
Return type: FileOutput

created¶

Gets the created of this SessionContainerOutput.

Returns: The created of this SessionContainerOutput.
Return type: datetime

modified¶

Gets the modified of this SessionContainerOutput.

Returns: The modified of this SessionContainerOutput.
Return type: datetime

revision¶

Gets the revision of this SessionContainerOutput.

Returns: The revision of this SessionContainerOutput.
Return type: integer

satisfiesTemplate¶

Gets the satisfiesTemplate of this SessionContainerOutput.

Returns: The satisfiesTemplate of this SessionContainerOutput.
Return type: logical

analyses¶

Gets the analyses of this SessionContainerOutput.

Returns: The analyses of this SessionContainerOutput.
Return type: Object

projectHasTemplate¶

Gets the projectHasTemplate of this SessionContainerOutput.

Returns: The projectHasTemplate of this SessionContainerOutput.
Return type: logical

joinOrigin¶

Gets the joinOrigin of this SessionContainerOutput.

Returns: The joinOrigin of this SessionContainerOutput.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this SessionContainerOutput.

Returns: The copyOf of this SessionContainerOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this SessionContainerOutput.

Returns: The originalCopyOf of this SessionContainerOutput.
Return type: char

containerType¶

Gets the containerType of this SessionContainerOutput.

Returns: The containerType of this SessionContainerOutput.
Return type: AllOfSessionContainerOutputContainerType

SessionEmbeddedSubject¶

Project is not required on embedded subjects but old schema allows it. In this case project is used from the session and the subject found based on lookup order of _id, master_code, code/label. This model is only used on Sessions so it belongs here only If project is provided then we use the identifer code/label for that project to determine the embedded subject

class SessionEmbeddedSubject¶

Project is not required on embedded subjects but old schema allows it. In this case project is used from the session and the subject found based on lookup order of _id, master_code, code/label. This model is only used on Sessions so it belongs here only If project is provided then we use the identifer code/label for that project to determine the embedded subject

project¶

Gets the project of this SessionEmbeddedSubject.

Returns: The project of this SessionEmbeddedSubject.
Return type: char

id¶

Gets the id of this SessionEmbeddedSubject.

Returns: The id of this SessionEmbeddedSubject.
Return type: char

masterCode¶

Gets the masterCode of this SessionEmbeddedSubject.

Returns: The masterCode of this SessionEmbeddedSubject.
Return type: char

code¶

Gets the code of this SessionEmbeddedSubject.

Returns: The code of this SessionEmbeddedSubject.
Return type: char

label¶

Gets the label of this SessionEmbeddedSubject.

Returns: The label of this SessionEmbeddedSubject.
Return type: char

age¶

Gets the age of this SessionEmbeddedSubject.

Returns: The age of this SessionEmbeddedSubject.
Return type: integer

SessionInput¶

class SessionInput¶

project¶

Gets the project of this SessionInput.

Returns: The project of this SessionInput.
Return type: char

label¶

Gets the label of this SessionInput.

Returns: The label of this SessionInput.
Return type: char

info¶

Gets the info of this SessionInput.

Returns: The info of this SessionInput.
Return type: containers.Map

uid¶

Gets the uid of this SessionInput.

Returns: The uid of this SessionInput.
Return type: char

timestamp¶

Gets the timestamp of this SessionInput.

Returns: The timestamp of this SessionInput.
Return type: datetime

timezone¶

Gets the timezone of this SessionInput.

Returns: The timezone of this SessionInput.
Return type: char

subject¶

Gets the subject of this SessionInput.

Returns: The subject of this SessionInput.
Return type: AnyOfSessionInputSubject

age¶

Gets the age of this SessionInput.

Returns: The age of this SessionInput.
Return type: integer

weight¶

Gets the weight of this SessionInput.

Returns: The weight of this SessionInput.
Return type: float

operator¶

Gets the operator of this SessionInput.

Returns: The operator of this SessionInput.
Return type: char

projectHasTemplate¶

Gets the projectHasTemplate of this SessionInput.

Returns: The projectHasTemplate of this SessionInput.
Return type: logical

SessionListOutput¶

class SessionListOutput¶

id¶

Gets the id of this SessionListOutput.

Returns: The id of this SessionListOutput.
Return type: char

group¶

Gets the group of this SessionListOutput.

Returns: The group of this SessionListOutput.
Return type: char

project¶

Gets the project of this SessionListOutput.

Returns: The project of this SessionListOutput.
Return type: char

parents¶

Gets the parents of this SessionListOutput.

Returns: The parents of this SessionListOutput.
Return type: SessionParents

label¶

Gets the label of this SessionListOutput.

Returns: The label of this SessionListOutput.
Return type: char

uid¶

Gets the uid of this SessionListOutput.

Returns: The uid of this SessionListOutput.
Return type: char

timestamp¶

Gets the timestamp of this SessionListOutput.

Returns: The timestamp of this SessionListOutput.
Return type: datetime

timezone¶

Gets the timezone of this SessionListOutput.

Returns: The timezone of this SessionListOutput.
Return type: char

permissions¶

Gets the permissions of this SessionListOutput.

Returns: The permissions of this SessionListOutput.
Return type: RolePermission

tags¶

Gets the tags of this SessionListOutput.

Returns: The tags of this SessionListOutput.
Return type: vector[char]

notes¶

Gets the notes of this SessionListOutput.

Returns: The notes of this SessionListOutput.
Return type: Note

subject¶

Gets the subject of this SessionListOutput.

Returns: The subject of this SessionListOutput.
Return type: SubjectOutputForList

age¶

Gets the age of this SessionListOutput.

Returns: The age of this SessionListOutput.
Return type: integer

weight¶

Gets the weight of this SessionListOutput.

Returns: The weight of this SessionListOutput.
Return type: float

operator¶

Gets the operator of this SessionListOutput.

Returns: The operator of this SessionListOutput.
Return type: char

files¶

Gets the files of this SessionListOutput.

Returns: The files of this SessionListOutput.
Return type: FileListOutput

info¶

Gets the info of this SessionListOutput.

Returns: The info of this SessionListOutput.
Return type: containers.Map

infoExists¶

Gets the infoExists of this SessionListOutput.

Returns: The infoExists of this SessionListOutput.
Return type: logical

created¶

Gets the created of this SessionListOutput.

Returns: The created of this SessionListOutput.
Return type: datetime

modified¶

Gets the modified of this SessionListOutput.

Returns: The modified of this SessionListOutput.
Return type: datetime

revision¶

Gets the revision of this SessionListOutput.

Returns: The revision of this SessionListOutput.
Return type: integer

satisfiesTemplate¶

Gets the satisfiesTemplate of this SessionListOutput.

Returns: The satisfiesTemplate of this SessionListOutput.
Return type: logical

projectHasTemplate¶

Gets the projectHasTemplate of this SessionListOutput.

Returns: The projectHasTemplate of this SessionListOutput.
Return type: logical

joinOrigin¶

Gets the joinOrigin of this SessionListOutput.

Returns: The joinOrigin of this SessionListOutput.
Return type: JoinOrigins

analyses¶

Gets the analyses of this SessionListOutput.

Returns: The analyses of this SessionListOutput.
Return type: Object

copyOf¶

Gets the copyOf of this SessionListOutput.

Returns: The copyOf of this SessionListOutput.
Return type: containers.Map

originalCopyOf¶

Gets the originalCopyOf of this SessionListOutput.

Returns: The originalCopyOf of this SessionListOutput.
Return type: containers.Map

SessionModify¶

class SessionModify¶

timestamp¶

Gets the timestamp of this SessionModify.

Returns: The timestamp of this SessionModify.
Return type: datetime

project¶

Gets the project of this SessionModify.

Returns: The project of this SessionModify.
Return type: char

subject¶

Gets the subject of this SessionModify.

Returns: The subject of this SessionModify.
Return type: AnyOfSessionModifySubject

timezone¶

Gets the timezone of this SessionModify.

Returns: The timezone of this SessionModify.
Return type: char

label¶

Gets the label of this SessionModify.

Returns: The label of this SessionModify.
Return type: char

info¶

Gets the info of this SessionModify.

Returns: The info of this SessionModify.
Return type: containers.Map

tags¶

Gets the tags of this SessionModify.

Returns: The tags of this SessionModify.
Return type: vector[char]

permissions¶

Gets the permissions of this SessionModify.

Returns: The permissions of this SessionModify.
Return type: RolePermission

age¶

Gets the age of this SessionModify.

Returns: The age of this SessionModify.
Return type: integer

weight¶

Gets the weight of this SessionModify.

Returns: The weight of this SessionModify.
Return type: float

operator¶

Gets the operator of this SessionModify.

Returns: The operator of this SessionModify.
Return type: char

projectHasTemplate¶

Gets the projectHasTemplate of this SessionModify.

Returns: The projectHasTemplate of this SessionModify.
Return type: logical

SessionNode¶

class SessionNode¶

id¶

Gets the id of this SessionNode.

Returns: The id of this SessionNode.
Return type: char

group¶

Gets the group of this SessionNode.

Returns: The group of this SessionNode.
Return type: char

project¶

Gets the project of this SessionNode.

Returns: The project of this SessionNode.
Return type: char

parents¶

Gets the parents of this SessionNode.

Returns: The parents of this SessionNode.
Return type: SessionParents

label¶

Gets the label of this SessionNode.

Returns: The label of this SessionNode.
Return type: char

info¶

Gets the info of this SessionNode.

Returns: The info of this SessionNode.
Return type: containers.Map

uid¶

Gets the uid of this SessionNode.

Returns: The uid of this SessionNode.
Return type: char

timestamp¶

Gets the timestamp of this SessionNode.

Returns: The timestamp of this SessionNode.
Return type: datetime

timezone¶

Gets the timezone of this SessionNode.

Returns: The timezone of this SessionNode.
Return type: char

tags¶

Gets the tags of this SessionNode.

Returns: The tags of this SessionNode.
Return type: vector[char]

notes¶

Gets the notes of this SessionNode.

Returns: The notes of this SessionNode.
Return type: Note

permissions¶

Gets the permissions of this SessionNode.

Returns: The permissions of this SessionNode.
Return type: RolePermission

subject¶

Gets the subject of this SessionNode.

Returns: The subject of this SessionNode.
Return type: SubjectOutput

age¶

Gets the age of this SessionNode.

Returns: The age of this SessionNode.
Return type: integer

weight¶

Gets the weight of this SessionNode.

Returns: The weight of this SessionNode.
Return type: float

operator¶

Gets the operator of this SessionNode.

Returns: The operator of this SessionNode.
Return type: char

files¶

Gets the files of this SessionNode.

Returns: The files of this SessionNode.
Return type: FileOutput

created¶

Gets the created of this SessionNode.

Returns: The created of this SessionNode.
Return type: datetime

modified¶

Gets the modified of this SessionNode.

Returns: The modified of this SessionNode.
Return type: datetime

revision¶

Gets the revision of this SessionNode.

Returns: The revision of this SessionNode.
Return type: integer

satisfiesTemplate¶

Gets the satisfiesTemplate of this SessionNode.

Returns: The satisfiesTemplate of this SessionNode.
Return type: logical

analyses¶

Gets the analyses of this SessionNode.

Returns: The analyses of this SessionNode.
Return type: Object

projectHasTemplate¶

Gets the projectHasTemplate of this SessionNode.

Returns: The projectHasTemplate of this SessionNode.
Return type: logical

joinOrigin¶

Gets the joinOrigin of this SessionNode.

Returns: The joinOrigin of this SessionNode.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this SessionNode.

Returns: The copyOf of this SessionNode.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this SessionNode.

Returns: The originalCopyOf of this SessionNode.
Return type: char

infoExists¶

Gets the infoExists of this SessionNode.

Returns: The infoExists of this SessionNode.
Return type: logical

SessionOutput¶

class SessionOutput¶

id¶

Gets the id of this SessionOutput.

Returns: The id of this SessionOutput.
Return type: char

group¶

Gets the group of this SessionOutput.

Returns: The group of this SessionOutput.
Return type: char

project¶

Gets the project of this SessionOutput.

Returns: The project of this SessionOutput.
Return type: char

parents¶

Gets the parents of this SessionOutput.

Returns: The parents of this SessionOutput.
Return type: SessionParents

label¶

Gets the label of this SessionOutput.

Returns: The label of this SessionOutput.
Return type: char

info¶

Gets the info of this SessionOutput.

Returns: The info of this SessionOutput.
Return type: containers.Map

uid¶

Gets the uid of this SessionOutput.

Returns: The uid of this SessionOutput.
Return type: char

timestamp¶

Gets the timestamp of this SessionOutput.

Returns: The timestamp of this SessionOutput.
Return type: datetime

timezone¶

Gets the timezone of this SessionOutput.

Returns: The timezone of this SessionOutput.
Return type: char

tags¶

Gets the tags of this SessionOutput.

Returns: The tags of this SessionOutput.
Return type: vector[char]

notes¶

Gets the notes of this SessionOutput.

Returns: The notes of this SessionOutput.
Return type: Note

permissions¶

Gets the permissions of this SessionOutput.

Returns: The permissions of this SessionOutput.
Return type: RolePermission

subject¶

Gets the subject of this SessionOutput.

Returns: The subject of this SessionOutput.
Return type: SubjectOutput

age¶

Gets the age of this SessionOutput.

Returns: The age of this SessionOutput.
Return type: integer

weight¶

Gets the weight of this SessionOutput.

Returns: The weight of this SessionOutput.
Return type: float

operator¶

Gets the operator of this SessionOutput.

Returns: The operator of this SessionOutput.
Return type: char

files¶

Gets the files of this SessionOutput.

Returns: The files of this SessionOutput.
Return type: FileOutput

created¶

Gets the created of this SessionOutput.

Returns: The created of this SessionOutput.
Return type: datetime

modified¶

Gets the modified of this SessionOutput.

Returns: The modified of this SessionOutput.
Return type: datetime

revision¶

Gets the revision of this SessionOutput.

Returns: The revision of this SessionOutput.
Return type: integer

satisfiesTemplate¶

Gets the satisfiesTemplate of this SessionOutput.

Returns: The satisfiesTemplate of this SessionOutput.
Return type: logical

analyses¶

Gets the analyses of this SessionOutput.

Returns: The analyses of this SessionOutput.
Return type: Object

projectHasTemplate¶

Gets the projectHasTemplate of this SessionOutput.

Returns: The projectHasTemplate of this SessionOutput.
Return type: logical

joinOrigin¶

Gets the joinOrigin of this SessionOutput.

Returns: The joinOrigin of this SessionOutput.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this SessionOutput.

Returns: The copyOf of this SessionOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this SessionOutput.

Returns: The originalCopyOf of this SessionOutput.
Return type: char

infoExists¶

Gets the infoExists of this SessionOutput.

Returns: The infoExists of this SessionOutput.
Return type: logical

SessionParents¶

class SessionParents¶

group¶

Gets the group of this SessionParents.

Returns: The group of this SessionParents.
Return type: char

subject¶

Gets the subject of this SessionParents.

Returns: The subject of this SessionParents.
Return type: char

project¶

Gets the project of this SessionParents.

Returns: The project of this SessionParents.
Return type: char

SessionTemplateOptions¶

class SessionTemplateOptions¶

label¶

Gets the label of this SessionTemplateOptions.

Returns: The label of this SessionTemplateOptions.
Return type: char

tags¶

Gets the tags of this SessionTemplateOptions.

Returns: The tags of this SessionTemplateOptions.
Return type: char

subject¶

Gets the subject of this SessionTemplateOptions.

Returns: The subject of this SessionTemplateOptions.
Return type: SubjectTemplateOptions

SessionTemplateRecalcOutput¶

class SessionTemplateRecalcOutput¶

sessionsChanged¶

Unique database ID

Returns: The sessionsChanged of this SessionTemplateRecalcOutput.
Return type: vector[char]

SessionUpsertInput¶

class SessionUpsertInput¶

id¶

Gets the id of this SessionUpsertInput.

Returns: The id of this SessionUpsertInput.
Return type: char

uid¶

Gets the uid of this SessionUpsertInput.

Returns: The uid of this SessionUpsertInput.
Return type: char

routingField¶

Gets the routingField of this SessionUpsertInput.

Returns: The routingField of this SessionUpsertInput.
Return type: char

label¶

Gets the label of this SessionUpsertInput.

Returns: The label of this SessionUpsertInput.
Return type: char

timestamp¶

Gets the timestamp of this SessionUpsertInput.

Returns: The timestamp of this SessionUpsertInput.
Return type: datetime

timezone¶

Gets the timezone of this SessionUpsertInput.

Returns: The timezone of this SessionUpsertInput.
Return type: char

age¶

Gets the age of this SessionUpsertInput.

Returns: The age of this SessionUpsertInput.
Return type: integer

weight¶

Gets the weight of this SessionUpsertInput.

Returns: The weight of this SessionUpsertInput.
Return type: float

operator¶

Gets the operator of this SessionUpsertInput.

Returns: The operator of this SessionUpsertInput.
Return type: char

info¶

Gets the info of this SessionUpsertInput.

Returns: The info of this SessionUpsertInput.
Return type: containers.Map

SessionUpsertOutput¶

class SessionUpsertOutput¶

id¶

Gets the id of this SessionUpsertOutput.

Returns: The id of this SessionUpsertOutput.
Return type: char

uid¶

Gets the uid of this SessionUpsertOutput.

Returns: The uid of this SessionUpsertOutput.
Return type: char

label¶

Gets the label of this SessionUpsertOutput.

Returns: The label of this SessionUpsertOutput.
Return type: char

upsertResult¶

Gets the upsertResult of this SessionUpsertOutput.

Returns: The upsertResult of this SessionUpsertOutput.
Return type: char

SharingFilterOptions¶

class SharingFilterOptions¶

therapeuticAreas¶

Gets the therapeuticAreas of this SharingFilterOptions.

Returns: The therapeuticAreas of this SharingFilterOptions.
Return type: vector[char]

bodyRegions¶

Gets the bodyRegions of this SharingFilterOptions.

Returns: The bodyRegions of this SharingFilterOptions.
Return type: vector[char]

organSystems¶

Gets the organSystems of this SharingFilterOptions.

Returns: The organSystems of this SharingFilterOptions.
Return type: vector[char]

ageGroups¶

Gets the ageGroups of this SharingFilterOptions.

Returns: The ageGroups of this SharingFilterOptions.
Return type: vector[char]

measurements¶

Gets the measurements of this SharingFilterOptions.

Returns: The measurements of this SharingFilterOptions.
Return type: vector[char]

modalities¶

Gets the modalities of this SharingFilterOptions.

Returns: The modalities of this SharingFilterOptions.
Return type: vector[char]

fileTypes¶

Gets the fileTypes of this SharingFilterOptions.

Returns: The fileTypes of this SharingFilterOptions.
Return type: vector[char]

tags¶

Gets the tags of this SharingFilterOptions.

Returns: The tags of this SharingFilterOptions.
Return type: vector[char]

SignedUrlUploadInput¶

Signed url upload input payload schema.

class SignedUrlUploadInput¶

Signed url upload input payload schema.

providerId¶

Gets the providerId of this SignedUrlUploadInput.

Returns: The providerId of this SignedUrlUploadInput.
Return type: char

size¶

Gets the size of this SignedUrlUploadInput.

Returns: The size of this SignedUrlUploadInput.
Return type: integer

SignedUrlUploadOutput¶

Signed url upload response model.

class SignedUrlUploadOutput¶

Signed url upload response model.

providerId¶

Gets the providerId of this SignedUrlUploadOutput.

Returns: The providerId of this SignedUrlUploadOutput.
Return type: char

uuid¶

Gets the uuid of this SignedUrlUploadOutput.

Returns: The uuid of this SignedUrlUploadOutput.
Return type: char

uploadUrls¶

Gets the uploadUrls of this SignedUrlUploadOutput.

Returns: The uploadUrls of this SignedUrlUploadOutput.
Return type: vector[char]

uploadHeaders¶

Gets the uploadHeaders of this SignedUrlUploadOutput.

Returns: The uploadHeaders of this SignedUrlUploadOutput.
Return type: containers.Map[String, char]

s3MultipartUploadId¶

Gets the s3MultipartUploadId of this SignedUrlUploadOutput.

Returns: The s3MultipartUploadId of this SignedUrlUploadOutput.
Return type: char

azMultipartUploadId¶

Gets the azMultipartUploadId of this SignedUrlUploadOutput.

Returns: The azMultipartUploadId of this SignedUrlUploadOutput.
Return type: char

note¶

Gets the note of this SignedUrlUploadOutput.

Returns: The note of this SignedUrlUploadOutput.
Return type: char

Site¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

class Site¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

id¶

Gets the id of this Site.

Returns: The id of this Site.
Return type: char

apiUrl¶

Gets the apiUrl of this Site.

Returns: The apiUrl of this Site.
Return type: char

centralUrl¶

Gets the centralUrl of this Site.

Returns: The centralUrl of this Site.
Return type: char

deidLogUrl¶

Gets the deidLogUrl of this Site.

Returns: The deidLogUrl of this Site.
Return type: char

dimseHost¶

Gets the dimseHost of this Site.

Returns: The dimseHost of this Site.
Return type: char

dimsePort¶

Gets the dimsePort of this Site.

Returns: The dimsePort of this Site.
Return type: integer

mfaCodeLength¶

Gets the mfaCodeLength of this Site.

Returns: The mfaCodeLength of this Site.
Return type: integer

inactivityTimeout¶

Gets the inactivityTimeout of this Site.

Returns: The inactivityTimeout of this Site.
Return type: integer

name¶

Gets the name of this Site.

Returns: The name of this Site.
Return type: char

redirectUrl¶

Gets the redirectUrl of this Site.

Returns: The redirectUrl of this Site.
Return type: char

registered¶

Gets the registered of this Site.

Returns: The registered of this Site.
Return type: logical

sslCert¶

Gets the sslCert of this Site.

Returns: The sslCert of this Site.
Return type: char

uploadMaximumBytes¶

Gets the uploadMaximumBytes of this Site.

Returns: The uploadMaximumBytes of this Site.
Return type: char

proxyCdn¶

Gets the proxyCdn of this Site.

Returns: The proxyCdn of this Site.
Return type: logical

gravatarAddress¶

Gets the gravatarAddress of this Site.

Returns: The gravatarAddress of this Site.
Return type: char

paginationLimit¶

Gets the paginationLimit of this Site.

Returns: The paginationLimit of this Site.
Return type: integer

SiteReport¶

class SiteReport¶

groupCount¶

Gets the groupCount of this SiteReport.

Returns: The groupCount of this SiteReport.
Return type: integer

groups¶

Gets the groups of this SiteReport.

Returns: The groups of this SiteReport.
Return type: GroupReport

SiteSettings¶

class SiteSettings¶

id¶

Gets the id of this SiteSettings.

Returns: The id of this SiteSettings.
Return type: char

created¶

Gets the created of this SiteSettings.

Returns: The created of this SiteSettings.
Return type: datetime

modified¶

Gets the modified of this SiteSettings.

Returns: The modified of this SiteSettings.
Return type: datetime

centerGears¶

Gets the centerGears of this SiteSettings.

Returns: The centerGears of this SiteSettings.
Return type: vector[char]

providers¶

Gets the providers of this SiteSettings.

Returns: The providers of this SiteSettings.
Return type: Providers

ldapSync¶

Gets the ldapSync of this SiteSettings.

Returns: The ldapSync of this SiteSettings.
Return type: LdapSyncStatus

viewerApps¶

Gets the viewerApps of this SiteSettings.

Returns: The viewerApps of this SiteSettings.
Return type: ViewerApp

deidProfile¶

Gets the deidProfile of this SiteSettings.

Returns: The deidProfile of this SiteSettings.
Return type: containers.Map

Sort¶

class Sort¶

field¶

Gets the field of this Sort.

Returns: The field of this Sort.
Return type: char

order¶

Gets the order of this Sort.

Returns: The order of this Sort.
Return type: Order

StableApiKeyInput¶

class StableApiKeyInput¶

StaticCompute¶

class StaticCompute¶

configType¶

Gets the configType of this StaticCompute.

Returns: The configType of this StaticCompute.
Return type: char

configClass¶

Gets the configClass of this StaticCompute.

Returns: The configClass of this StaticCompute.
Return type: char

tags¶

Gets the tags of this StaticCompute.

Returns: The tags of this StaticCompute.
Return type: containers.Map

StatusValue¶

An enumeration.

class StatusValue¶: An enumeration.

StorageStrategy¶

An enumeration.

class StorageStrategy¶: An enumeration.

StorageStrategyConfig¶

class StorageStrategyConfig¶

storageStrategy¶

Gets the storageStrategy of this StorageStrategyConfig.

Returns: The storageStrategy of this StorageStrategyConfig.
Return type: AllOfStorageStrategyConfigStorageStrategy

provider¶

Gets the provider of this StorageStrategyConfig.

Returns: The provider of this StorageStrategyConfig.
Return type: char

StructuredQuery¶

class StructuredQuery¶

structuredQuery¶

Represents structured query language search

Returns: The structuredQuery of this StructuredQuery.
Return type: char

Subject¶

class Subject¶

SubjectContainerOutput¶

class SubjectContainerOutput¶

id¶

Gets the id of this SubjectContainerOutput.

Returns: The id of this SubjectContainerOutput.
Return type: char

project¶

Gets the project of this SubjectContainerOutput.

Returns: The project of this SubjectContainerOutput.
Return type: char

created¶

Gets the created of this SubjectContainerOutput.

Returns: The created of this SubjectContainerOutput.
Return type: datetime

dateOfBirth¶

Gets the dateOfBirth of this SubjectContainerOutput.

Returns: The dateOfBirth of this SubjectContainerOutput.
Return type: datetime

modified¶

Gets the modified of this SubjectContainerOutput.

Returns: The modified of this SubjectContainerOutput.
Return type: datetime

revision¶

Gets the revision of this SubjectContainerOutput.

Returns: The revision of this SubjectContainerOutput.
Return type: integer

parents¶

Gets the parents of this SubjectContainerOutput.

Returns: The parents of this SubjectContainerOutput.
Return type: SubjectParents

permissions¶

Gets the permissions of this SubjectContainerOutput.

Returns: The permissions of this SubjectContainerOutput.
Return type: SubjectRolePermission

firstname¶

Gets the firstname of this SubjectContainerOutput.

Returns: The firstname of this SubjectContainerOutput.
Return type: char

lastname¶

Gets the lastname of this SubjectContainerOutput.

Returns: The lastname of this SubjectContainerOutput.
Return type: char

sex¶

Gets the sex of this SubjectContainerOutput.

Returns: The sex of this SubjectContainerOutput.
Return type: char

age¶

Gets the age of this SubjectContainerOutput.

Returns: The age of this SubjectContainerOutput.
Return type: integer

cohort¶

Gets the cohort of this SubjectContainerOutput.

Returns: The cohort of this SubjectContainerOutput.
Return type: Cohort

mlset¶

Gets the mlset of this SubjectContainerOutput.

Returns: The mlset of this SubjectContainerOutput.
Return type: MLType

type¶

Gets the type of this SubjectContainerOutput.

Returns: The type of this SubjectContainerOutput.
Return type: char

race¶

Gets the race of this SubjectContainerOutput.

Returns: The race of this SubjectContainerOutput.
Return type: char

ethnicity¶

Gets the ethnicity of this SubjectContainerOutput.

Returns: The ethnicity of this SubjectContainerOutput.
Return type: char

species¶

Gets the species of this SubjectContainerOutput.

Returns: The species of this SubjectContainerOutput.
Return type: char

strain¶

Gets the strain of this SubjectContainerOutput.

Returns: The strain of this SubjectContainerOutput.
Return type: char

label¶

Gets the label of this SubjectContainerOutput.

Returns: The label of this SubjectContainerOutput.
Return type: char

code¶

Gets the code of this SubjectContainerOutput.

Returns: The code of this SubjectContainerOutput.
Return type: char

masterCode¶

Gets the masterCode of this SubjectContainerOutput.

Returns: The masterCode of this SubjectContainerOutput.
Return type: char

notes¶

Gets the notes of this SubjectContainerOutput.

Returns: The notes of this SubjectContainerOutput.
Return type: Note

tags¶

Gets the tags of this SubjectContainerOutput.

Returns: The tags of this SubjectContainerOutput.
Return type: vector[char]

info¶

Gets the info of this SubjectContainerOutput.

Returns: The info of this SubjectContainerOutput.
Return type: containers.Map

infoExists¶

Gets the infoExists of this SubjectContainerOutput.

Returns: The infoExists of this SubjectContainerOutput.
Return type: logical

state¶

Gets the state of this SubjectContainerOutput.

Returns: The state of this SubjectContainerOutput.
Return type: SubjectState

files¶

Gets the files of this SubjectContainerOutput.

Returns: The files of this SubjectContainerOutput.
Return type: FileOutput

analyses¶

Gets the analyses of this SubjectContainerOutput.

Returns: The analyses of this SubjectContainerOutput.
Return type: Object

joinOrigin¶

Gets the joinOrigin of this SubjectContainerOutput.

Returns: The joinOrigin of this SubjectContainerOutput.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this SubjectContainerOutput.

Returns: The copyOf of this SubjectContainerOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this SubjectContainerOutput.

Returns: The originalCopyOf of this SubjectContainerOutput.
Return type: char

containerType¶

Gets the containerType of this SubjectContainerOutput.

Returns: The containerType of this SubjectContainerOutput.
Return type: AllOfSubjectContainerOutputContainerType

SubjectInput¶

class SubjectInput¶

firstname¶

Gets the firstname of this SubjectInput.

Returns: The firstname of this SubjectInput.
Return type: char

lastname¶

Gets the lastname of this SubjectInput.

Returns: The lastname of this SubjectInput.
Return type: char

sex¶

Gets the sex of this SubjectInput.

Returns: The sex of this SubjectInput.
Return type: char

cohort¶

Gets the cohort of this SubjectInput.

Returns: The cohort of this SubjectInput.
Return type: Cohort

dateOfBirth¶

Gets the dateOfBirth of this SubjectInput.

Returns: The dateOfBirth of this SubjectInput.
Return type: datetime

mlset¶

Gets the mlset of this SubjectInput.

Returns: The mlset of this SubjectInput.
Return type: MLType

type¶

Gets the type of this SubjectInput.

Returns: The type of this SubjectInput.
Return type: char

race¶

Gets the race of this SubjectInput.

Returns: The race of this SubjectInput.
Return type: char

ethnicity¶

Gets the ethnicity of this SubjectInput.

Returns: The ethnicity of this SubjectInput.
Return type: char

species¶

Gets the species of this SubjectInput.

Returns: The species of this SubjectInput.
Return type: char

strain¶

Gets the strain of this SubjectInput.

Returns: The strain of this SubjectInput.
Return type: char

label¶

Gets the label of this SubjectInput.

Returns: The label of this SubjectInput.
Return type: char

code¶

Gets the code of this SubjectInput.

Returns: The code of this SubjectInput.
Return type: char

masterCode¶

Gets the masterCode of this SubjectInput.

Returns: The masterCode of this SubjectInput.
Return type: char

tags¶

Gets the tags of this SubjectInput.

Returns: The tags of this SubjectInput.
Return type: vector[char]

info¶

Gets the info of this SubjectInput.

Returns: The info of this SubjectInput.
Return type: containers.Map

state¶

Gets the state of this SubjectInput.

Returns: The state of this SubjectInput.
Return type: SubjectState

project¶

Gets the project of this SubjectInput.

Returns: The project of this SubjectInput.
Return type: char

SubjectModify¶

class SubjectModify¶

firstname¶

Gets the firstname of this SubjectModify.

Returns: The firstname of this SubjectModify.
Return type: char

lastname¶

Gets the lastname of this SubjectModify.

Returns: The lastname of this SubjectModify.
Return type: char

sex¶

Gets the sex of this SubjectModify.

Returns: The sex of this SubjectModify.
Return type: char

cohort¶

Gets the cohort of this SubjectModify.

Returns: The cohort of this SubjectModify.
Return type: Cohort

dateOfBirth¶

Gets the dateOfBirth of this SubjectModify.

Returns: The dateOfBirth of this SubjectModify.
Return type: datetime

mlset¶

Gets the mlset of this SubjectModify.

Returns: The mlset of this SubjectModify.
Return type: MLType

type¶

Gets the type of this SubjectModify.

Returns: The type of this SubjectModify.
Return type: char

race¶

Gets the race of this SubjectModify.

Returns: The race of this SubjectModify.
Return type: char

ethnicity¶

Gets the ethnicity of this SubjectModify.

Returns: The ethnicity of this SubjectModify.
Return type: char

species¶

Gets the species of this SubjectModify.

Returns: The species of this SubjectModify.
Return type: char

strain¶

Gets the strain of this SubjectModify.

Returns: The strain of this SubjectModify.
Return type: char

label¶

Gets the label of this SubjectModify.

Returns: The label of this SubjectModify.
Return type: char

code¶

Gets the code of this SubjectModify.

Returns: The code of this SubjectModify.
Return type: char

masterCode¶

Gets the masterCode of this SubjectModify.

Returns: The masterCode of this SubjectModify.
Return type: char

tags¶

Gets the tags of this SubjectModify.

Returns: The tags of this SubjectModify.
Return type: vector[char]

info¶

Gets the info of this SubjectModify.

Returns: The info of this SubjectModify.
Return type: containers.Map

state¶

Gets the state of this SubjectModify.

Returns: The state of this SubjectModify.
Return type: SubjectState

project¶

Gets the project of this SubjectModify.

Returns: The project of this SubjectModify.
Return type: char

permissions¶

Gets the permissions of this SubjectModify.

Returns: The permissions of this SubjectModify.
Return type: RolePermission

notes¶

Gets the notes of this SubjectModify.

Returns: The notes of this SubjectModify.
Return type: Note

SubjectNode¶

class SubjectNode¶

id¶

Gets the id of this SubjectNode.

Returns: The id of this SubjectNode.
Return type: char

project¶

Gets the project of this SubjectNode.

Returns: The project of this SubjectNode.
Return type: char

created¶

Gets the created of this SubjectNode.

Returns: The created of this SubjectNode.
Return type: datetime

dateOfBirth¶

Gets the dateOfBirth of this SubjectNode.

Returns: The dateOfBirth of this SubjectNode.
Return type: datetime

modified¶

Gets the modified of this SubjectNode.

Returns: The modified of this SubjectNode.
Return type: datetime

revision¶

Gets the revision of this SubjectNode.

Returns: The revision of this SubjectNode.
Return type: integer

parents¶

Gets the parents of this SubjectNode.

Returns: The parents of this SubjectNode.
Return type: SubjectParents

permissions¶

Gets the permissions of this SubjectNode.

Returns: The permissions of this SubjectNode.
Return type: SubjectRolePermission

firstname¶

Gets the firstname of this SubjectNode.

Returns: The firstname of this SubjectNode.
Return type: char

lastname¶

Gets the lastname of this SubjectNode.

Returns: The lastname of this SubjectNode.
Return type: char

sex¶

Gets the sex of this SubjectNode.

Returns: The sex of this SubjectNode.
Return type: char

age¶

Gets the age of this SubjectNode.

Returns: The age of this SubjectNode.
Return type: integer

cohort¶

Gets the cohort of this SubjectNode.

Returns: The cohort of this SubjectNode.
Return type: Cohort

mlset¶

Gets the mlset of this SubjectNode.

Returns: The mlset of this SubjectNode.
Return type: MLType

type¶

Gets the type of this SubjectNode.

Returns: The type of this SubjectNode.
Return type: char

race¶

Gets the race of this SubjectNode.

Returns: The race of this SubjectNode.
Return type: char

ethnicity¶

Gets the ethnicity of this SubjectNode.

Returns: The ethnicity of this SubjectNode.
Return type: char

species¶

Gets the species of this SubjectNode.

Returns: The species of this SubjectNode.
Return type: char

strain¶

Gets the strain of this SubjectNode.

Returns: The strain of this SubjectNode.
Return type: char

label¶

Gets the label of this SubjectNode.

Returns: The label of this SubjectNode.
Return type: char

code¶

Gets the code of this SubjectNode.

Returns: The code of this SubjectNode.
Return type: char

masterCode¶

Gets the masterCode of this SubjectNode.

Returns: The masterCode of this SubjectNode.
Return type: char

notes¶

Gets the notes of this SubjectNode.

Returns: The notes of this SubjectNode.
Return type: Note

tags¶

Gets the tags of this SubjectNode.

Returns: The tags of this SubjectNode.
Return type: vector[char]

info¶

Gets the info of this SubjectNode.

Returns: The info of this SubjectNode.
Return type: containers.Map

infoExists¶

Gets the infoExists of this SubjectNode.

Returns: The infoExists of this SubjectNode.
Return type: logical

state¶

Gets the state of this SubjectNode.

Returns: The state of this SubjectNode.
Return type: SubjectState

files¶

Gets the files of this SubjectNode.

Returns: The files of this SubjectNode.
Return type: FileOutput

analyses¶

Gets the analyses of this SubjectNode.

Returns: The analyses of this SubjectNode.
Return type: Object

joinOrigin¶

Gets the joinOrigin of this SubjectNode.

Returns: The joinOrigin of this SubjectNode.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this SubjectNode.

Returns: The copyOf of this SubjectNode.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this SubjectNode.

Returns: The originalCopyOf of this SubjectNode.
Return type: char

SubjectOutput¶

class SubjectOutput¶

id¶

Gets the id of this SubjectOutput.

Returns: The id of this SubjectOutput.
Return type: char

project¶

Gets the project of this SubjectOutput.

Returns: The project of this SubjectOutput.
Return type: char

created¶

Gets the created of this SubjectOutput.

Returns: The created of this SubjectOutput.
Return type: datetime

dateOfBirth¶

Gets the dateOfBirth of this SubjectOutput.

Returns: The dateOfBirth of this SubjectOutput.
Return type: datetime

modified¶

Gets the modified of this SubjectOutput.

Returns: The modified of this SubjectOutput.
Return type: datetime

revision¶

Gets the revision of this SubjectOutput.

Returns: The revision of this SubjectOutput.
Return type: integer

parents¶

Gets the parents of this SubjectOutput.

Returns: The parents of this SubjectOutput.
Return type: SubjectParents

permissions¶

Gets the permissions of this SubjectOutput.

Returns: The permissions of this SubjectOutput.
Return type: SubjectRolePermission

firstname¶

Gets the firstname of this SubjectOutput.

Returns: The firstname of this SubjectOutput.
Return type: char

lastname¶

Gets the lastname of this SubjectOutput.

Returns: The lastname of this SubjectOutput.
Return type: char

sex¶

Gets the sex of this SubjectOutput.

Returns: The sex of this SubjectOutput.
Return type: char

age¶

Gets the age of this SubjectOutput.

Returns: The age of this SubjectOutput.
Return type: integer

cohort¶

Gets the cohort of this SubjectOutput.

Returns: The cohort of this SubjectOutput.
Return type: Cohort

mlset¶

Gets the mlset of this SubjectOutput.

Returns: The mlset of this SubjectOutput.
Return type: MLType

type¶

Gets the type of this SubjectOutput.

Returns: The type of this SubjectOutput.
Return type: char

race¶

Gets the race of this SubjectOutput.

Returns: The race of this SubjectOutput.
Return type: char

ethnicity¶

Gets the ethnicity of this SubjectOutput.

Returns: The ethnicity of this SubjectOutput.
Return type: char

species¶

Gets the species of this SubjectOutput.

Returns: The species of this SubjectOutput.
Return type: char

strain¶

Gets the strain of this SubjectOutput.

Returns: The strain of this SubjectOutput.
Return type: char

label¶

Gets the label of this SubjectOutput.

Returns: The label of this SubjectOutput.
Return type: char

code¶

Gets the code of this SubjectOutput.

Returns: The code of this SubjectOutput.
Return type: char

masterCode¶

Gets the masterCode of this SubjectOutput.

Returns: The masterCode of this SubjectOutput.
Return type: char

notes¶

Gets the notes of this SubjectOutput.

Returns: The notes of this SubjectOutput.
Return type: Note

tags¶

Gets the tags of this SubjectOutput.

Returns: The tags of this SubjectOutput.
Return type: vector[char]

info¶

Gets the info of this SubjectOutput.

Returns: The info of this SubjectOutput.
Return type: containers.Map

infoExists¶

Gets the infoExists of this SubjectOutput.

Returns: The infoExists of this SubjectOutput.
Return type: logical

state¶

Gets the state of this SubjectOutput.

Returns: The state of this SubjectOutput.
Return type: SubjectState

files¶

Gets the files of this SubjectOutput.

Returns: The files of this SubjectOutput.
Return type: FileOutput

analyses¶

Gets the analyses of this SubjectOutput.

Returns: The analyses of this SubjectOutput.
Return type: Object

joinOrigin¶

Gets the joinOrigin of this SubjectOutput.

Returns: The joinOrigin of this SubjectOutput.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this SubjectOutput.

Returns: The copyOf of this SubjectOutput.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this SubjectOutput.

Returns: The originalCopyOf of this SubjectOutput.
Return type: char

SubjectOutputForList¶

Simplified version of the list output that does not have any PHI and thus does not require logging of the response

class SubjectOutputForList¶

Simplified version of the list output that does not have any PHI and thus does not require logging of the response

id¶

Gets the id of this SubjectOutputForList.

Returns: The id of this SubjectOutputForList.
Return type: char

project¶

Gets the project of this SubjectOutputForList.

Returns: The project of this SubjectOutputForList.
Return type: char

created¶

Gets the created of this SubjectOutputForList.

Returns: The created of this SubjectOutputForList.
Return type: datetime

dateOfBirth¶

Gets the dateOfBirth of this SubjectOutputForList.

Returns: The dateOfBirth of this SubjectOutputForList.
Return type: datetime

modified¶

Gets the modified of this SubjectOutputForList.

Returns: The modified of this SubjectOutputForList.
Return type: datetime

revision¶

Gets the revision of this SubjectOutputForList.

Returns: The revision of this SubjectOutputForList.
Return type: integer

parents¶

Gets the parents of this SubjectOutputForList.

Returns: The parents of this SubjectOutputForList.
Return type: SubjectParents

permissions¶

Gets the permissions of this SubjectOutputForList.

Returns: The permissions of this SubjectOutputForList.
Return type: RolePermission

cohort¶

Gets the cohort of this SubjectOutputForList.

Returns: The cohort of this SubjectOutputForList.
Return type: Cohort

mlset¶

Gets the mlset of this SubjectOutputForList.

Returns: The mlset of this SubjectOutputForList.
Return type: MLType

type¶

Gets the type of this SubjectOutputForList.

Returns: The type of this SubjectOutputForList.
Return type: char

species¶

Gets the species of this SubjectOutputForList.

Returns: The species of this SubjectOutputForList.
Return type: char

strain¶

Gets the strain of this SubjectOutputForList.

Returns: The strain of this SubjectOutputForList.
Return type: char

label¶

Gets the label of this SubjectOutputForList.

Returns: The label of this SubjectOutputForList.
Return type: char

code¶

Gets the code of this SubjectOutputForList.

Returns: The code of this SubjectOutputForList.
Return type: char

masterCode¶

Gets the masterCode of this SubjectOutputForList.

Returns: The masterCode of this SubjectOutputForList.
Return type: char

notes¶

Gets the notes of this SubjectOutputForList.

Returns: The notes of this SubjectOutputForList.
Return type: Note

tags¶

Gets the tags of this SubjectOutputForList.

Returns: The tags of this SubjectOutputForList.
Return type: vector[char]

info¶

Gets the info of this SubjectOutputForList.

Returns: The info of this SubjectOutputForList.
Return type: containers.Map

infoExists¶

Gets the infoExists of this SubjectOutputForList.

Returns: The infoExists of this SubjectOutputForList.
Return type: logical

state¶

Gets the state of this SubjectOutputForList.

Returns: The state of this SubjectOutputForList.
Return type: SubjectState

files¶

Gets the files of this SubjectOutputForList.

Returns: The files of this SubjectOutputForList.
Return type: FileListOutput

analyses¶

Gets the analyses of this SubjectOutputForList.

Returns: The analyses of this SubjectOutputForList.
Return type: Object

joinOrigin¶

Gets the joinOrigin of this SubjectOutputForList.

Returns: The joinOrigin of this SubjectOutputForList.
Return type: JoinOrigins

copyOf¶

Gets the copyOf of this SubjectOutputForList.

Returns: The copyOf of this SubjectOutputForList.
Return type: char

originalCopyOf¶

Gets the originalCopyOf of this SubjectOutputForList.

Returns: The originalCopyOf of this SubjectOutputForList.
Return type: char

firstname¶

Gets the firstname of this SubjectOutputForList.

Returns: The firstname of this SubjectOutputForList.
Return type: char

lastname¶

Gets the lastname of this SubjectOutputForList.

Returns: The lastname of this SubjectOutputForList.
Return type: char

sex¶

Gets the sex of this SubjectOutputForList.

Returns: The sex of this SubjectOutputForList.
Return type: char

age¶

Gets the age of this SubjectOutputForList.

Returns: The age of this SubjectOutputForList.
Return type: integer

race¶

Gets the race of this SubjectOutputForList.

Returns: The race of this SubjectOutputForList.
Return type: char

ethnicity¶

Gets the ethnicity of this SubjectOutputForList.

Returns: The ethnicity of this SubjectOutputForList.
Return type: char

SubjectParents¶

class SubjectParents¶

group¶

Gets the group of this SubjectParents.

Returns: The group of this SubjectParents.
Return type: char

project¶

Gets the project of this SubjectParents.

Returns: The project of this SubjectParents.
Return type: char

SubjectRolePermission¶

Model for a role permission Attributes: id: The id of the user role_ids: List of ids of the roles user has on the resource

class SubjectRolePermission¶

Model for a role permission Attributes: id: The id of the user role_ids: List of ids of the roles user has on the resource

id¶

Gets the id of this SubjectRolePermission.

Returns: The id of this SubjectRolePermission.
Return type: char

roleIds¶

Gets the roleIds of this SubjectRolePermission.

Returns: The roleIds of this SubjectRolePermission.
Return type: vector[char]

SubjectState¶

An enumeration.

class SubjectState¶: An enumeration.

SubjectTemplateOptions¶

class SubjectTemplateOptions¶

code¶

Gets the code of this SubjectTemplateOptions.

Returns: The code of this SubjectTemplateOptions.
Return type: char

tags¶

Gets the tags of this SubjectTemplateOptions.

Returns: The tags of this SubjectTemplateOptions.
Return type: char

SubjectUpsertInput¶

class SubjectUpsertInput¶

dateOfBirth¶

Gets the dateOfBirth of this SubjectUpsertInput.

Returns: The dateOfBirth of this SubjectUpsertInput.
Return type: datetime

id¶

Gets the id of this SubjectUpsertInput.

Returns: The id of this SubjectUpsertInput.
Return type: char

routingField¶

Gets the routingField of this SubjectUpsertInput.

Returns: The routingField of this SubjectUpsertInput.
Return type: char

label¶

Gets the label of this SubjectUpsertInput.

Returns: The label of this SubjectUpsertInput.
Return type: char

firstname¶

Gets the firstname of this SubjectUpsertInput.

Returns: The firstname of this SubjectUpsertInput.
Return type: char

lastname¶

Gets the lastname of this SubjectUpsertInput.

Returns: The lastname of this SubjectUpsertInput.
Return type: char

sex¶

Gets the sex of this SubjectUpsertInput.

Returns: The sex of this SubjectUpsertInput.
Return type: char

type¶

Gets the type of this SubjectUpsertInput.

Returns: The type of this SubjectUpsertInput.
Return type: char

race¶

Gets the race of this SubjectUpsertInput.

Returns: The race of this SubjectUpsertInput.
Return type: char

ethnicity¶

Gets the ethnicity of this SubjectUpsertInput.

Returns: The ethnicity of this SubjectUpsertInput.
Return type: char

species¶

Gets the species of this SubjectUpsertInput.

Returns: The species of this SubjectUpsertInput.
Return type: char

strain¶

Gets the strain of this SubjectUpsertInput.

Returns: The strain of this SubjectUpsertInput.
Return type: char

info¶

Gets the info of this SubjectUpsertInput.

Returns: The info of this SubjectUpsertInput.
Return type: containers.Map

state¶

Gets the state of this SubjectUpsertInput.

Returns: The state of this SubjectUpsertInput.
Return type: SubjectState

SubjectUpsertOutput¶

class SubjectUpsertOutput¶

id¶

Gets the id of this SubjectUpsertOutput.

Returns: The id of this SubjectUpsertOutput.
Return type: char

label¶

Gets the label of this SubjectUpsertOutput.

Returns: The label of this SubjectUpsertOutput.
Return type: char

upsertResult¶

Gets the upsertResult of this SubjectUpsertOutput.

Returns: The upsertResult of this SubjectUpsertOutput.
Return type: char

Tag¶

class Tag¶

value¶

Gets the value of this Tag.

Returns: The value of this Tag.
Return type: char

TherapeuticArea¶

An enumeration.

class TherapeuticArea¶: An enumeration.

Transitions¶

The representation of the object holding information about when a job made transitions to the different states Attributes: pending (Optional[datetime.datetime]): Timestamp of when the job transitioned to pending state running (Optional[datetime.datetime]): Timestamp of when the job transitioned to running state failed (Optional[datetime.datetime]): Timestamp of when the job transitioned to failed state complete (Optional[datetime.datetime]): Timestamp of when the job transitioned to complete state cancelled (Optional[datetime.datetime]): Timestamp of when the job transitioned to cancelled state

class Transitions¶

The representation of the object holding information about when a job made transitions to the different states Attributes: pending (Optional[datetime.datetime]): Timestamp of when the job transitioned to pending state running (Optional[datetime.datetime]): Timestamp of when the job transitioned to running state failed (Optional[datetime.datetime]): Timestamp of when the job transitioned to failed state complete (Optional[datetime.datetime]): Timestamp of when the job transitioned to complete state cancelled (Optional[datetime.datetime]): Timestamp of when the job transitioned to cancelled state

pending¶

Gets the pending of this Transitions.

Returns: The pending of this Transitions.
Return type: datetime

running¶

Gets the running of this Transitions.

Returns: The running of this Transitions.
Return type: datetime

failed¶

Gets the failed of this Transitions.

Returns: The failed of this Transitions.
Return type: datetime

complete¶

Gets the complete of this Transitions.

Returns: The complete of this Transitions.
Return type: datetime

cancelled¶

Gets the cancelled of this Transitions.

Returns: The cancelled of this Transitions.
Return type: datetime

TreeContainerRequestSpec¶

class TreeContainerRequestSpec¶

fields¶

The list of fields to include

Returns: The fields of this TreeContainerRequestSpec.
Return type: vector[char]

filter¶

The optional, comma-separated filter string

Returns: The filter of this TreeContainerRequestSpec.
Return type: char

limit¶

The optional maximum number of children to include

Returns: The limit of this TreeContainerRequestSpec.
Return type: integer

sort¶

The optional, comma-separated, sort specification

Returns: The sort of this TreeContainerRequestSpec.
Return type: char

joinOrigin¶

Whether or not to join file origins, default is false

Returns: The joinOrigin of this TreeContainerRequestSpec.
Return type: logical

TreeGraph¶

class TreeGraph¶

TreeGraphConnection¶

class TreeGraphConnection¶

local¶

Gets the local of this TreeGraphConnection.

Returns: The local of this TreeGraphConnection.
Return type: char

foreign¶

Gets the foreign of this TreeGraphConnection.

Returns: The foreign of this TreeGraphConnection.
Return type: char

collection¶

Gets the collection of this TreeGraphConnection.

Returns: The collection of this TreeGraphConnection.
Return type: char

order¶

Gets the order of this TreeGraphConnection.

Returns: The order of this TreeGraphConnection.
Return type: char

TreeGraphConnections¶

class TreeGraphConnections¶

TreeGraphNode¶

class TreeGraphNode¶

connections¶

Gets the connections of this TreeGraphNode.

Returns: The connections of this TreeGraphNode.
Return type: TreeGraphConnections

TreeRequest¶

class TreeRequest¶

TreeResponseItem¶

Response varies based on selected container and fields

class TreeResponseItem¶: Response varies based on selected container and fields

TypeStr¶

An enumeration.

class TypeStr¶: An enumeration.

UidCheckInputAcquisitions¶

class UidCheckInputAcquisitions¶

projectId¶

Gets the projectId of this UidCheckInputAcquisitions.

Returns: The projectId of this UidCheckInputAcquisitions.
Return type: char

projectIds¶

Gets the projectIds of this UidCheckInputAcquisitions.

Returns: The projectIds of this UidCheckInputAcquisitions.
Return type: vector[char]

sessions¶

Gets the sessions of this UidCheckInputAcquisitions.

Returns: The sessions of this UidCheckInputAcquisitions.
Return type: vector[char]

acquisitions¶

Gets the acquisitions of this UidCheckInputAcquisitions.

Returns: The acquisitions of this UidCheckInputAcquisitions.
Return type: vector[char]

UidCheckInputSessions¶

class UidCheckInputSessions¶

projectId¶

Gets the projectId of this UidCheckInputSessions.

Returns: The projectId of this UidCheckInputSessions.
Return type: char

projectIds¶

Gets the projectIds of this UidCheckInputSessions.

Returns: The projectIds of this UidCheckInputSessions.
Return type: vector[char]

sessions¶

Gets the sessions of this UidCheckInputSessions.

Returns: The sessions of this UidCheckInputSessions.
Return type: vector[char]

acquisitions¶

Gets the acquisitions of this UidCheckInputSessions.

Returns: The acquisitions of this UidCheckInputSessions.
Return type: vector[char]

UidCheckOutput¶

class UidCheckOutput¶

sessions¶

Gets the sessions of this UidCheckOutput.

Returns: The sessions of this UidCheckOutput.
Return type: vector[char]

acquisitions¶

Gets the acquisitions of this UidCheckOutput.

Returns: The acquisitions of this UidCheckOutput.
Return type: vector[char]

UploadCompleteS3MultipartInput¶

Complete S3 multipart upload payload

class UploadCompleteS3MultipartInput¶

Complete S3 multipart upload payload

providerId¶

Gets the providerId of this UploadCompleteS3MultipartInput.

Returns: The providerId of this UploadCompleteS3MultipartInput.
Return type: char

uuid¶

Gets the uuid of this UploadCompleteS3MultipartInput.

Returns: The uuid of this UploadCompleteS3MultipartInput.
Return type: char

uploadId¶

Gets the uploadId of this UploadCompleteS3MultipartInput.

Returns: The uploadId of this UploadCompleteS3MultipartInput.
Return type: char

eTags¶

Gets the eTags of this UploadCompleteS3MultipartInput.

Returns: The eTags of this UploadCompleteS3MultipartInput.
Return type: vector[char]

UploadCompleteS3MultipartOutput¶

Complete S3 multipart upload response

class UploadCompleteS3MultipartOutput¶

Complete S3 multipart upload response

providerId¶

Gets the providerId of this UploadCompleteS3MultipartOutput.

Returns: The providerId of this UploadCompleteS3MultipartOutput.
Return type: char

uuid¶

Gets the uuid of this UploadCompleteS3MultipartOutput.

Returns: The uuid of this UploadCompleteS3MultipartOutput.
Return type: char

UploadSignedFsFileUploadOutput¶

Signed filesystem file upload response

class UploadSignedFsFileUploadOutput¶

Signed filesystem file upload response

providerId¶

Gets the providerId of this UploadSignedFsFileUploadOutput.

Returns: The providerId of this UploadSignedFsFileUploadOutput.
Return type: char

uuid¶

Gets the uuid of this UploadSignedFsFileUploadOutput.

Returns: The uuid of this UploadSignedFsFileUploadOutput.
Return type: char

UploadSignedUploadUrlInput¶

class UploadSignedUploadUrlInput¶

UploadSignedUploadUrlOutput¶

class UploadSignedUploadUrlOutput¶

UploadTicketOutput¶

The output of the ticket Attributes: ticket: The id of the ticket urls: A mapping of filename to respective url

class UploadTicketOutput¶

The output of the ticket Attributes: ticket: The id of the ticket urls: A mapping of filename to respective url

ticket¶

Gets the ticket of this UploadTicketOutput.

Returns: The ticket of this UploadTicketOutput.
Return type: char

urls¶

Gets the urls of this UploadTicketOutput.

Returns: The urls of this UploadTicketOutput.
Return type: AnyOfUploadTicketOutputUrls

headers¶

Gets the headers of this UploadTicketOutput.

Returns: The headers of this UploadTicketOutput.
Return type: containers.Map[String, char]

UploadTokenOutput¶

class UploadTokenOutput¶

token¶

Gets the token of this UploadTokenOutput.

Returns: The token of this UploadTokenOutput.
Return type: char

User¶

class User¶

id¶

Database ID of a user

Returns: The id of this User.
Return type: char

firstname¶

First name

Returns: The firstname of this User.
Return type: char

lastname¶

Last name

Returns: The lastname of this User.
Return type: char

email¶

Email address

Returns: The email of this User.
Return type: char

avatar¶

Avatar image URL

Returns: The avatar of this User.
Return type: char

avatars¶

Gets the avatars of this User.

Returns: The avatars of this User.
Return type: Avatars

roles¶

Gets the roles of this User.

Returns: The roles of this User.
Return type: vector[char]

root¶

Super admin flag

Returns: The root of this User.
Return type: logical

disabled¶

Gets the disabled of this User.

Returns: The disabled of this User.
Return type: logical

preferences¶

Gets the preferences of this User.

Returns: The preferences of this User.
Return type: UserPreferences

wechat¶

Gets the wechat of this User.

Returns: The wechat of this User.
Return type: UserWechat

firstlogin¶

Gets the firstlogin of this User.

Returns: The firstlogin of this User.
Return type: char

lastlogin¶

Gets the lastlogin of this User.

Returns: The lastlogin of this User.
Return type: char

apiKey¶

Gets the apiKey of this User.

Returns: The apiKey of this User.
Return type: UserApiKey

apiKeys¶

Gets the apiKeys of this User.

Returns: The apiKeys of this User.
Return type: UserApiKey

created¶

Creation time (automatically set)

Returns: The created of this User.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this User.
Return type: datetime

deleted¶

Deleted time (automatically set on delete)

Returns: The deleted of this User.
Return type: datetime

UserApiKey¶

class UserApiKey¶

key¶

Gets the key of this UserApiKey.

Returns: The key of this UserApiKey.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this UserApiKey.
Return type: datetime

lastUsed¶

Gets the lastUsed of this UserApiKey.

Returns: The lastUsed of this UserApiKey.
Return type: datetime

UserInput¶

class UserInput¶

id¶

Gets the id of this UserInput.

Returns: The id of this UserInput.
Return type: char

firstname¶

Gets the firstname of this UserInput.

Returns: The firstname of this UserInput.
Return type: char

lastname¶

Gets the lastname of this UserInput.

Returns: The lastname of this UserInput.
Return type: char

email¶

Gets the email of this UserInput.

Returns: The email of this UserInput.
Return type: char

password¶

Gets the password of this UserInput.

Returns: The password of this UserInput.
Return type: char

roles¶

Gets the roles of this UserInput.

Returns: The roles of this UserInput.
Return type: RoleType

disabled¶

Gets the disabled of this UserInput.

Returns: The disabled of this UserInput.
Return type: logical

avatar¶

Gets the avatar of this UserInput.

Returns: The avatar of this UserInput.
Return type: char

root¶

Gets the root of this UserInput.

Returns: The root of this UserInput.
Return type: logical

UserJobs¶

class UserJobs¶

total¶

Gets the total of this UserJobs.

Returns: The total of this UserJobs.
Return type: integer

jobs¶

Gets the jobs of this UserJobs.

Returns: The jobs of this UserJobs.
Return type: Job

stats¶

Gets the stats of this UserJobs.

Returns: The stats of this UserJobs.
Return type: JobsByState

UserJobsOutput¶

class UserJobsOutput¶

UserOutput¶

class UserOutput¶

UserOutputId¶

class UserOutputId¶

id¶

Gets the id of this UserOutputId.

Returns: The id of this UserOutputId.
Return type: char

UserPreferences¶

class UserPreferences¶

UserWechat¶

class UserWechat¶

ValidationError¶

class ValidationError¶

loc¶

Gets the loc of this ValidationError.

Returns: The loc of this ValidationError.
Return type: vector[char]

msg¶

Gets the msg of this ValidationError.

Returns: The msg of this ValidationError.
Return type: char

type¶

Gets the type of this ValidationError.

Returns: The type of this ValidationError.
Return type: char

Version¶

class Version¶

id¶

Gets the id of this Version.

Returns: The id of this Version.
Return type: char

database¶

Core database version

Returns: The database of this Version.
Return type: integer

release¶

Core release version

Returns: The release of this Version.
Return type: char

flywheelRelease¶

Flywheel installer image tag as informed by the installation recipe.env

Returns: The flywheelRelease of this Version.
Return type: char

cliVersion¶

Compatible CLI version for this server as informed by the installation recipe.env

Returns: The cliVersion of this Version.
Return type: char

appliedChecks¶

Gets the appliedChecks of this Version.

Returns: The appliedChecks of this Version.
Return type: containers.Map

appliedFixes¶

Collection of applied database fixes

Returns: The appliedFixes of this Version.
Return type: containers.Map

VersionOutput¶

class VersionOutput¶

ViewIdOutput¶

class ViewIdOutput¶

id¶

Gets the id of this ViewIdOutput.

Returns: The id of this ViewIdOutput.
Return type: char

ViewOutput¶

Dataview output to client

class ViewOutput¶

Dataview output to client

id¶

Gets the id of this ViewOutput.

Returns: The id of this ViewOutput.
Return type: char

label¶

Gets the label of this ViewOutput.

Returns: The label of this ViewOutput.
Return type: char

description¶

Gets the description of this ViewOutput.

Returns: The description of this ViewOutput.
Return type: char

columns¶

Gets the columns of this ViewOutput.

Returns: The columns of this ViewOutput.
Return type: Column

origin¶

Gets the origin of this ViewOutput.

Returns: The origin of this ViewOutput.
Return type: Origin

fileSpec¶

Gets the fileSpec of this ViewOutput.

Returns: The fileSpec of this ViewOutput.
Return type: containers.Map

includeIds¶

Gets the includeIds of this ViewOutput.

Returns: The includeIds of this ViewOutput.
Return type: logical

includeLabels¶

Gets the includeLabels of this ViewOutput.

Returns: The includeLabels of this ViewOutput.
Return type: logical

errorColumn¶

Gets the errorColumn of this ViewOutput.

Returns: The errorColumn of this ViewOutput.
Return type: logical

missingDataStrategy¶

Gets the missingDataStrategy of this ViewOutput.

Returns: The missingDataStrategy of this ViewOutput.
Return type: DataStrategy

sort¶

Opt out of sorting results by setting value to false

Returns: The sort of this ViewOutput.
Return type: logical

ViewerApp¶

class ViewerApp¶

name¶

Unique name of this application

Returns: The name of this ViewerApp.
Return type: char

url¶

URL that points to the location where the application is hosted

Returns: The url of this ViewerApp.
Return type: char

options¶

General properties passed to the application when it connects to Flywheel

Returns: The options of this ViewerApp.
Return type: containers.Map

files¶

File types that are associated to this application

Returns: The files of this ViewerApp.
Return type: containers.Map[String, containers.Map]

containers¶

Container types that are associated to this application

Returns: The containers of this ViewerApp.
Return type: containers.Map[String, containers.Map]

ViewerAppType¶

An enumeration.

class ViewerAppType¶: An enumeration.

VirusScan¶

class VirusScan¶

state¶

Gets the state of this VirusScan.

Returns: The state of this VirusScan.
Return type: VirusScanState

VirusScanState¶

An enumeration.

class VirusScanState¶: An enumeration.

WorkInProgressFeatures¶

Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

class WorkInProgressFeatures¶: Base class for settings, allowing values to be overridden by environment variables. This is useful in production for secrets you do not wish to save in code, it plays nicely with docker(-compose), Heroku and any 12 factor app design.

Workspace¶

class Workspace¶

id¶

Unique database ID

Returns: The id of this Workspace.
Return type: char

projectId¶

Unique database ID

Returns: The projectId of this Workspace.
Return type: char

label¶

Gets the label of this Workspace.

Returns: The label of this Workspace.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this Workspace.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Workspace.
Return type: datetime

origin¶

Gets the origin of this Workspace.

Returns: The origin of this Workspace.
Return type: WorkspaceOrigin

lastModifiedBy¶

Gets the lastModifiedBy of this Workspace.

Returns: The lastModifiedBy of this Workspace.
Return type: WorkspaceOrigin

externalStorageId¶

Gets the externalStorageId of this Workspace.

Returns: The externalStorageId of this Workspace.
Return type: char

WorkspaceOrigin¶

class WorkspaceOrigin¶

type¶

Gets the type of this WorkspaceOrigin.

Returns: The type of this WorkspaceOrigin.
Return type: char

id¶

Gets the id of this WorkspaceOrigin.

Returns: The id of this WorkspaceOrigin.
Return type: char

WorkspaceOutput¶

class WorkspaceOutput¶

id¶

Unique database ID

Returns: The id of this WorkspaceOutput.
Return type: char

projectId¶

Unique database ID

Returns: The projectId of this WorkspaceOutput.
Return type: char

label¶

Gets the label of this WorkspaceOutput.

Returns: The label of this WorkspaceOutput.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this WorkspaceOutput.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this WorkspaceOutput.
Return type: datetime

origin¶

Gets the origin of this WorkspaceOutput.

Returns: The origin of this WorkspaceOutput.
Return type: WorkspaceOrigin

lastModifiedBy¶

Gets the lastModifiedBy of this WorkspaceOutput.

Returns: The lastModifiedBy of this WorkspaceOutput.
Return type: WorkspaceOrigin

externalStorageId¶

Gets the externalStorageId of this WorkspaceOutput.

Returns: The externalStorageId of this WorkspaceOutput.
Return type: char

WorkspaceUpdate¶

Generic input, should be validated by the correct schema later on

class WorkspaceUpdate¶: Generic input, should be validated by the correct schema later on

ZipfileInfo¶

class ZipfileInfo¶

comment¶

Gets the comment of this ZipfileInfo.

Returns: The comment of this ZipfileInfo.
Return type: vector

members¶

Gets the members of this ZipfileInfo.

Returns: The members of this ZipfileInfo.
Return type: ZipfileMemberInfo

ZipfileMemberInfo¶

class ZipfileMemberInfo¶

path¶

Gets the path of this ZipfileMemberInfo.

Returns: The path of this ZipfileMemberInfo.
Return type: char

size¶

Gets the size of this ZipfileMemberInfo.

Returns: The size of this ZipfileMemberInfo.
Return type: integer

timestamp¶

Gets the timestamp of this ZipfileMemberInfo.

Returns: The timestamp of this ZipfileMemberInfo.
Return type: datetime

comment¶

Gets the comment of this ZipfileMemberInfo.

Returns: The comment of this ZipfileMemberInfo.
Return type: vector