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
-
Accumulator¶
An enumeration.
-
class
Accumulator¶ An enumeration.
Acquisition¶
-
class
Acquisition¶
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
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
-
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
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
Gets the tags of this AcquisitionTemplateOptions.
- Returns
The tags of this AcquisitionTemplateOptions.
- 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
-
AllOfColumnAccumulator¶
If a groupBy is selected, the column will be accumulated to a value using the specified method
-
class
AllOfColumnAccumulator¶ If a groupBy is selected, the column will be accumulated to a value using the specified method
AllOfGearDocumentCategory¶
-
class
AllOfGearDocumentCategory¶
AllOfGearDocumentLegacyInputCategory¶
-
class
AllOfGearDocumentLegacyInputCategory¶
AllOfJobAskResponseJobTransitions¶
-
class
AllOfJobAskResponseJobTransitions¶
AllOfJobListOutputTransitions¶
-
class
AllOfJobListOutputTransitions¶
AllOfJobOutputTransitions¶
-
class
AllOfJobOutputTransitions¶
AllOfMultifactorAccountPreferredChannel¶
-
class
AllOfMultifactorAccountPreferredChannel¶
AllOfStorageStrategyConfigStorageStrategy¶
-
class
AllOfStorageStrategyConfigStorageStrategy¶
Analysis¶
-
class
Analysis¶
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¶ -
inputs¶ The set of inputs that this analysis is based on
- Returns
The inputs of this AnalysisInputLegacy.
- Return type
FileEntry
-
outputs¶ Gets the outputs of this AnalysisInputLegacy.
- Returns
The outputs of this AnalysisInputLegacy.
- Return type
FileEntry
-
description¶ Gets the description of this AnalysisInputLegacy.
- Returns
The description of this AnalysisInputLegacy.
- Return type
char
-
label¶ Application-specific label
- Returns
The label of this AnalysisInputLegacy.
- Return type
char
-
AnalysisListEntry¶
-
class
AnalysisListEntry¶ -
id¶ Unique database ID
- Returns
The id of this AnalysisListEntry.
- Return type
char
-
inputs¶ Gets the inputs of this AnalysisListEntry.
- Returns
The inputs of this AnalysisListEntry.
- Return type
FileEntry
-
files¶ Gets the files of this AnalysisListEntry.
- Returns
The files of this AnalysisListEntry.
- Return type
FileEntry
-
job¶ Unique database ID
- Returns
The job of this AnalysisListEntry.
- Return type
char
-
gearInfo¶ Gets the gearInfo of this AnalysisListEntry.
- Returns
The gearInfo of this AnalysisListEntry.
- Return type
GearInfo
-
notes¶ Gets the notes of this AnalysisListEntry.
- Returns
The notes of this AnalysisListEntry.
- Return type
Note
-
description¶ Gets the description of this AnalysisListEntry.
- Returns
The description of this AnalysisListEntry.
- Return type
char
-
label¶ Application-specific label
- Returns
The label of this AnalysisListEntry.
- Return type
char
-
parent¶ Gets the parent of this AnalysisListEntry.
- Returns
The parent of this AnalysisListEntry.
- Return type
ContainerReference
-
parents¶ Gets the parents of this AnalysisListEntry.
- Returns
The parents of this AnalysisListEntry.
- Return type
ContainerParents
-
created¶ Creation time (automatically set)
- Returns
The created of this AnalysisListEntry.
- Return type
datetime
-
modified¶ Last modification time (automatically updated)
- Returns
The modified of this AnalysisListEntry.
- Return type
datetime
-
revision¶ An incremental document revision number
- Returns
The revision of this AnalysisListEntry.
- Return type
integer
-
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
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
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¶
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
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
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¶
AnyOfAcquisitionListOutputAnalysesItems¶
-
class
AnyOfAcquisitionListOutputAnalysesItems¶
AnyOfAcquisitionOutputAnalysesItems¶
-
class
AnyOfAcquisitionOutputAnalysesItems¶
AnyOfCollectionWithStatsAnalysesItems¶
-
class
AnyOfCollectionWithStatsAnalysesItems¶
AnyOfGearManifestLicense¶
-
class
AnyOfGearManifestLicense¶
AnyOfProjectListOutputAnalysesItems¶
-
class
AnyOfProjectListOutputAnalysesItems¶
AnyOfProjectOutputAnalysesItems¶
-
class
AnyOfProjectOutputAnalysesItems¶
AnyOfSessionInputSubject¶
-
class
AnyOfSessionInputSubject¶
AnyOfSessionListOutputAnalysesItems¶
-
class
AnyOfSessionListOutputAnalysesItems¶
AnyOfSessionModifySubject¶
-
class
AnyOfSessionModifySubject¶
AnyOfSessionOutputAnalysesItems¶
-
class
AnyOfSessionOutputAnalysesItems¶
AnyOfSubjectOutputAnalysesItems¶
-
class
AnyOfSubjectOutputAnalysesItems¶
AnyOfSubjectOutputForListAnalysesItems¶
-
class
AnyOfSubjectOutputForListAnalysesItems¶
AnyOfUploadTicketOutputUrls¶
-
class
AnyOfUploadTicketOutputUrls¶
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
-
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
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]
-
AuthLoginOutput¶
AuthLoginStatus¶
-
class
AuthLoginStatus¶ -
origin¶ Gets the origin of this AuthLoginStatus.
- Returns
The origin of this AuthLoginStatus.
- Return type
ReportAccessLogOrigin
-
userIsAdmin¶ Whether or not the user has admin privileges
- Returns
The userIsAdmin of this AuthLoginStatus.
- Return type
logical
-
isDevice¶ Whether or not the credentials identified a device
- Returns
The isDevice of this AuthLoginStatus.
- Return type
logical
-
roles¶ Gets the roles of this AuthLoginStatus.
- Returns
The roles of this AuthLoginStatus.
- Return type
vector[char]
-
AuthLogoutOutput¶
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
-
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
-
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
char
-
origin¶ Gets the origin of this Batch.
- Returns
The origin of this Batch.
- Return type
JobOrigin
-
config¶ Gets the config of this Batch.
- Returns
The config of this Batch.
- Return type
JobConfig
-
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
-
BatchCancelOutput¶
BatchJobsProposalInput¶
BatchProposal¶
-
class
BatchProposal¶ -
id¶ Unique database ID
- Returns
The id of this BatchProposal.
- Return type
char
-
gearId¶ Gets the gearId of this BatchProposal.
- Returns
The gearId of this BatchProposal.
- Return type
char
-
state¶ Gets the state of this BatchProposal.
- Returns
The state of this BatchProposal.
- Return type
char
-
config¶ Gets the config of this BatchProposal.
- Returns
The config of this BatchProposal.
- Return type
JobConfig
-
origin¶ Gets the origin of this BatchProposal.
- Returns
The origin of this BatchProposal.
- Return type
JobOrigin
-
proposal¶ Gets the proposal of this BatchProposal.
- Returns
The proposal of this BatchProposal.
- Return type
BatchProposalDetail
-
ambiguous¶ Gets the ambiguous of this BatchProposal.
- Returns
The ambiguous of this BatchProposal.
- Return type
ContainerOutputWithFiles
-
matched¶ Gets the matched of this BatchProposal.
- Returns
The matched of this BatchProposal.
- Return type
ContainerOutputWithFiles
-
notMatched¶ Gets the notMatched of this BatchProposal.
- Returns
The notMatched of this BatchProposal.
- Return type
ContainerOutputWithFiles
-
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 BatchProposal.
- Return type
char
-
improperPermissions¶ Gets the improperPermissions of this BatchProposal.
- Returns
The improperPermissions of this BatchProposal.
- Return type
vector[char]
-
created¶ Creation time (automatically set)
- Returns
The created of this BatchProposal.
- Return type
datetime
-
modified¶ Last modification time (automatically updated)
- Returns
The modified of this BatchProposal.
- Return type
datetime
-
BatchProposalDetail¶
BatchProposalInput¶
-
class
BatchProposalInput¶ -
gearId¶ Gets the gearId of this BatchProposalInput.
- Returns
The gearId of this BatchProposalInput.
- Return type
char
-
config¶ Gets the config of this BatchProposalInput.
- Returns
The config of this BatchProposalInput.
- Return type
JobConfig
Array of application-specific tags
- Returns
The tags of this BatchProposalInput.
- Return type
vector[char]
-
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 BatchProposalInput.
- Return type
char
-
analysis¶ Gets the analysis of this BatchProposalInput.
- Returns
The analysis of this BatchProposalInput.
- Return type
AnalysisInput
-
computeProviderId¶ Unique database ID
- Returns
The computeProviderId of this BatchProposalInput.
- Return type
char
-
targets¶ Gets the targets of this BatchProposalInput.
- Returns
The targets of this BatchProposalInput.
- Return type
ContainerReference
-
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
-
BodyRegion¶
An enumeration.
-
class
BodyRegion¶ An enumeration.
BulkMoveSessions¶
-
class
BulkMoveSessions¶ -
destinationContainerType¶ The type of destination container
- Returns
The destinationContainerType of this BulkMoveSessions.
- Return type
char
-
sources¶ Array of continer Ids that you would like to bulk move
- Returns
The sources of this BulkMoveSessions.
- Return type
vector[char]
-
destinations¶ Array with a single continer Id of the destination container’s Id
- Returns
The destinations of this BulkMoveSessions.
- Return type
vector[char]
-
conflictMode¶ How to handle conflicts. Required even if no conflicts are found
- Returns
The conflictMode of this BulkMoveSessions.
- Return type
char
-
CallbacksVirusScanInput¶
Virus scan result
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
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.
ClassificationAddDelete¶
-
class
ClassificationAddDelete¶ -
add¶ Gets the add of this ClassificationAddDelete.
- Returns
The add of this ClassificationAddDelete.
- Return type
CommonClassification
-
delete¶ Gets the delete of this ClassificationAddDelete.
- Returns
The delete of this ClassificationAddDelete.
- Return type
CommonClassification
-
ClassificationReplace¶
-
class
ClassificationReplace¶ -
modality¶ The type of instrument that originated the file (e.g. MR, CT, …)
- Returns
The modality of this ClassificationReplace.
- Return type
char
-
replace¶ Gets the replace of this ClassificationReplace.
- Returns
The replace of this ClassificationReplace.
- Return type
containers.Map
-
ClassificationUpdateInput¶
Helper endpoint for editing an object’s classification key
-
class
ClassificationUpdateInput¶ Helper endpoint for editing an object’s classification key
-
add¶ Gets the add of this ClassificationUpdateInput.
- Returns
The add of this ClassificationUpdateInput.
- Return type
CommonClassification
-
delete¶ Gets the delete of this ClassificationUpdateInput.
- Returns
The delete of this ClassificationUpdateInput.
- Return type
CommonClassification
-
modality¶ The type of instrument that originated the file (e.g. MR, CT, …)
- Returns
The modality of this ClassificationUpdateInput.
- Return type
char
-
replace¶ Gets the replace of this ClassificationUpdateInput.
- Returns
The replace of this ClassificationUpdateInput.
- Return type
containers.Map
-
Cohort¶
An enumeration.
-
class
Cohort¶ An enumeration.
Collection¶
-
class
Collection¶
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¶
CollectionNodeLevel¶
An enumeration.
-
class
CollectionNodeLevel¶ An enumeration.
CollectionOperation¶
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
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
-
containerType¶ Gets the containerType of this CollectionOutput.
- Returns
The containerType of this CollectionOutput.
- Return type
char
-
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
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
-
containerType¶ Gets the containerType of this CollectionWithStats.
- Returns
The containerType of this CollectionWithStats.
- Return type
char
-
Column¶
-
class
Column¶ -
src¶ Gets the src of this Column.
- Returns
The src of this Column.
- Return type
char
-
dst¶ Gets the dst of this Column.
- Returns
The dst of this Column.
- Return type
char
-
type¶ Gets the type of this Column.
- Returns
The type of this Column.
- Return type
TypeStr
-
expr¶ Gets the expr of this Column.
- Returns
The expr of this Column.
- Return type
char
-
accumulator¶ If a groupBy is selected, the column will be accumulated to a value using the specified method
- Returns
The accumulator of this Column.
- Return type
AllOfColumnAccumulator
-
CommonClassification¶
-
class
CommonClassification¶
CommonDeletedCount¶
CommonEditions¶
CommonInfo¶
Free-form information storage
-
class
CommonInfo¶ Free-form information storage
CommonJoinOrigins¶
-
class
CommonJoinOrigins¶ -
device¶ Gets the device of this CommonJoinOrigins.
- Returns
The device of this CommonJoinOrigins.
- Return type
containers.Map
-
job¶ Gets the job of this CommonJoinOrigins.
- Returns
The job of this CommonJoinOrigins.
- Return type
containers.Map
-
user¶ Gets the user of this CommonJoinOrigins.
- Returns
The user of this CommonJoinOrigins.
- Return type
containers.Map
-
CommonKey¶
CommonModifiedCount¶
CommonObjectCreated¶
CommonProjectSettings¶
-
class
CommonProjectSettings¶ -
externalRoutingId¶ Gets the externalRoutingId of this CommonProjectSettings.
- Returns
The externalRoutingId of this CommonProjectSettings.
- Return type
containers.Map
-
forms¶ Gets the forms of this CommonProjectSettings.
- Returns
The forms of this CommonProjectSettings.
- Return type
containers.Map
-
viewerApps¶ Gets the viewerApps of this CommonProjectSettings.
- Returns
The viewerApps of this CommonProjectSettings.
- Return type
containers.Map
-
deidProfile¶ Gets the deidProfile of this CommonProjectSettings.
- Returns
The deidProfile of this CommonProjectSettings.
- Return type
containers.Map
-
sharing¶ Gets the sharing of this CommonProjectSettings.
- Returns
The sharing of this CommonProjectSettings.
- Return type
containers.Map
-
CommonSettings¶
-
class
CommonSettings¶ -
externalRoutingId¶ Gets the externalRoutingId of this CommonSettings.
- Returns
The externalRoutingId of this CommonSettings.
- Return type
containers.Map
-
forms¶ Gets the forms of this CommonSettings.
- Returns
The forms of this CommonSettings.
- Return type
containers.Map
-
viewerApps¶ Gets the viewerApps of this CommonSettings.
- Returns
The viewerApps of this CommonSettings.
- Return type
containers.Map
-
deidProfile¶ Gets the deidProfile of this CommonSettings.
- Returns
The deidProfile of this CommonSettings.
- Return type
containers.Map
-
ConfigAuthOutput¶
-
class
ConfigAuthOutput¶ -
verifyEndpoint¶ Gets the verifyEndpoint of this ConfigAuthOutput.
- Returns
The verifyEndpoint of this ConfigAuthOutput.
- Return type
char
-
clientId¶ Gets the clientId of this ConfigAuthOutput.
- Returns
The clientId of this ConfigAuthOutput.
- Return type
char
-
clientSecret¶ Gets the clientSecret of this ConfigAuthOutput.
- Returns
The clientSecret of this ConfigAuthOutput.
- Return type
char
-
authEndpoint¶ Gets the authEndpoint of this ConfigAuthOutput.
- Returns
The authEndpoint of this ConfigAuthOutput.
- Return type
char
-
refreshEndpoint¶ Gets the refreshEndpoint of this ConfigAuthOutput.
- Returns
The refreshEndpoint of this ConfigAuthOutput.
- Return type
char
-
ConfigFeatureMap¶
A map of supported features
-
class
ConfigFeatureMap¶ A map of supported features
-
signedUrl¶ Whether or not this server supports signed url uploads
- Returns
The signedUrl of this ConfigFeatureMap.
- Return type
logical
-
jobTickets¶ Whether or not this server supports new job tickets
- Returns
The jobTickets of this ConfigFeatureMap.
- Return type
logical
-
jobAsk¶ Whether or not this server supports the /jobs/ask endpoint
- Returns
The jobAsk of this ConfigFeatureMap.
- Return type
logical
-
multiproject¶ Whether or not this server has the multiproject feature enabled
- Returns
The multiproject of this ConfigFeatureMap.
- Return type
logical
-
healthcareApi¶ Google Healthcare API integration
- Returns
The healthcareApi of this ConfigFeatureMap.
- Return type
logical
-
crawler¶ Whether or not this server uses crawler as the search driver
- Returns
The crawler of this ConfigFeatureMap.
- Return type
logical
-
taskManagerDataViews¶ Whether or not this server uses task manager for data views
- Returns
The taskManagerDataViews of this ConfigFeatureMap.
- Return type
logical
-
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
Features
-
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¶ -
site¶ Gets the site of this ConfigOutput.
- Returns
The site of this ConfigOutput.
- Return type
ConfigSiteConfigOutput
-
modified¶ Gets the modified of this ConfigOutput.
- Returns
The modified of this ConfigOutput.
- Return type
char
-
auth¶ Gets the auth of this ConfigOutput.
- Returns
The auth of this ConfigOutput.
- Return type
ConfigAuthOutput
-
created¶ Gets the created of this ConfigOutput.
- Returns
The created of this ConfigOutput.
- Return type
char
-
signedUrl¶ Whether or not this server supports signed url uploads
- Returns
The signedUrl of this ConfigOutput.
- Return type
logical
-
features¶ Gets the features of this ConfigOutput.
- Returns
The features of this ConfigOutput.
- Return type
ConfigFeatureMap
-
ConfigSiteConfigOutput¶
-
class
ConfigSiteConfigOutput¶ -
centralUrl¶ Gets the centralUrl of this ConfigSiteConfigOutput.
- Returns
The centralUrl of this ConfigSiteConfigOutput.
- Return type
char
-
sslCert¶ Gets the sslCert of this ConfigSiteConfigOutput.
- Returns
The sslCert of this ConfigSiteConfigOutput.
- Return type
char
-
apiUrl¶ Gets the apiUrl of this ConfigSiteConfigOutput.
- Returns
The apiUrl of this ConfigSiteConfigOutput.
- Return type
char
-
registered¶ Gets the registered of this ConfigSiteConfigOutput.
- Returns
The registered of this ConfigSiteConfigOutput.
- Return type
logical
-
id¶ Gets the id of this ConfigSiteConfigOutput.
- Returns
The id of this ConfigSiteConfigOutput.
- Return type
char
-
name¶ Gets the name of this ConfigSiteConfigOutput.
- Returns
The name of this ConfigSiteConfigOutput.
- Return type
char
-
ConfigSiteSettings¶
-
class
ConfigSiteSettings¶ -
created¶ Gets the created of this ConfigSiteSettings.
- Returns
The created of this ConfigSiteSettings.
- Return type
char
-
modified¶ Gets the modified of this ConfigSiteSettings.
- Returns
The modified of this ConfigSiteSettings.
- Return type
char
-
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 ConfigSiteSettings.
- Return type
vector[char]
-
providers¶ Gets the providers of this ConfigSiteSettings.
- Returns
The providers of this ConfigSiteSettings.
- Return type
ProviderLinks
-
viewerApps¶ A list of viewer app associations for files and container
- Returns
The viewerApps of this ConfigSiteSettings.
- Return type
ViewerApp
-
ldapSync¶ Gets the ldapSync of this ConfigSiteSettings.
- Returns
The ldapSync of this ConfigSiteSettings.
- Return type
LdapSync
-
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
-
ContainerAcquisitionOutput¶
-
class
ContainerAcquisitionOutput¶
ContainerAnalysisOutput¶
-
class
ContainerAnalysisOutput¶
ContainerCollectionOutput¶
-
class
ContainerCollectionOutput¶
ContainerDeleteReason¶
An enumeration.
-
class
ContainerDeleteReason¶ An enumeration.
ContainerFileOutput¶
-
class
ContainerFileOutput¶ -
id¶ Gets the id of this ContainerFileOutput.
- Returns
The id of this ContainerFileOutput.
- Return type
char
-
fileId¶ Unique database ID
- Returns
The fileId of this ContainerFileOutput.
- Return type
char
-
version¶ Version of the file
- Returns
The version of this ContainerFileOutput.
- Return type
integer
-
name¶ The name of the file on disk
- Returns
The name of this ContainerFileOutput.
- Return type
char
-
type¶ A descriptive file type (e.g. dicom, image, document, …)
- Returns
The type of this ContainerFileOutput.
- Return type
char
-
mimetype¶ A MIME Content-Type of the file
- Returns
The mimetype of this ContainerFileOutput.
- Return type
char
-
modality¶ The type of instrument that originated the file (e.g. MR, CT, …)
- Returns
The modality of this ContainerFileOutput.
- Return type
char
-
deidLogId¶ The UUID of the de-id log
- Returns
The deidLogId of this ContainerFileOutput.
- Return type
char
-
classification¶ Gets the classification of this ContainerFileOutput.
- Returns
The classification of this ContainerFileOutput.
- Return type
CommonClassification
Array of application-specific tags
- Returns
The tags of this ContainerFileOutput.
- Return type
vector[char]
-
info¶ Gets the info of this ContainerFileOutput.
- Returns
The info of this ContainerFileOutput.
- Return type
CommonInfo
-
origin¶ Gets the origin of this ContainerFileOutput.
- Returns
The origin of this ContainerFileOutput.
- Return type
FileOrigin
-
hash¶ Cryptographic hash of the file
- Returns
The hash of this ContainerFileOutput.
- Return type
char
-
parents¶ Gets the parents of this ContainerFileOutput.
- Returns
The parents of this ContainerFileOutput.
- Return type
ContainerParents
-
parentRef¶ Gets the parentRef of this ContainerFileOutput.
- Returns
The parentRef of this ContainerFileOutput.
- Return type
ContainerReference
-
created¶ Creation time (automatically set)
- Returns
The created of this ContainerFileOutput.
- Return type
datetime
-
modified¶ Last modification time (automatically updated)
- Returns
The modified of this ContainerFileOutput.
- Return type
datetime
-
replaced¶ Last replaced time (automatically updated)
- Returns
The replaced of this ContainerFileOutput.
- Return type
datetime
-
size¶ Size of the file, in bytes
- Returns
The size of this ContainerFileOutput.
- Return type
integer
-
infoExists¶ Gets the infoExists of this ContainerFileOutput.
- Returns
The infoExists of this ContainerFileOutput.
- Return type
logical
-
zipMemberCount¶ Number of entries in the zip archive
- Returns
The zipMemberCount of this ContainerFileOutput.
- Return type
integer
-
ContainerGroupOutput¶
-
class
ContainerGroupOutput¶
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
-
ContainerNewOutput¶
ContainerOutput¶
Generic container output
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
-
ContainerProjectOutput¶
-
class
ContainerProjectOutput¶
ContainerProjectParents¶
ContainerReference¶
A reference to an individual container, by type and id
ContainerSessionOutput¶
-
class
ContainerSessionOutput¶
ContainerSessionParents¶
-
class
ContainerSessionParents¶ -
project¶ Unique database ID
- Returns
The project of this ContainerSessionParents.
- Return type
char
-
group¶ Unique database ID
- Returns
The group of this ContainerSessionParents.
- Return type
char
-
subject¶ Unique database ID
- Returns
The subject of this ContainerSessionParents.
- Return type
char
-
ContainerSubjectOutput¶
-
class
ContainerSubjectOutput¶
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¶
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
-
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
-
id¶ Unique database ID
- Returns
The id of this DataView.
- Return type
char
-
origin¶ Gets the origin of this DataView.
- Returns
The origin of this DataView.
- Return type
Origin
-
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
char
-
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¶
DataViewGroupByColumn¶
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
-
DataViewSaveDataViewInput¶
A request to save data-view data to a container
-
class
DataViewSaveDataViewInput¶ A request to save data-view data to a container
-
view¶ Gets the view of this DataViewSaveDataViewInput.
- Returns
The view of this DataViewSaveDataViewInput.
- Return type
DataView
-
viewId¶ Unique database ID
- Returns
The viewId of this DataViewSaveDataViewInput.
- Return type
char
-
containerType¶ The type of container (e.g. session)
- Returns
The containerType of this DataViewSaveDataViewInput.
- Return type
char
-
containerId¶ Unique database ID
- Returns
The containerId of this DataViewSaveDataViewInput.
- Return type
char
-
filename¶ The name of the file on disk
- Returns
The filename of this DataViewSaveDataViewInput.
- Return type
char
-
description¶ Gets the description of this DataViewSaveDataViewInput.
- Returns
The description of this DataViewSaveDataViewInput.
- Return type
char
-
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¶
Device¶
-
class
Device¶ -
id¶ Unique database ID
- Returns
The id of this Device.
- Return type
char
-
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
-
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
-
key¶ Gets the key of this Device.
- Returns
The key of this Device.
- Return type
char
-
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
-
interval¶ Gets the interval of this Device.
- Returns
The interval of this Device.
- Return type
integer
-
lastSeen¶ Gets the lastSeen of this Device.
- Returns
The lastSeen of this Device.
- Return type
datetime
-
disabled¶ Gets the disabled of this Device.
- Returns
The disabled of this Device.
- Return type
logical
-
storageConfig¶ Gets the storageConfig of this Device.
- Returns
The storageConfig of this Device.
- Return type
containers.Map
-
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
-
DeviceStatus¶
-
class
DeviceStatus¶
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
char
-
DimseProjectInput¶
DimseProjectOutput¶
-
class
DimseProjectOutput¶ -
id¶ Unique database ID
- Returns
The id of this DimseProjectOutput.
- Return type
char
-
created¶ Gets the created of this DimseProjectOutput.
- Returns
The created of this DimseProjectOutput.
- Return type
datetime
-
creator¶ Database ID of a user
- Returns
The creator of this DimseProjectOutput.
- Return type
char
-
aet¶ DICOM Application Entity Title
- Returns
The aet of this DimseProjectOutput.
- Return type
char
-
projectId¶ Unique database ID
- Returns
The projectId of this DimseProjectOutput.
- Return type
char
-
host¶ DICOM service hostname or IP
- Returns
The host of this DimseProjectOutput.
- Return type
char
-
port¶ DICOM service port number
- Returns
The port of this DimseProjectOutput.
- Return type
integer
-
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¶ 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¶ 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]
-
DownloadInput¶
Specifies a set of files to download
-
class
DownloadInput¶ Specifies a set of files to download
-
optional¶ Gets the optional of this DownloadInput.
- Returns
The optional of this DownloadInput.
- Return type
logical
-
nodes¶ Gets the nodes of this DownloadInput.
- Returns
The nodes of this DownloadInput.
- Return type
DownloadNode
-
containerFilters¶ Gets the containerFilters of this DownloadInput.
- Returns
The containerFilters of this DownloadInput.
- Return type
DownloadContainerFilter
-
filters¶ Gets the filters of this DownloadInput.
- Returns
The filters of this DownloadInput.
- Return type
DownloadFilter
-
DownloadNode¶
A reference to a container
DownloadTicket¶
A ticket for non-authenticated download of files
DownloadTicketWithSummary¶
A ticket for non-authenticated download of files, including a summary
-
class
DownloadTicketWithSummary¶ A ticket for non-authenticated download of files, including a summary
-
ticket¶ The ticket to use to perform the actual download
- Returns
The ticket of this DownloadTicketWithSummary.
- Return type
char
-
fileCnt¶ The number of files that will be included in the download
- Returns
The fileCnt of this DownloadTicketWithSummary.
- Return type
integer
-
size¶ An estimated total number of bytes that will be downloaded
- Returns
The size of this DownloadTicketWithSummary.
- Return type
integer
-
Edition¶
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
ApiKeyOutput
-
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
-
EgressProviderId¶
EnginemetadataLabelUploadInput¶
-
class
EnginemetadataLabelUploadInput¶ -
group¶ Gets the group of this EnginemetadataLabelUploadInput.
- Returns
The group of this EnginemetadataLabelUploadInput.
- Return type
GroupMetadataInput
-
project¶ Gets the project of this EnginemetadataLabelUploadInput.
- Returns
The project of this EnginemetadataLabelUploadInput.
- Return type
ProjectMetadataInput
-
session¶ Gets the session of this EnginemetadataLabelUploadInput.
- Returns
The session of this EnginemetadataLabelUploadInput.
- Return type
SessionMetadataInput
-
acquisition¶ Gets the acquisition of this EnginemetadataLabelUploadInput.
- Returns
The acquisition of this EnginemetadataLabelUploadInput.
- Return type
EnginemetadataUploadAcquisitionMetadataInput
-
EnginemetadataUidMatchUploadInput¶
-
class
EnginemetadataUidMatchUploadInput¶ -
project¶ Gets the project of this EnginemetadataUidMatchUploadInput.
- Returns
The project of this EnginemetadataUidMatchUploadInput.
- Return type
ProjectMetadataInput
-
session¶ Gets the session of this EnginemetadataUidMatchUploadInput.
- Returns
The session of this EnginemetadataUidMatchUploadInput.
- Return type
SessionMetadataInput
-
acquisition¶ Gets the acquisition of this EnginemetadataUidMatchUploadInput.
- Returns
The acquisition of this EnginemetadataUidMatchUploadInput.
- Return type
EnginemetadataUploadAcquisitionMetadataInput
-
EnginemetadataUidUploadInput¶
-
class
EnginemetadataUidUploadInput¶ -
group¶ Gets the group of this EnginemetadataUidUploadInput.
- Returns
The group of this EnginemetadataUidUploadInput.
- Return type
GroupMetadataInput
-
project¶ Gets the project of this EnginemetadataUidUploadInput.
- Returns
The project of this EnginemetadataUidUploadInput.
- Return type
ProjectMetadataInput
-
session¶ Gets the session of this EnginemetadataUidUploadInput.
- Returns
The session of this EnginemetadataUidUploadInput.
- Return type
SessionMetadataInput
-
acquisition¶ Gets the acquisition of this EnginemetadataUidUploadInput.
- Returns
The acquisition of this EnginemetadataUidUploadInput.
- Return type
EnginemetadataUploadAcquisitionMetadataInput
-
EnginemetadataUploadAcquisitionMetadataInput¶
-
class
EnginemetadataUploadAcquisitionMetadataInput¶ -
label¶ Gets the label of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The label of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
char
-
info¶ Gets the info of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The info of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
containers.Map
-
uid¶ Gets the uid of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The uid of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
char
-
timestamp¶ Gets the timestamp of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The timestamp of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
datetime
-
timezone¶ Gets the timezone of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The timezone of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
char
-
files¶ Gets the files of this EnginemetadataUploadAcquisitionMetadataInput.
- Returns
The files of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
FileEntry
Array of application-specific tags
- Returns
The tags of this EnginemetadataUploadAcquisitionMetadataInput.
- Return type
vector[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
-
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
-
changeLogging¶ Gets the changeLogging of this Features.
- Returns
The changeLogging 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
-
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
-
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
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
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
-
userJobs¶ Gets the userJobs of this Features.
- Returns
The userJobs 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
-
enhancedApiKey¶ Gets the enhancedApiKey of this Features.
- Returns
The enhancedApiKey of this Features.
- Return type
logical
-
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
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
-
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
-
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]]
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
FileMoveInput¶
File move payload
-
class
FileMoveInput¶ File move payload
-
containerReference¶ Gets the containerReference of this FileMoveInput.
- Returns
The containerReference of this FileMoveInput.
- Return type
ContainerReference
-
name¶ The name of the file on disk
- 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
-
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]]
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
-
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
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¶
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.
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¶
A zip member description
-
class
FileZipEntry¶ A zip member description
-
comment¶ Gets the comment of this FileZipEntry.
- Returns
The comment of this FileZipEntry.
- Return type
char
-
path¶ Gets the path of this FileZipEntry.
- Returns
The path of this FileZipEntry.
- Return type
char
-
timestamp¶ Gets the timestamp of this FileZipEntry.
- Returns
The timestamp of this FileZipEntry.
- Return type
datetime
-
size¶ Size of the file, in bytes
- Returns
The size of this FileZipEntry.
- Return type
integer
-
FileZipInfo¶
Zip file information
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
Gear¶
Gear manifest
-
class
Gear¶ Gear manifest
The author of this gear.
- Returns
The author of this Gear.
- Return type
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
-
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
GearContextLookup¶
Describes a gear input
-
class
GearContextLookup¶ Describes a gear input
GearContextLookupItem¶
-
class
GearContextLookupItem¶ -
found¶ Was the context value found?
- Returns
The found of this GearContextLookupItem.
- Return type
logical
-
containerType¶ The type of container (e.g. session)
- Returns
The containerType of this GearContextLookupItem.
- Return type
char
-
id¶ Id of the container where the context value was found, if any.
- Returns
The id of this GearContextLookupItem.
- Return type
char
-
label¶ Label of the container where the context value was found, if any.
- Returns
The label of this GearContextLookupItem.
- Return type
char
-
value¶ The value if found. Valid IFF found is true. Can be null.
- Returns
The value of this GearContextLookupItem.
- Return type
containers.Map
-
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¶
A full gear description, including manifest and exchange information
-
class
GearDoc¶ A full gear description, including manifest and exchange information
-
id¶ Unique database ID
- Returns
The id of this GearDoc.
- Return type
char
-
category¶ The gear category
- Returns
The category of this GearDoc.
- Return type
char
-
gear¶ Gets the gear of this GearDoc.
- Returns
The gear of this GearDoc.
- Return type
Gear
-
exchange¶ Gets the exchange of this GearDoc.
- Returns
The exchange of this GearDoc.
- Return type
GearExchange
-
created¶ Creation time (automatically set)
- Returns
The created of this GearDoc.
- Return type
datetime
-
modified¶ Last modification time (automatically updated)
- Returns
The modified of this GearDoc.
- Return type
datetime
-
disabled¶ The time the gear was disabled (automatically set)
- Returns
The disabled of this GearDoc.
- Return type
datetime
-
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
-
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
-
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
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
AnyOfGearManifestLicense
-
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
-
GearPermissions¶
GearPermissionsInput¶
GearPermissionsType¶
An enumeration.
-
class
GearPermissionsType¶ An enumeration.
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
FixedInput
-
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
FixedInput
-
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
-
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¶
-
class
GearSeries¶ -
id¶ Unique database ID
- 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
-
isRestricted¶ Gets the isRestricted of this GearSeries.
- Returns
The isRestricted of this GearSeries.
- Return type
logical
-
permissions¶ Gets the permissions of this GearSeries.
- Returns
The permissions of this GearSeries.
- Return type
GearPermissions
-
created¶ Creation time (automatically set)
- Returns
The created of this GearSeries.
- Return type
datetime
-
modified¶ Last modification time (automatically updated)
- Returns
The modified of this GearSeries.
- Return type
datetime
-
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
-
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
-
Group¶
-
class
Group¶
GroupBy¶
GroupByColumn¶
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
-
GroupMetadataInput¶
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
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
-
GroupRole¶
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¶
HeaderFeature¶
An enum for all the features routers accept.
-
class
HeaderFeature¶ An enum for all the features routers accept.
InfoAddRemove¶
Indicates properties to update and a list of properties to remove
-
class
InfoAddRemove¶ Indicates properties to update and a list of properties to remove
-
set¶ Key/value pairs of properties to set
- Returns
The set of this InfoAddRemove.
- Return type
containers.Map
-
delete¶ A list of properties to remove
- Returns
The delete of this InfoAddRemove.
- Return type
vector[char]
-
InfoReplace¶
Indicates that info should be replaced with the properties in this document
InfoUpdateInput¶
Helper endpoint for editing an object’s info key
-
class
InfoUpdateInput¶ Helper endpoint for editing an object’s info key
-
set¶ Key/value pairs of properties to set
- Returns
The set of this InfoUpdateInput.
- Return type
containers.Map
-
delete¶ A list of properties to remove
- Returns
The delete of this InfoUpdateInput.
- Return type
vector[char]
-
replace¶ The new set of properties for the info
- Returns
The replace of this InfoUpdateInput.
- Return type
containers.Map
-
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
-
InlineResponse200¶
InlineResponse2001¶
InlineResponse2002¶
InlineResponse2003¶
-
class
InlineResponse2003¶ -
id¶ Database ID of a user
- Returns
The id of this InlineResponse2003.
- Return type
char
-
roleIds¶ Gets the roleIds of this InlineResponse2003.
- Returns
The roleIds of this InlineResponse2003.
- Return type
vector[char]
-
access¶ Gets the access of this InlineResponse2003.
- Returns
The access of this InlineResponse2003.
- Return type
char
-
InlineResponse2005¶
InputJob¶
-
class
InputJob¶ -
attempt¶ Gets the attempt of this InputJob.
- Returns
The attempt of this InputJob.
- Return type
integer
-
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
-
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
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
-
InsertedId¶
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
Gets the tags of this Job.
- Returns
The tags of this Job.
- Return type
vector[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
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¶
Describes how a job should be transitioned after outputs have been uploaded
-
class
JobAsk¶ Describes how a job should be transitioned after outputs have been uploaded
-
whitelist¶ Gets the whitelist of this JobAsk.
- Returns
The whitelist of this JobAsk.
- Return type
JobConfigInputs
-
blacklist¶ Gets the blacklist of this JobAsk.
- Returns
The blacklist of this JobAsk.
- Return type
JobConfigInputs
-
capabilities¶ A set of capabilities that must be a superset of matched jobs
- 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
JobAskReturn
-
jobStates¶ List of job states to filter to when peeking and getting counts by state
- Returns
The jobStates of this JobAsk.
- Return type
vector[char]
-
JobAskResponse¶
Return based on job-ask-return type
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 if the gear rule 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 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 if the gear rule 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 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
-
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
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
-
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
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¶
Which sorts of return values to receive from ask
-
class
JobAskReturn¶ Which sorts of return values to receive from ask
-
jobs¶ Gets the jobs of this JobAskReturn.
- Returns
The jobs of this JobAskReturn.
- Return type
integer
-
peek¶ Gets the peek of this JobAskReturn.
- Returns
The peek of this JobAskReturn.
- Return type
logical
-
states¶ Gets the states of this JobAskReturn.
- Returns
The states of this JobAskReturn.
- Return type
logical
-
encoded¶ Gets the encoded of this JobAskReturn.
- Returns
The encoded of this JobAskReturn.
- Return type
logical
-
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¶
Object describing the input for counting jobs that match the given query for a given state
-
class
JobAskState¶ Object describing the input for counting jobs that match the given query for a given state
-
whitelist¶ Gets the whitelist of this JobAskState.
- Returns
The whitelist of this JobAskState.
- Return type
JobConfigInputs
-
blacklist¶ Gets the blacklist of this JobAskState.
- Returns
The blacklist of this JobAskState.
- Return type
JobConfigInputs
-
capabilities¶ A set of capabilities that must be a superset of matched jobs
- Returns
The capabilities of this JobAskState.
- Return type
vector[char]
-
limit¶ Gets the limit of this JobAskState.
- Returns
The limit of this JobAskState.
- Return type
integer
-
JobAskStateResponse¶
Return number of jobs for a given state and query
JobCompletionInput¶
Describes how a job should be transitioned after outputs have been uploaded
-
class
JobCompletionInput¶ Describes how a job should be transitioned after outputs have been uploaded
-
success¶ Whether or not the job succeeded
- Returns
The success of this JobCompletionInput.
- Return type
logical
-
elapsed¶ The elapsed time of the job, in seconds
- Returns
The elapsed of this JobCompletionInput.
- Return type
integer
-
failureReason¶ An optional suspected reason for job failure
- Returns
The failureReason of this JobCompletionInput.
- Return type
char
-
profile¶ Gets the profile of this JobCompletionInput.
- Returns
The profile of this JobCompletionInput.
- Return type
JobProfileInput
-
JobCompletionTicket¶
A ticket for uploading files and completing a job
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¶ -
group¶ Gets the group of this JobConfigInputs.
- Returns
The group of this JobConfigInputs.
- Return type
vector[char]
-
gearName¶ Gets the gearName of this JobConfigInputs.
- Returns
The gearName of this JobConfigInputs.
- Return type
vector[char]
-
tag¶ Gets the tag of this JobConfigInputs.
- Returns
The tag of this JobConfigInputs.
- Return type
vector[char]
-
JobConfigOutput¶
-
class
JobConfigOutput¶ -
config¶ Gets the config of this JobConfigOutput.
- Returns
The config of this JobConfigOutput.
- Return type
JobConfig
-
destination¶ Gets the destination of this JobConfigOutput.
- Returns
The destination of this JobConfigOutput.
- Return type
JobDestination
-
inputs¶ Gets the inputs of this JobConfigOutput.
- Returns
The inputs of this JobConfigOutput.
- Return type
JobConfigInputs
-
JobContainerDetail¶
JobDestination¶
JobDetail¶
-
class
JobDetail¶ -
id¶ Unique database ID
- Returns
The id of this JobDetail.
- Return type
char
-
origin¶ Gets the origin of this JobDetail.
- Returns
The origin of this JobDetail.
- Return type
JobOrigin
-
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
-
parentInfo¶ Gets the parentInfo of this JobDetail.
- Returns
The parentInfo of this JobDetail.
- Return type
JobDetailParentInfo
-
previousJobId¶ Gets the previousJobId of this JobDetail.
- Returns
The previousJobId of this JobDetail.
- Return type
char
-
inputs¶ Gets the inputs of this JobDetail.
- Returns
The inputs of this JobDetail.
- Return type
JobDetailInputsObject
-
outputs¶ Gets the outputs of this JobDetail.
- Returns
The outputs of this JobDetail.
- Return type
JobDetailFileEntry
-
destination¶ Gets the destination of this JobDetail.
- Returns
The destination of this JobDetail.
- Return type
JobDestination
Gets the tags of this JobDetail.
- Returns
The tags of this JobDetail.
- Return type
vector[char]
-
state¶ Gets the state of this JobDetail.
- Returns
The state of this JobDetail.
- Return type
char
-
attempt¶ Gets the attempt of this JobDetail.
- Returns
The attempt of this JobDetail.
- Return type
integer
-
created¶ Creation time (automatically set)
- Returns
The created of this JobDetail.
- Return type
datetime
-
modified¶ Last modification time (automatically updated)
- Returns
The modified of this JobDetail.
- Return type
datetime
-
retried¶ Retried time (automatically set)
- Returns
The retried of this JobDetail.
- Return type
datetime
-
config¶ Gets the config of this JobDetail.
- Returns
The config of this JobDetail.
- Return type
JobConfig
-
request¶ Gets the request of this JobDetail.
- Returns
The request of this JobDetail.
- Return type
JobRequest
-
JobDetailContainer¶
JobDetailFileEntry¶
JobDetailInputsObject¶
-
class
JobDetailInputsObject¶
JobDetailParentInfo¶
-
class
JobDetailParentInfo¶ -
group¶ Gets the group of this JobDetailParentInfo.
- Returns
The group of this JobDetailParentInfo.
- Return type
JobContainerDetail
-
project¶ Gets the project of this JobDetailParentInfo.
- Returns
The project of this JobDetailParentInfo.
- Return type
JobContainerDetail
-
subject¶ Gets the subject of this JobDetailParentInfo.
- Returns
The subject of this JobDetailParentInfo.
- Return type
JobContainerDetail
-
session¶ Gets the session of this JobDetailParentInfo.
- Returns
The session of this JobDetailParentInfo.
- Return type
JobContainerDetail
-
acquisition¶ Gets the acquisition of this JobDetailParentInfo.
- Returns
The acquisition of this JobDetailParentInfo.
- Return type
JobContainerDetail
-
analysis¶ Gets the analysis of this JobDetailParentInfo.
- Returns
The analysis of this JobDetailParentInfo.
- Return type
JobContainerDetail
-
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
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
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¶
An object describing characteristics to match on gears
-
class
JobGearMatch¶ An object describing characteristics to match on gears
-
group¶ A set of groups that are in the hierarchy of an input or destination
- Returns
The group of this JobGearMatch.
- Return type
vector[char]
-
gearName¶ A set of gear.name matches
- Returns
The gearName of this JobGearMatch.
- Return type
vector[char]
-
tag¶ A set of job.tags matches
- Returns
The tag of this JobGearMatch.
- Return type
vector[char]
-
computeProvider¶ A set of compute providers to match
- Returns
The computeProvider of this JobGearMatch.
- Return type
vector[char]
-
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¶ -
id¶ Unique database ID
- Returns
The id of this JobListEntry.
- Return type
char
-
origin¶ Gets the origin of this JobListEntry.
- Returns
The origin of this JobListEntry.
- Return type
JobOrigin
-
gearId¶ Gets the gearId of this JobListEntry.
- Returns
The gearId of this JobListEntry.
- Return type
char
-
gearInfo¶ Gets the gearInfo of this JobListEntry.
- Returns
The gearInfo of this JobListEntry.
- Return type
GearInfo
-
previousJobId¶ Gets the previousJobId of this JobListEntry.
- Returns
The previousJobId of this JobListEntry.
- Return type
char
-
inputs¶ Gets the inputs of this JobListEntry.
- Returns
The inputs of this JobListEntry.
- Return type
JobInputsArrayItem
-
destination¶ Gets the destination of this JobListEntry.
- Returns
The destination of this JobListEntry.
- Return type
JobDestination
Gets the tags of this JobListEntry.
- Returns
The tags of this JobListEntry.
- Return type
vector[char]
-
state¶ Gets the state of this JobListEntry.
- Returns
The state of this JobListEntry.
- Return type
char
-
attempt¶ Gets the attempt of this JobListEntry.
- Returns
The attempt of this JobListEntry.
- Return type
integer
-
created¶ Creation time (automatically set)
- Returns
The created of this JobListEntry.
- Return type
datetime
-
modified¶ Last modification time (automatically updated)
- Returns
The modified of this JobListEntry.
- Return type
datetime
-
retried¶ Retried time (automatically set)
- Returns
The retried of this JobListEntry.
- Return type
datetime
-
config¶ Gets the config of this JobListEntry.
- Returns
The config of this JobListEntry.
- Return type
JobConfig
-
request¶ Gets the request of this JobListEntry.
- Returns
The request of this JobListEntry.
- Return type
JobRequest
-
savedFiles¶ Gets the savedFiles of this JobListEntry.
- Returns
The savedFiles of this JobListEntry.
- Return type
vector[char]
-
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
-
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
Gets the tags of this JobListOutput.
- Returns
The tags of this JobListOutput.
- Return type
vector[char]
-
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
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¶
JobLogColumn¶
An enumeration.
-
class
JobLogColumn¶ An enumeration.
JobLogRecord¶
JobModify¶
JobOrigin¶
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
-
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
Gets the tags of this JobOutput.
- Returns
The tags of this JobOutput.
- Return type
vector[char]
-
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
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
-
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¶ -
preparationTimeMs¶ The length of time taken to download gear container and inputs, in milliseconds
- Returns
The preparationTimeMs of this JobProfileInput.
- Return type
integer
-
elapsedTimeMs¶ The runtime of the job, in milliseconds
- Returns
The elapsedTimeMs of this JobProfileInput.
- Return type
integer
-
uploadTimeMs¶ The length of time taken to upload the job’s outputs, in milliseconds
- Returns
The uploadTimeMs of this JobProfileInput.
- Return type
integer
-
versions¶ Gets the versions of this JobProfileInput.
- Returns
The versions of this JobProfileInput.
- Return type
JobVersionInfo
-
executor¶ Gets the executor of this JobProfileInput.
- Returns
The executor of this JobProfileInput.
- Return type
JobExecutorInfo
-
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¶
The number of jobs matching the filter, for each job state
-
class
JobStateCounts¶ The number of jobs matching the filter, for each job state
-
pending¶ Gets the pending of this JobStateCounts.
- Returns
The pending of this JobStateCounts.
- Return type
integer
-
running¶ Gets the running of this JobStateCounts.
- Returns
The running of this JobStateCounts.
- Return type
integer
-
failed¶ Gets the failed of this JobStateCounts.
- Returns
The failed of this JobStateCounts.
- Return type
integer
-
complete¶ Gets the complete of this JobStateCounts.
- Returns
The complete of this JobStateCounts.
- Return type
integer
-
cancelled¶ Gets the cancelled of this JobStateCounts.
- Returns
The cancelled of this JobStateCounts.
- Return type
integer
-
JobStatsByState¶
-
class
JobStatsByState¶ -
pending¶ Gets the pending of this JobStatsByState.
- Returns
The pending of this JobStatsByState.
- Return type
integer
-
running¶ Gets the running of this JobStatsByState.
- Returns
The running of this JobStatsByState.
- Return type
integer
-
failed¶ Gets the failed of this JobStatsByState.
- Returns
The failed of this JobStatsByState.
- Return type
integer
-
complete¶ Gets the complete of this JobStatsByState.
- Returns
The complete of this JobStatsByState.
- Return type
integer
-
cancelled¶ Gets the cancelled of this JobStatsByState.
- Returns
The cancelled of this JobStatsByState.
- Return type
integer
-
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¶
JoinOriginDevice¶
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¶
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
LdapSyncData¶
LdapSyncInput¶
LdapSyncLdapUser¶
-
class
LdapSyncLdapUser¶ -
uid¶ Gets the uid of this LdapSyncLdapUser.
- Returns
The uid of this LdapSyncLdapUser.
- Return type
char
-
firstname¶ Gets the firstname of this LdapSyncLdapUser.
- Returns
The firstname of this LdapSyncLdapUser.
- Return type
char
-
lastname¶ Gets the lastname of this LdapSyncLdapUser.
- Returns
The lastname of this LdapSyncLdapUser.
- Return type
char
-
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
-
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
-
LicenseType¶
Valid license types
-
class
LicenseType¶ Valid license types
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
-
MLType¶
An enumeration.
-
class
MLType¶ An enumeration.
MasterSubjectCodeCodeOutput¶
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
-
MasterSubjectCodeIdInput¶
-
class
MasterSubjectCodeIdInput¶ -
firstName¶ First name
- Returns
The firstName of this MasterSubjectCodeIdInput.
- Return type
char
-
lastName¶ Last name
- Returns
The lastName of this MasterSubjectCodeIdInput.
- Return type
char
-
dateOfBirth¶ Date of birth in YYYY-MM-DD format
- Returns
The dateOfBirth of this MasterSubjectCodeIdInput.
- Return type
char
-
patientId¶ Patient id
- Returns
The patientId of this MasterSubjectCodeIdInput.
- Return type
char
-
usePatientId¶ Use patient ID for identification or first name, last name, DOB
- Returns
The usePatientId of this MasterSubjectCodeIdInput.
- Return type
logical
-
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¶ Gets the id of this ModalityOutput.
- 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¶
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¶ -
text¶ The actual contents of the note
- Returns
The text of this Note.
- Return type
char
-
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
-
user¶ Database ID of a user
- Returns
The user of this Note.
- Return type
char
-
NoteInput¶
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
-
Order¶
An enumeration.
-
class
Order¶ An enumeration.
OrganSystem¶
An enumeration.
-
class
OrganSystem¶ An enumeration.
Origin¶
OriginType¶
An enumeration.
-
class
OriginType¶ An enumeration.
Packfile¶
-
class
Packfile¶ -
project¶ Gets the project of this Packfile.
- Returns
The project of this Packfile.
- Return type
PackfileProjectInput
-
session¶ Gets the session of this Packfile.
- Returns
The session of this Packfile.
- Return type
PackfileSessionInput
-
acquisition¶ Gets the acquisition of this Packfile.
- Returns
The acquisition of this Packfile.
- Return type
PackfileAcquisitionInput
-
packfile¶ Gets the packfile of this Packfile.
- Returns
The packfile of this Packfile.
- Return type
PackfilePackfileInput
-
PackfileAcquisitionInput¶
-
class
PackfileAcquisitionInput¶ -
label¶ Gets the label of this PackfileAcquisitionInput.
- Returns
The label of this PackfileAcquisitionInput.
- Return type
char
-
timestamp¶ Gets the timestamp of this PackfileAcquisitionInput.
- Returns
The timestamp of this PackfileAcquisitionInput.
- Return type
datetime
-
timezone¶ Gets the timezone of this PackfileAcquisitionInput.
- Returns
The timezone of this PackfileAcquisitionInput.
- Return type
char
-
PackfilePackfileInput¶
PackfileProjectInput¶
PackfileSessionInput¶
PackfileStart¶
Page¶
A page
PermissionAccessPermission¶
Project¶
-
class
Project¶
ProjectAcquisitionUpsertInput¶
-
class
ProjectAcquisitionUpsertInput¶ -
id¶ Gets the id of this ProjectAcquisitionUpsertInput.
- Returns
The id of this ProjectAcquisitionUpsertInput.
- Return type
char
-
uid¶ Gets the uid of this ProjectAcquisitionUpsertInput.
- Returns
The uid of this ProjectAcquisitionUpsertInput.
- Return type
char
-
label¶ Gets the label of this ProjectAcquisitionUpsertInput.
- Returns
The label of this ProjectAcquisitionUpsertInput.
- Return type
char
-
timestamp¶ Gets the timestamp of this ProjectAcquisitionUpsertInput.
- Returns
The timestamp of this ProjectAcquisitionUpsertInput.
- Return type
char
-
timezone¶ Gets the timezone of this ProjectAcquisitionUpsertInput.
- Returns
The timezone of this ProjectAcquisitionUpsertInput.
- Return type
char
-
info¶ Gets the info of this ProjectAcquisitionUpsertInput.
- Returns
The info of this ProjectAcquisitionUpsertInput.
- Return type
containers.Map
-
ProjectAcquisitionUpsertOutput¶
-
class
ProjectAcquisitionUpsertOutput¶ -
id¶ Gets the id of this ProjectAcquisitionUpsertOutput.
- Returns
The id of this ProjectAcquisitionUpsertOutput.
- Return type
char
-
uid¶ Gets the uid of this ProjectAcquisitionUpsertOutput.
- Returns
The uid of this ProjectAcquisitionUpsertOutput.
- Return type
char
-
label¶ Gets the label of this ProjectAcquisitionUpsertOutput.
- Returns
The label of this ProjectAcquisitionUpsertOutput.
- Return type
char
-
upsertResult¶ Gets the upsertResult of this ProjectAcquisitionUpsertOutput.
- Returns
The upsertResult of this ProjectAcquisitionUpsertOutput.
- Return type
char
-
ProjectCatalogListOutput¶
-
class
ProjectCatalogListOutput¶ -
id¶ Unique database ID
- Returns
The id of this ProjectCatalogListOutput.
- Return type
char
-
label¶ Application-specific label
- Returns
The label of this ProjectCatalogListOutput.
- Return type
char
Array of application-specific tags
- Returns
The tags of this ProjectCatalogListOutput.
- Return type
vector[char]
-
summary¶ Gets the summary of this ProjectCatalogListOutput.
- Returns
The summary of this ProjectCatalogListOutput.
- Return type
char
-
therapeuticAreas¶ Gets the therapeuticAreas of this ProjectCatalogListOutput.
- Returns
The therapeuticAreas of this ProjectCatalogListOutput.
- Return type
vector[char]
-
bodyRegions¶ Gets the bodyRegions of this ProjectCatalogListOutput.
- Returns
The bodyRegions of this ProjectCatalogListOutput.
- Return type
vector[char]
-
organSystems¶ Gets the organSystems of this ProjectCatalogListOutput.
- Returns
The organSystems of this ProjectCatalogListOutput.
- Return type
vector[char]
-
projectInstitutions¶ Gets the projectInstitutions of this ProjectCatalogListOutput.
- Returns
The projectInstitutions of this ProjectCatalogListOutput.
- Return type
ProjectSharingSettingsProjectInstitution
-
projectContacts¶ Gets the projectContacts of this ProjectCatalogListOutput.
- Returns
The projectContacts of this ProjectCatalogListOutput.
- Return type
ProjectSharingSettingsProjectContact
-
stats¶ Gets the stats of this ProjectCatalogListOutput.
- Returns
The stats of this ProjectCatalogListOutput.
- Return type
ProjectSharingSettingsProjectStats
-
ProjectContact¶
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
-
ProjectHierarchyUpsertInput¶
-
class
ProjectHierarchyUpsertInput¶ -
origin¶ Gets the origin of this ProjectHierarchyUpsertInput.
- Returns
The origin of this ProjectHierarchyUpsertInput.
- Return type
ProjectUpsertOrigin
-
subject¶ Gets the subject of this ProjectHierarchyUpsertInput.
- Returns
The subject of this ProjectHierarchyUpsertInput.
- Return type
ProjectSubjectUpsertInput
-
session¶ Gets the session of this ProjectHierarchyUpsertInput.
- Returns
The session of this ProjectHierarchyUpsertInput.
- Return type
ProjectSessionUpsertInput
-
acquisition¶ Gets the acquisition of this ProjectHierarchyUpsertInput.
- Returns
The acquisition of this ProjectHierarchyUpsertInput.
- Return type
ProjectAcquisitionUpsertInput
-
ProjectHierarchyUpsertOutput¶
-
class
ProjectHierarchyUpsertOutput¶ -
subject¶ Gets the subject of this ProjectHierarchyUpsertOutput.
- Returns
The subject of this ProjectHierarchyUpsertOutput.
- Return type
ProjectSubjectUpsertOutput
-
session¶ Gets the session of this ProjectHierarchyUpsertOutput.
- Returns
The session of this ProjectHierarchyUpsertOutput.
- Return type
ProjectSessionUpsertOutput
-
acquisition¶ Gets the acquisition of this ProjectHierarchyUpsertOutput.
- Returns
The acquisition of this ProjectHierarchyUpsertOutput.
- Return type
ProjectAcquisitionUpsertOutput
-
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¶
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
RolesBackwardsCompatibleRoleAssignment
-
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
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.
ProjectMetadataInput¶
-
class
ProjectMetadataInput¶ -
label¶ Gets the label of this ProjectMetadataInput.
- Returns
The label of this ProjectMetadataInput.
- Return type
char
-
info¶ Gets the info of this ProjectMetadataInput.
- Returns
The info of this ProjectMetadataInput.
- Return type
containers.Map
-
files¶ Gets the files of this ProjectMetadataInput.
- Returns
The files of this ProjectMetadataInput.
- Return type
FileEntry
Array of application-specific tags
- Returns
The tags of this ProjectMetadataInput.
- Return type
vector[char]
-
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
-
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
RolesBackwardsCompatibleRoleAssignment
-
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
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¶
ProjectSessionUpsertInput¶
-
class
ProjectSessionUpsertInput¶ -
id¶ Gets the id of this ProjectSessionUpsertInput.
- Returns
The id of this ProjectSessionUpsertInput.
- Return type
char
-
uid¶ Gets the uid of this ProjectSessionUpsertInput.
- Returns
The uid of this ProjectSessionUpsertInput.
- Return type
char
-
label¶ Gets the label of this ProjectSessionUpsertInput.
- Returns
The label of this ProjectSessionUpsertInput.
- Return type
char
-
timestamp¶ Gets the timestamp of this ProjectSessionUpsertInput.
- Returns
The timestamp of this ProjectSessionUpsertInput.
- Return type
char
-
timezone¶ Gets the timezone of this ProjectSessionUpsertInput.
- Returns
The timezone of this ProjectSessionUpsertInput.
- Return type
char
-
age¶ Gets the age of this ProjectSessionUpsertInput.
- Returns
The age of this ProjectSessionUpsertInput.
- Return type
float
-
weight¶ Gets the weight of this ProjectSessionUpsertInput.
- Returns
The weight of this ProjectSessionUpsertInput.
- Return type
float
-
operator¶ Gets the operator of this ProjectSessionUpsertInput.
- Returns
The operator of this ProjectSessionUpsertInput.
- Return type
char
-
info¶ Gets the info of this ProjectSessionUpsertInput.
- Returns
The info of this ProjectSessionUpsertInput.
- Return type
containers.Map
-
ProjectSessionUpsertOutput¶
-
class
ProjectSessionUpsertOutput¶ -
id¶ Gets the id of this ProjectSessionUpsertOutput.
- Returns
The id of this ProjectSessionUpsertOutput.
- Return type
char
-
uid¶ Gets the uid of this ProjectSessionUpsertOutput.
- Returns
The uid of this ProjectSessionUpsertOutput.
- Return type
char
-
label¶ Gets the label of this ProjectSessionUpsertOutput.
- Returns
The label of this ProjectSessionUpsertOutput.
- Return type
char
-
upsertResult¶ Gets the upsertResult of this ProjectSessionUpsertOutput.
- Returns
The upsertResult of this ProjectSessionUpsertOutput.
- Return type
char
-
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¶ 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
ProjectSharingSettingsProjectContact¶
-
class
ProjectSharingSettingsProjectContact¶ -
name¶ Gets the name of this ProjectSharingSettingsProjectContact.
- Returns
The name of this ProjectSharingSettingsProjectContact.
- Return type
char
-
email¶ Gets the email of this ProjectSharingSettingsProjectContact.
- Returns
The email of this ProjectSharingSettingsProjectContact.
- Return type
char
-
ProjectSharingSettingsProjectCounters¶
-
class
ProjectSharingSettingsProjectCounters¶ -
subjects¶ Gets the subjects of this ProjectSharingSettingsProjectCounters.
- Returns
The subjects of this ProjectSharingSettingsProjectCounters.
- Return type
integer
-
sessions¶ Gets the sessions of this ProjectSharingSettingsProjectCounters.
- Returns
The sessions of this ProjectSharingSettingsProjectCounters.
- Return type
integer
-
acquisitions¶ Gets the acquisitions of this ProjectSharingSettingsProjectCounters.
- Returns
The acquisitions of this ProjectSharingSettingsProjectCounters.
- Return type
integer
-
files¶ Gets the files of this ProjectSharingSettingsProjectCounters.
- Returns
The files of this ProjectSharingSettingsProjectCounters.
- Return type
integer
-
ProjectSharingSettingsProjectInstitution¶
-
class
ProjectSharingSettingsProjectInstitution¶ -
name¶ Gets the name of this ProjectSharingSettingsProjectInstitution.
- Returns
The name of this ProjectSharingSettingsProjectInstitution.
- Return type
char
-
url¶ Gets the url of this ProjectSharingSettingsProjectInstitution.
- Returns
The url of this ProjectSharingSettingsProjectInstitution.
- Return type
char
-
ProjectSharingSettingsProjectSettingsInput¶
ProjectSharingSettingsProjectSettingsOutput¶
ProjectSharingSettingsProjectSettingsSharing¶
-
class
ProjectSharingSettingsProjectSettingsSharing¶ Gets the shareLevel of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The shareLevel of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
char
-
projectInstitutions¶ Gets the projectInstitutions of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The projectInstitutions of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
ProjectSharingSettingsProjectInstitution
-
projectContacts¶ Gets the projectContacts of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The projectContacts of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
ProjectSharingSettingsProjectContact
-
summary¶ Gets the summary of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The summary of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
char
-
therapeuticAreas¶ Gets the therapeuticAreas of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The therapeuticAreas of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
vector[char]
-
bodyRegions¶ Gets the bodyRegions of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The bodyRegions of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
vector[char]
-
organSystems¶ Gets the organSystems of this ProjectSharingSettingsProjectSettingsSharing.
- Returns
The organSystems of this ProjectSharingSettingsProjectSettingsSharing.
- Return type
vector[char]
ProjectSharingSettingsProjectSettingsSharingInput¶
-
class
ProjectSharingSettingsProjectSettingsSharingInput¶ Gets the shareLevel of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The shareLevel of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
char
-
projectInstitutions¶ Gets the projectInstitutions of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The projectInstitutions of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
ProjectSharingSettingsProjectInstitution
-
projectContacts¶ Gets the projectContacts of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The projectContacts of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
ProjectSharingSettingsProjectContact
-
summary¶ Gets the summary of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The summary of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
char
-
therapeuticAreas¶ Gets the therapeuticAreas of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The therapeuticAreas of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
vector[char]
-
bodyRegions¶ Gets the bodyRegions of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The bodyRegions of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
vector[char]
-
organSystems¶ Gets the organSystems of this ProjectSharingSettingsProjectSettingsSharingInput.
- Returns
The organSystems of this ProjectSharingSettingsProjectSettingsSharingInput.
- Return type
vector[char]
ProjectSharingSettingsProjectStats¶
-
class
ProjectSharingSettingsProjectStats¶ -
numberOf¶ Gets the numberOf of this ProjectSharingSettingsProjectStats.
- Returns
The numberOf of this ProjectSharingSettingsProjectStats.
- Return type
ProjectSharingSettingsProjectCounters
-
ageGroups¶ Gets the ageGroups of this ProjectSharingSettingsProjectStats.
- Returns
The ageGroups of this ProjectSharingSettingsProjectStats.
- Return type
char
-
measurements¶ Gets the measurements of this ProjectSharingSettingsProjectStats.
- Returns
The measurements of this ProjectSharingSettingsProjectStats.
- Return type
char
-
modalities¶ Gets the modalities of this ProjectSharingSettingsProjectStats.
- Returns
The modalities of this ProjectSharingSettingsProjectStats.
- Return type
char
-
fileTypes¶ Gets the fileTypes of this ProjectSharingSettingsProjectStats.
- Returns
The fileTypes of this ProjectSharingSettingsProjectStats.
- Return type
char
-
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¶ -
id¶ Gets the id of this ProjectSubjectUpsertInput.
- Returns
The id of this ProjectSubjectUpsertInput.
- Return type
char
-
label¶ Gets the label of this ProjectSubjectUpsertInput.
- Returns
The label of this ProjectSubjectUpsertInput.
- Return type
char
-
firstname¶ Gets the firstname of this ProjectSubjectUpsertInput.
- Returns
The firstname of this ProjectSubjectUpsertInput.
- Return type
char
-
lastname¶ Gets the lastname of this ProjectSubjectUpsertInput.
- Returns
The lastname of this ProjectSubjectUpsertInput.
- Return type
char
-
sex¶ Gets the sex of this ProjectSubjectUpsertInput.
- Returns
The sex of this ProjectSubjectUpsertInput.
- Return type
char
-
type¶ Gets the type of this ProjectSubjectUpsertInput.
- Returns
The type of this ProjectSubjectUpsertInput.
- Return type
char
-
race¶ Gets the race of this ProjectSubjectUpsertInput.
- Returns
The race of this ProjectSubjectUpsertInput.
- Return type
char
-
ethnicity¶ Gets the ethnicity of this ProjectSubjectUpsertInput.
- Returns
The ethnicity of this ProjectSubjectUpsertInput.
- Return type
char
-
species¶ Gets the species of this ProjectSubjectUpsertInput.
- Returns
The species of this ProjectSubjectUpsertInput.
- Return type
char
-
strain¶ Gets the strain of this ProjectSubjectUpsertInput.
- Returns
The strain of this ProjectSubjectUpsertInput.
- Return type
char
-
info¶ Gets the info of this ProjectSubjectUpsertInput.
- Returns
The info of this ProjectSubjectUpsertInput.
- Return type
containers.Map
-
ProjectSubjectUpsertOutput¶
-
class
ProjectSubjectUpsertOutput¶ -
id¶ Gets the id of this ProjectSubjectUpsertOutput.
- Returns
The id of this ProjectSubjectUpsertOutput.
- Return type
char
-
label¶ Gets the label of this ProjectSubjectUpsertOutput.
- Returns
The label of this ProjectSubjectUpsertOutput.
- Return type
char
-
upsertResult¶ Gets the upsertResult of this ProjectSubjectUpsertOutput.
- Returns
The upsertResult of this ProjectSubjectUpsertOutput.
- Return type
char
-
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
-
ProjectTemplateRequirement¶
-
class
ProjectTemplateRequirement¶ -
minimum¶ Gets the minimum of this ProjectTemplateRequirement.
- Returns
The minimum of this ProjectTemplateRequirement.
- Return type
integer
-
maximum¶ Gets the maximum of this ProjectTemplateRequirement.
- Returns
The maximum of this ProjectTemplateRequirement.
- Return type
integer
-
ProjectTemplateSessionTemplate¶
-
class
ProjectTemplateSessionTemplate¶ -
session¶ Gets the session of this ProjectTemplateSessionTemplate.
- Returns
The session of this ProjectTemplateSessionTemplate.
- Return type
containers.Map
-
acquisitions¶ Gets the acquisitions of this ProjectTemplateSessionTemplate.
- Returns
The acquisitions of this ProjectTemplateSessionTemplate.
- Return type
ProjectTemplateRequirement
-
ProjectUpsertOrigin¶
Provider¶
-
class
Provider¶ -
id¶ Unique database ID
- Returns
The id of this Provider.
- Return type
char
-
providerClass¶ The provider class - one of compute or storage
- Returns
The providerClass of this Provider.
- Return type
char
-
providerType¶ The provider type (e.g. static or gcloud)
- Returns
The providerType of this Provider.
- Return type
char
-
accessType¶ The access type - required for storage class providers
- Returns
The accessType of this Provider.
- Return type
char
-
label¶ A human readable label for the provider
- Returns
The label of this Provider.
- Return type
char
-
origin¶ Gets the origin of this Provider.
- Returns
The origin of this Provider.
- Return type
Origin
-
created¶ Creation time (automatically set)
- Returns
The created of this Provider.
- Return type
datetime
-
modified¶ Last modification time (automatically updated)
- Returns
The modified of this Provider.
- Return type
datetime
-
config¶ The provider-specific configuration fields.
- Returns
The config of this Provider.
- Return type
containers.Map
-
creds¶ The provider-specific credential fields.
- Returns
The creds of this Provider.
- Return type
containers.Map
-
ProviderAccessType¶
An enumeration.
-
class
ProviderAccessType¶ An enumeration.
ProviderClass¶
An enumeration.
-
class
ProviderClass¶ An enumeration.
ProviderInput¶
-
class
ProviderInput¶ -
providerClass¶ The provider class - one of compute or storage
- Returns
The providerClass of this ProviderInput.
- Return type
char
-
providerType¶ The provider type (e.g. static or gcloud)
- Returns
The providerType of this ProviderInput.
- Return type
char
-
accessType¶ The access type - required for storage class providers
- Returns
The accessType of this ProviderInput.
- Return type
char
-
label¶ A human readable label for the provider
- Returns
The label of this ProviderInput.
- Return type
char
-
config¶ The provider-specific configuration fields.
- Returns
The config of this ProviderInput.
- Return type
containers.Map
-
creds¶ The provider-specific credential fields.
- Returns
The creds of this ProviderInput.
- Return type
containers.Map
-
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¶
ReportAccessLogContextFileEntry¶
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)
ReportDailyUsageEntry¶
An entry in the usage report, describing storage and gear usage by group
-
class
ReportDailyUsageEntry¶ An entry in the usage report, describing storage and gear usage by group
-
year¶ The year that this report row represents
- Returns
The year of this ReportDailyUsageEntry.
- Return type
integer
-
month¶ The month that this report row represents
- Returns
The month of this ReportDailyUsageEntry.
- Return type
integer
-
day¶ The day that this report row 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 jobs that completed during the time frame that are billable to the center
- Returns
The centerJobCount of this ReportDailyUsageEntry.
- Return type
integer
-
groupJobCount¶ The number of jobs that completed during the time frame that are billable to the group
- Returns
The groupJobCount of this ReportDailyUsageEntry.
- Return type
integer
-
centerComputeMs¶ The compute time of jobs completed during the time frame, billable to the center
- Returns
The centerComputeMs of this ReportDailyUsageEntry.
- Return type
integer
-
groupComputeMs¶ The compute time of jobs completed during the time frame, billable to the group
- Returns
The groupComputeMs of this ReportDailyUsageEntry.
- Return type
integer
-
centerStorageBytes¶ The total storage used on this day, billable to the center
- Returns
The centerStorageBytes of this ReportDailyUsageEntry.
- Return type
integer
-
groupStorageBytes¶ The total storage used on this day, billable to the group
- Returns
The groupStorageBytes of this ReportDailyUsageEntry.
- Return type
integer
-
ReportDemographicsGrid¶
-
class
ReportDemographicsGrid¶ -
blackOrAfricanAmerican¶ Gets the blackOrAfricanAmerican of this ReportDemographicsGrid.
- Returns
The blackOrAfricanAmerican of this ReportDemographicsGrid.
- Return type
ReportEthnicityGrid
-
unknownOrNotReported¶ Gets the unknownOrNotReported of this ReportDemographicsGrid.
- Returns
The unknownOrNotReported of this ReportDemographicsGrid.
- Return type
ReportEthnicityGrid
-
americanIndianOrAlaskaNative¶ Gets the americanIndianOrAlaskaNative of this ReportDemographicsGrid.
- Returns
The americanIndianOrAlaskaNative of this ReportDemographicsGrid.
- Return type
ReportEthnicityGrid
-
asian¶ Gets the asian of this ReportDemographicsGrid.
- Returns
The asian of this ReportDemographicsGrid.
- Return type
ReportEthnicityGrid
-
white¶ Gets the white of this ReportDemographicsGrid.
- Returns
The white of this ReportDemographicsGrid.
- Return type
ReportEthnicityGrid
-
total¶ Gets the total of this ReportDemographicsGrid.
- Returns
The total of this ReportDemographicsGrid.
- Return type
ReportEthnicityGrid
-
nativeHawaiianOrOtherPacificIslander¶ Gets the nativeHawaiianOrOtherPacificIslander of this ReportDemographicsGrid.
- Returns
The nativeHawaiianOrOtherPacificIslander of this ReportDemographicsGrid.
- Return type
ReportEthnicityGrid
-
moreThanOneRace¶ Gets the moreThanOneRace of this ReportDemographicsGrid.
- Returns
The moreThanOneRace of this ReportDemographicsGrid.
- Return type
ReportEthnicityGrid
-
maleCount¶ Gets the maleCount of this ReportDemographicsGrid.
- Returns
The maleCount of this ReportDemographicsGrid.
- Return type
integer
-
groupLabel¶ Application-specific label
- Returns
The groupLabel of this ReportDemographicsGrid.
- Return type
char
-
over18Count¶ Gets the over18Count of this ReportDemographicsGrid.
- Returns
The over18Count of this ReportDemographicsGrid.
- Return type
integer
-
under18Count¶ Gets the under18Count of this ReportDemographicsGrid.
- Returns
The under18Count of this ReportDemographicsGrid.
- Return type
integer
-
femaleCount¶ Gets the femaleCount of this ReportDemographicsGrid.
- Returns
The femaleCount of this ReportDemographicsGrid.
- Return type
integer
-
subjectsCount¶ Gets the subjectsCount of this ReportDemographicsGrid.
- Returns
The subjectsCount of this ReportDemographicsGrid.
- Return type
integer
-
otherCount¶ Gets the otherCount of this ReportDemographicsGrid.
- Returns
The otherCount of this ReportDemographicsGrid.
- Return type
integer
-
name¶ Application-specific label
- Returns
The name of this ReportDemographicsGrid.
- Return type
char
-
sessionCount¶ Gets the sessionCount of this ReportDemographicsGrid.
- Returns
The sessionCount of this ReportDemographicsGrid.
- Return type
integer
-
admins¶ Gets the admins of this ReportDemographicsGrid.
- Returns
The admins of this ReportDemographicsGrid.
- Return type
vector[char]
-
demographicsTotal¶ Gets the demographicsTotal of this ReportDemographicsGrid.
- Returns
The demographicsTotal of this ReportDemographicsGrid.
- Return type
integer
-
ReportEthnicityGrid¶
-
class
ReportEthnicityGrid¶ -
notHispanicOrLatino¶ Gets the notHispanicOrLatino of this ReportEthnicityGrid.
- Returns
The notHispanicOrLatino of this ReportEthnicityGrid.
- Return type
ReportGenderCount
-
hispanicOrLatino¶ Gets the hispanicOrLatino of this ReportEthnicityGrid.
- Returns
The hispanicOrLatino of this ReportEthnicityGrid.
- Return type
ReportGenderCount
-
unknownOrNotReported¶ Gets the unknownOrNotReported of this ReportEthnicityGrid.
- Returns
The unknownOrNotReported of this ReportEthnicityGrid.
- Return type
ReportGenderCount
-
total¶ Gets the total of this ReportEthnicityGrid.
- Returns
The total of this ReportEthnicityGrid.
- Return type
integer
-
ReportGenderCount¶
-
class
ReportGenderCount¶ -
male¶ Gets the male of this ReportGenderCount.
- Returns
The male of this ReportGenderCount.
- Return type
integer
-
unknownOrNotReported¶ Gets the unknownOrNotReported of this ReportGenderCount.
- Returns
The unknownOrNotReported of this ReportGenderCount.
- Return type
integer
-
female¶ Gets the female of this ReportGenderCount.
- Returns
The female of this ReportGenderCount.
- Return type
integer
-
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
ReportProject¶
ReportSite¶
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 storage and gear usage by group and project
-
class
ReportUsageEntry¶ An entry in the usage report, describing 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, or null if this is a group summary row
- Returns
The project of this ReportUsageEntry.
- Return type
char
-
projectLabel¶ The project label, or null if this is a group summary row
- Returns
The projectLabel of this ReportUsageEntry.
- Return type
char
-
sessionCount¶ The number of sessions that existed at the last collection time
- Returns
The sessionCount of this ReportUsageEntry.
- Return type
integer
-
centerJobCount¶ The number of jobs that completed during the time frame that are billable to the center
- Returns
The centerJobCount of this ReportUsageEntry.
- Return type
integer
-
groupJobCount¶ The number of jobs that completed during the time frame that are billable to the group
- Returns
The groupJobCount of this ReportUsageEntry.
- Return type
integer
-
totalJobCount¶ The total number of jobs completed during the time frame
- Returns
The totalJobCount of this ReportUsageEntry.
- Return type
integer
-
centerComputeMs¶ The compute time of jobs completed during the time frame, billable to the center
- Returns
The centerComputeMs of this ReportUsageEntry.
- Return type
integer
-
groupComputeMs¶ The compute time of jobs completed during the time frame, billable to the group
- Returns
The groupComputeMs of this ReportUsageEntry.
- Return type
integer
-
totalComputeMs¶ The total compute time of jobs completed during the time frame
- Returns
The totalComputeMs of this ReportUsageEntry.
- Return type
integer
-
centerStorageByteDay¶ The total storage used, in byte-days, billable to the center
- Returns
The centerStorageByteDay of this ReportUsageEntry.
- Return type
integer
-
groupStorageByteDay¶ The total storage used, in byte-days, billable to the group
- Returns
The groupStorageByteDay of this ReportUsageEntry.
- Return type
integer
-
totalStorageByteDay¶ The total storage used, in byte-days
- Returns
The totalStorageByteDay of this ReportUsageEntry.
- Return type
integer
-
days¶ The number of days collected in this report
- Returns
The days of this ReportUsageEntry.
- Return type
integer
-
ResolverAcquisitionNode¶
-
class
ResolverAcquisitionNode¶
ResolverAnalysisNode¶
-
class
ResolverAnalysisNode¶
ResolverFileNode¶
-
class
ResolverFileNode¶ -
id¶ Gets the id of this ResolverFileNode.
- Returns
The id of this ResolverFileNode.
- Return type
char
-
fileId¶ Unique database ID
- Returns
The fileId of this ResolverFileNode.
- Return type
char
-
version¶ Version of the file
- Returns
The version of this ResolverFileNode.
- Return type
integer
-
name¶ The name of the file on disk
- Returns
The name of this ResolverFileNode.
- Return type
char
-
type¶ A descriptive file type (e.g. dicom, image, document, …)
- Returns
The type of this ResolverFileNode.
- Return type
char
-
mimetype¶ A MIME Content-Type of the file
- Returns
The mimetype of this ResolverFileNode.
- Return type
char
-
modality¶ The type of instrument that originated the file (e.g. MR, CT, …)
- Returns
The modality of this ResolverFileNode.
- Return type
char
-
deidLogId¶ The UUID of the de-id log
- Returns
The deidLogId of this ResolverFileNode.
- Return type
char
-
classification¶ Gets the classification of this ResolverFileNode.
- Returns
The classification of this ResolverFileNode.
- Return type
CommonClassification
Array of application-specific tags
- Returns
The tags of this ResolverFileNode.
- Return type
vector[char]
-
info¶ Gets the info of this ResolverFileNode.
- Returns
The info of this ResolverFileNode.
- Return type
CommonInfo
-
origin¶ Gets the origin of this ResolverFileNode.
- Returns
The origin of this ResolverFileNode.
- Return type
FileOrigin
-
hash¶ Cryptographic hash of the file
- Returns
The hash of this ResolverFileNode.
- Return type
char
-
parents¶ Gets the parents of this ResolverFileNode.
- Returns
The parents of this ResolverFileNode.
- Return type
ContainerParents
-
parentRef¶ Gets the parentRef of this ResolverFileNode.
- Returns
The parentRef of this ResolverFileNode.
- Return type
ContainerReference
-
created¶ Creation time (automatically set)
- Returns
The created of this ResolverFileNode.
- Return type
datetime
-
modified¶ Last modification time (automatically updated)
- Returns
The modified of this ResolverFileNode.
- Return type
datetime
-
replaced¶ Last replaced time (automatically updated)
- Returns
The replaced of this ResolverFileNode.
- Return type
datetime
-
size¶ Size of the file, in bytes
- Returns
The size of this ResolverFileNode.
- Return type
integer
-
infoExists¶ Gets the infoExists of this ResolverFileNode.
- Returns
The infoExists of this ResolverFileNode.
- Return type
logical
-
zipMemberCount¶ Number of entries in the zip archive
- Returns
The zipMemberCount of this ResolverFileNode.
- Return type
integer
-
ResolverGearNode¶
-
class
ResolverGearNode¶ -
id¶ Unique database ID
- Returns
The id of this ResolverGearNode.
- Return type
char
-
category¶ The gear category
- Returns
The category of this ResolverGearNode.
- Return type
char
-
gear¶ Gets the gear of this ResolverGearNode.
- Returns
The gear of this ResolverGearNode.
- Return type
Gear
-
exchange¶ Gets the exchange of this ResolverGearNode.
- Returns
The exchange of this ResolverGearNode.
- Return type
GearExchange
-
created¶ Creation time (automatically set)
- Returns
The created of this ResolverGearNode.
- Return type
datetime
-
modified¶ Last modification time (automatically updated)
- Returns
The modified of this ResolverGearNode.
- Return type
datetime
-
disabled¶ The time the gear was disabled (automatically set)
- Returns
The disabled of this ResolverGearNode.
- Return type
datetime
-
ResolverGroupNode¶
-
class
ResolverGroupNode¶
ResolverInput¶
ResolverNode¶
ResolverOutput¶
ResolverProjectNode¶
-
class
ResolverProjectNode¶
ResolverSessionNode¶
-
class
ResolverSessionNode¶
ResolverSubjectNode¶
-
class
ResolverSubjectNode¶
RoleOutput¶
-
class
RoleOutput¶ -
label¶ Gets the label of this RoleOutput.
- Returns
The label of this RoleOutput.
- Return type
char
-
actions¶ Gets the actions of this RoleOutput.
- Returns
The actions of this RoleOutput.
- Return type
Action
-
id¶ Gets the id of this RoleOutput.
- Returns
The id of this RoleOutput.
- Return type
char
-
defaultFlywheelRole¶ Gets the defaultFlywheelRole of this RoleOutput.
- Returns
The defaultFlywheelRole of this RoleOutput.
- Return type
DefaultFlywheelRole
-
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]
-
RoleType¶
An enumeration.
-
class
RoleType¶ An enumeration.
RolesBackwardsCompatibleRoleAssignment¶
-
class
RolesBackwardsCompatibleRoleAssignment¶ -
id¶ Database ID of a user
- Returns
The id of this RolesBackwardsCompatibleRoleAssignment.
- Return type
char
-
roleIds¶ Gets the roleIds of this RolesBackwardsCompatibleRoleAssignment.
- Returns
The roleIds of this RolesBackwardsCompatibleRoleAssignment.
- Return type
vector[char]
-
access¶ Gets the access of this RolesBackwardsCompatibleRoleAssignment.
- Returns
The access of this RolesBackwardsCompatibleRoleAssignment.
- Return type
char
-
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¶
RolesRoleInput¶
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¶
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
SearchMlInput¶
-
class
SearchMlInput¶ -
labels¶ Gets the labels of this SearchMlInput.
- Returns
The labels of this SearchMlInput.
- Return type
vector[char]
-
searchQuery¶ Gets the searchQuery of this SearchMlInput.
- Returns
The searchQuery of this SearchMlInput.
- Return type
SearchQuery
-
files¶ Gets the files of this SearchMlInput.
- Returns
The files of this SearchMlInput.
- Return type
SearchMlInputFile
-
output¶ Gets the output of this SearchMlInput.
- Returns
The output of this SearchMlInput.
- Return type
ContainerReference
-
SearchMlInputFile¶
SearchParentAnalysis¶
-
class
SearchParentAnalysis¶
SearchParentCollection¶
-
class
SearchParentCollection¶
SearchParentProject¶
-
class
SearchParentProject¶
SearchParentResponse¶
Fields for parent search response
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
-
SearchParseSearchQueryResult¶
-
class
SearchParseSearchQueryResult¶ -
valid¶ Whether the structured query was valid or not
- Returns
The valid of this SearchParseSearchQueryResult.
- Return type
logical
-
errors¶ Gets the errors of this SearchParseSearchQueryResult.
- Returns
The errors of this SearchParseSearchQueryResult.
- Return type
SearchParseError
-
SearchProjectResponse¶
Fields for project search response
SearchQuery¶
-
class
SearchQuery¶ -
returnType¶ Sets the type of search results to return
- Returns
The returnType of this SearchQuery.
- Return type
char
-
searchString¶ Represents the plain text search query
- Returns
The searchString of this SearchQuery.
- Return type
char
-
structuredQuery¶ Represents structured query language search
- Returns
The structuredQuery 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]
-
SearchQuerySuggestions¶
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.
SearchSaveSearch¶
-
class
SearchSaveSearch¶ -
label¶ Application-specific label
- Returns
The label of this SearchSaveSearch.
- Return type
char
-
search¶ Gets the search of this SearchSaveSearch.
- Returns
The search of this SearchSaveSearch.
- Return type
SearchQuery
-
parent¶ Gets the parent of this SearchSaveSearch.
- Returns
The parent of this SearchSaveSearch.
- Return type
SearchSaveSearchParent
-
id¶ Unique database ID
- Returns
The id of this SearchSaveSearch.
- Return type
char
-
created¶ Creation time (automatically set)
- Returns
The created of this SearchSaveSearch.
- Return type
datetime
-
modified¶ Last modification time (automatically updated)
- Returns
The modified of this SearchSaveSearch.
- Return type
datetime
-
SearchSaveSearchInput¶
-
class
SearchSaveSearchInput¶ -
label¶ Application-specific label
- Returns
The label of this SearchSaveSearchInput.
- Return type
char
-
search¶ Gets the search of this SearchSaveSearchInput.
- Returns
The search of this SearchSaveSearchInput.
- Return type
SearchQuery
-
parent¶ Gets the parent of this SearchSaveSearchInput.
- Returns
The parent of this SearchSaveSearchInput.
- Return type
SearchSaveSearchParent
-
SearchSaveSearchParent¶
SearchSaveSearchUpdate¶
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¶
SearchStructuredSearchQuery¶
SearchSubjectResponse¶
Fields for subject search response
SearchSuggestion¶
Session¶
-
class
Session¶
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
RolesBackwardsCompatibleRoleAssignment
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
-
SessionMetadataInput¶
-
class
SessionMetadataInput¶ -
label¶ Gets the label of this SessionMetadataInput.
- Returns
The label of this SessionMetadataInput.
- Return type
char
-
info¶ Gets the info of this SessionMetadataInput.
- Returns
The info of this SessionMetadataInput.
- Return type
containers.Map
-
operator¶ Gets the operator of this SessionMetadataInput.
- Returns
The operator of this SessionMetadataInput.
- Return type
char
-
uid¶ Gets the uid of this SessionMetadataInput.
- Returns
The uid of this SessionMetadataInput.
- Return type
char
-
timestamp¶ Gets the timestamp of this SessionMetadataInput.
- Returns
The timestamp of this SessionMetadataInput.
- Return type
datetime
-
timezone¶ Gets the timezone of this SessionMetadataInput.
- Returns
The timezone of this SessionMetadataInput.
- Return type
char
-
subject¶ Gets the subject of this SessionMetadataInput.
- Returns
The subject of this SessionMetadataInput.
- Return type
Subject
Array of application-specific tags
- Returns
The tags of this SessionMetadataInput.
- Return type
vector[char]
-
age¶ Subject age at time of session, in seconds
- Returns
The age of this SessionMetadataInput.
- Return type
integer
-
weight¶ Subject weight at time of session, in kilograms
- Returns
The weight of this SessionMetadataInput.
- Return type
float
-
files¶ Gets the files of this SessionMetadataInput.
- Returns
The files of this SessionMetadataInput.
- Return type
FileEntry
-
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
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
-
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
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
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¶
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
-
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¶
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
-
Subject¶
-
class
Subject¶
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
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
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
-
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
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
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¶
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¶
Tag¶
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¶
TreeRequest¶
-
class
TreeRequest¶ -
groups¶ Gets the groups of this TreeRequest.
- Returns
The groups of this TreeRequest.
- Return type
TreeContainerRequestSpec
-
projects¶ Gets the projects of this TreeRequest.
- Returns
The projects of this TreeRequest.
- Return type
TreeContainerRequestSpec
-
subjects¶ Gets the subjects of this TreeRequest.
- Returns
The subjects of this TreeRequest.
- Return type
TreeContainerRequestSpec
-
sessions¶ Gets the sessions of this TreeRequest.
- Returns
The sessions of this TreeRequest.
- Return type
TreeContainerRequestSpec
-
acquisitions¶ Gets the acquisitions of this TreeRequest.
- Returns
The acquisitions of this TreeRequest.
- Return type
TreeContainerRequestSpec
-
analyses¶ Gets the analyses of this TreeRequest.
- Returns
The analyses of this TreeRequest.
- Return type
TreeContainerRequestSpec
-
jobs¶ Gets the jobs of this TreeRequest.
- Returns
The jobs of this TreeRequest.
- Return type
TreeContainerRequestSpec
-
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.
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¶
Signed upload url payload
-
class
UploadSignedUploadUrlInput¶ Signed upload url payload
-
providerId¶ Gets the providerId of this UploadSignedUploadUrlInput.
- Returns
The providerId of this UploadSignedUploadUrlInput.
- Return type
char
-
size¶ Gets the size of this UploadSignedUploadUrlInput.
- Returns
The size of this UploadSignedUploadUrlInput.
- Return type
integer
-
UploadSignedUploadUrlOutput¶
Signed upload url response
-
class
UploadSignedUploadUrlOutput¶ Signed upload url response
-
providerId¶ Gets the providerId of this UploadSignedUploadUrlOutput.
- Returns
The providerId of this UploadSignedUploadUrlOutput.
- Return type
char
-
uuid¶ Gets the uuid of this UploadSignedUploadUrlOutput.
- Returns
The uuid of this UploadSignedUploadUrlOutput.
- Return type
char
-
uploadUrls¶ Gets the uploadUrls of this UploadSignedUploadUrlOutput.
- Returns
The uploadUrls of this UploadSignedUploadUrlOutput.
- Return type
vector[char]
-
uploadHeaders¶ Gets the uploadHeaders of this UploadSignedUploadUrlOutput.
- Returns
The uploadHeaders of this UploadSignedUploadUrlOutput.
- Return type
containers.Map[String, char]
-
s3MultipartUploadId¶ Gets the s3MultipartUploadId of this UploadSignedUploadUrlOutput.
- Returns
The s3MultipartUploadId of this UploadSignedUploadUrlOutput.
- Return type
char
-
note¶ Gets the note of this UploadSignedUploadUrlOutput.
- Returns
The note of this UploadSignedUploadUrlOutput.
- Return type
char
-
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¶
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
-
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
-
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
-
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
-
UserJobsOutput¶
-
class
UserJobsOutput¶ -
stats¶ Gets the stats of this UserJobsOutput.
- Returns
The stats of this UserJobsOutput.
- Return type
JobStatsByState
-
total¶ Gets the total of this UserJobsOutput.
- Returns
The total of this UserJobsOutput.
- Return type
integer
-
jobs¶ Gets the jobs of this UserJobsOutput.
- Returns
The jobs of this UserJobsOutput.
- Return type
JobListEntry
-
UserOutput¶
-
class
UserOutput¶ -
id¶ Gets the id of this UserOutput.
- Returns
The id of this UserOutput.
- Return type
char
-
userId¶ Gets the userId of this UserOutput.
- Returns
The userId of this UserOutput.
- Return type
char
-
firstname¶ Gets the firstname of this UserOutput.
- Returns
The firstname of this UserOutput.
- Return type
char
-
lastname¶ Gets the lastname of this UserOutput.
- Returns
The lastname of this UserOutput.
- Return type
char
-
email¶ Gets the email of this UserOutput.
- Returns
The email of this UserOutput.
- Return type
char
-
roles¶ Gets the roles of this UserOutput.
- Returns
The roles of this UserOutput.
- Return type
RoleType
-
root¶ Gets the root of this UserOutput.
- Returns
The root of this UserOutput.
- Return type
logical
-
avatar¶ Gets the avatar of this UserOutput.
- Returns
The avatar of this UserOutput.
- Return type
char
-
avatars¶ Gets the avatars of this UserOutput.
- Returns
The avatars of this UserOutput.
- Return type
containers.Map
-
disabled¶ Gets the disabled of this UserOutput.
- Returns
The disabled of this UserOutput.
- Return type
logical
-
created¶ Gets the created of this UserOutput.
- Returns
The created of this UserOutput.
- Return type
datetime
-
modified¶ Gets the modified of this UserOutput.
- Returns
The modified of this UserOutput.
- Return type
datetime
-
deleted¶ Gets the deleted of this UserOutput.
- Returns
The deleted of this UserOutput.
- Return type
datetime
-
info¶ Gets the info of this UserOutput.
- Returns
The info of this UserOutput.
- Return type
containers.Map
-
firstlogin¶ Gets the firstlogin of this UserOutput.
- Returns
The firstlogin of this UserOutput.
- Return type
datetime
-
lastlogin¶ Gets the lastlogin of this UserOutput.
- Returns
The lastlogin of this UserOutput.
- Return type
datetime
-
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
-
VersionOutput¶
-
class
VersionOutput¶ -
id¶ Gets the id of this VersionOutput.
- Returns
The id of this VersionOutput.
- Return type
char
-
appliedFixes¶ Collection of applied database fixes
- Returns
The appliedFixes of this VersionOutput.
- Return type
containers.Map[String, char]
-
cliVersion¶ Compatible CLI version for this server as informed by the installation recipe.env
- Returns
The cliVersion of this VersionOutput.
- Return type
char
-
database¶ Core database version
- Returns
The database of this VersionOutput.
- Return type
integer
-
flywheelRelease¶ Flywheel installer image tag as informed by the installation recipe.env
- Returns
The flywheelRelease of this VersionOutput.
- Return type
char
-
release¶ Core release version
- Returns
The release of this VersionOutput.
- Return type
char
-
ViewIdOutput¶
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¶
VirusScanState¶
An enumeration.
-
class
VirusScanState¶ An enumeration.