Thrift module: experiment_model

ModuleServicesData typesConstants
experiment_model ExperimentModel
ExperimentSearchFields
ExperimentStatistics
ExperimentSummaryModel
ExperimentType
UserConfigurationDataModel

Enumerations

Enumeration: ExperimentType


SINGLE_APPLICATION0
WORKFLOW1

Enumeration: ExperimentSearchFields


EXPERIMENT_NAME0
EXPERIMENT_DESC1
APPLICATION_ID2
FROM_DATE3
TO_DATE4
STATUS5
PROJECT_ID6

Data structures

Struct: UserConfigurationDataModel

KeyFieldTypeDescriptionRequirednessDefault value
1airavataAutoScheduleboolrequiredfalse
2overrideManualScheduledParamsboolrequiredfalse
3shareExperimentPubliclybooloptionalfalse
4computationalResourceSchedulingscheduling_model.ComputationalResourceSchedulingModeloptional
5throttleResourcesbooloptionalfalse
6userDNstringoptional
7generateCertbooloptionalfalse
8storageIdstringoptional
9experimentDataDirstringoptional

A structure holding the experiment configuration.

Struct: ExperimentModel

KeyFieldTypeDescriptionRequirednessDefault value
1experimentIdstringrequired"DO_NOT_SET_AT_CLIENTS"
2projectIdstringrequired
3gatewayIdstringrequired
4experimentTypeExperimentTyperequiredExperimentType.SINGLE_APPLICATION
5userNamestringrequired
6experimentNamestringrequired
7creationTimei64optional
8descriptionstringoptional
9executionIdstringoptional
10gatewayExecutionIdstringoptional
11gatewayInstanceIdstringoptional
12enableEmailNotificationbooloptional
13emailAddresseslist<string>optional
14userConfigurationDataUserConfigurationDataModeloptional
15experimentInputslist<application_io_models.InputDataObjectType>optional
16experimentOutputslist<application_io_models.OutputDataObjectType>optional
17experimentStatusstatus_models.ExperimentStatusoptional
18errorslist<airavata_commons.ErrorModel>optional
19processeslist<process_model.ProcessModel>optional

A structure holding the experiment metadata and its child models. userName: The user name of the targeted gateway end user on whose behalf the experiment is being created. the associated gateway identity can only be inferred from the security hand-shake so as to avoid authorized Airavata Clients mimicking an unauthorized request. If a gateway is not registered with Airavata, an authorization exception is thrown. experimentName: The name of the experiment as defined by the user. The name need not be unique as uniqueness is enforced by the generated experiment id. experimentDescription: The verbose description of the experiment. This is an optional parameter.

Struct: ExperimentSummaryModel

KeyFieldTypeDescriptionRequirednessDefault value
1experimentIdstringrequired
2projectIdstringrequired
3gatewayIdstringrequired
4creationTimei64optional
5userNamestringrequired
6namestringrequired
7descriptionstringoptional
8executionIdstringoptional
9resourceHostIdstringoptional
10experimentStatusstringoptional
12statusUpdateTimei64optional

Struct: ExperimentStatistics

KeyFieldTypeDescriptionRequirednessDefault value
1allExperimentCounti32required
2completedExperimentCounti32required
3cancelledExperimentCounti32optional
4failedExperimentCounti32required
5createdExperimentCounti32required
6runningExperimentCounti32required
7allExperimentslist<ExperimentSummaryModel>required
8completedExperimentslist<ExperimentSummaryModel>optional
9failedExperimentslist<ExperimentSummaryModel>optional
10cancelledExperimentslist<ExperimentSummaryModel>optional
11createdExperimentslist<ExperimentSummaryModel>optional
12runningExperimentslist<ExperimentSummaryModel>optional