Thrift module: experiment_model

Module	Services	Data types	Constants
experiment_model		ExperimentModel ExperimentSearchFields ExperimentStatistics ExperimentSummaryModel ExperimentType ProjectSearchFields UserConfigurationDataModel

Enumerations

Enumeration: ExperimentType

`SINGLE_APPLICATION`	`0`
`WORKFLOW`	`1`

Enumeration: ExperimentSearchFields

`EXPERIMENT_NAME`	`0`
`EXPERIMENT_DESC`	`1`
`APPLICATION_ID`	`2`
`FROM_DATE`	`3`
`TO_DATE`	`4`
`STATUS`	`5`
`PROJECT_ID`	`6`
`USER_NAME`	`7`
`JOB_ID`	`8`

Enumeration: ProjectSearchFields

`PROJECT_NAME`	`0`
`PROJECT_DESCRIPTION`	`1`

Data structures

Struct: UserConfigurationDataModel

Key	Field	Type	Requiredness	Default value
1	airavataAutoSchedule	`bool`	required	`false`
2	overrideManualScheduledParams	`bool`	required	`false`
3	shareExperimentPublicly	`bool`	optional	`false`
4	computationalResourceScheduling	`scheduling_model.ComputationalResourceSchedulingModel`	optional
5	throttleResources	`bool`	optional	`false`
6	userDN	`string`	optional
7	generateCert	`bool`	optional	`false`
8	storageId	`string`	optional
9	experimentDataDir	`string`	optional
10	useUserCRPref	`bool`	optional
11	groupResourceProfileId	`string`	optional

A structure holding the experiment configuration.

Struct: ExperimentModel

Key	Field	Type	Requiredness	Default value
1	experimentId	`string`	required	`"DO_NOT_SET_AT_CLIENTS"`
2	projectId	`string`	required
3	gatewayId	`string`	required
4	experimentType	`ExperimentType`	required	`ExperimentType.SINGLE_APPLICATION`
5	userName	`string`	required
6	experimentName	`string`	required
7	creationTime	`i64`	optional
8	description	`string`	optional
9	executionId	`string`	optional
10	gatewayExecutionId	`string`	optional
11	gatewayInstanceId	`string`	optional
12	enableEmailNotification	`bool`	optional
13	emailAddresses	`list<string>`	optional
14	userConfigurationData	`UserConfigurationDataModel`	optional
15	experimentInputs	`list<application_io_models.InputDataObjectType>`	optional
16	experimentOutputs	`list<application_io_models.OutputDataObjectType>`	optional
17	experimentStatus	`list<status_models.ExperimentStatus>`	optional
18	errors	`list<airavata_commons.ErrorModel>`	optional
19	processes	`list<process_model.ProcessModel>`	optional
20	workflow	`airavata_workflow_model.AiravataWorkflow`	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

Key	Field	Type	Requiredness
1	experimentId	`string`	required
2	projectId	`string`	required
3	gatewayId	`string`	required
4	creationTime	`i64`	optional
5	userName	`string`	required
6	name	`string`	required
7	description	`string`	optional
8	executionId	`string`	optional
9	resourceHostId	`string`	optional
10	experimentStatus	`string`	optional
12	statusUpdateTime	`i64`	optional

Struct: ExperimentStatistics

Key	Field	Type	Requiredness
1	allExperimentCount	`i32`	required
2	completedExperimentCount	`i32`	required
3	cancelledExperimentCount	`i32`	optional
4	failedExperimentCount	`i32`	required
5	createdExperimentCount	`i32`	required
6	runningExperimentCount	`i32`	required
7	allExperiments	`list<ExperimentSummaryModel>`	required
8	completedExperiments	`list<ExperimentSummaryModel>`	optional
9	failedExperiments	`list<ExperimentSummaryModel>`	optional
10	cancelledExperiments	`list<ExperimentSummaryModel>`	optional
11	createdExperiments	`list<ExperimentSummaryModel>`	optional
12	runningExperiments	`list<ExperimentSummaryModel>`	optional