Thrift module: experimentModel

Enumeration: ExperimentState

CREATED	0
VALIDATED	1
SCHEDULED	2
LAUNCHED	3
EXECUTING	4
CANCELING	5
CANCELED	6
SUSPENDED	7
COMPLETED	8
FAILED	9
UNKNOWN	10

Enumeration: WorkflowNodeState

INVOKED	0
EXECUTING	1
CANCELING	2
CANCELED	3
SUSPENDED	4
COMPLETED	5
FAILED	6
UNKNOWN	7

Enumeration: TaskState

WAITING	0
STARTED	1
PRE_PROCESSING	2
CONFIGURING_WORKSPACE	3
INPUT_DATA_STAGING	4
OUTPUT_DATA_STAGING	5
POST_PROCESSING	6
EXECUTING	7
CANCELING	8
CANCELED	9
COMPLETED	10
FAILED	11
UNKNOWN	12

Enumeration: JobState

SUBMITTED	0
UN_SUBMITTED	1
SETUP	2
QUEUED	3
ACTIVE	4
COMPLETE	5
CANCELING	6
CANCELED	7
FAILED	8
HELD	9
SUSPENDED	10
UNKNOWN	11

Enumeration: TransferState

DIRECTORY_SETUP	0
UPLOAD	1
DOWNLOAD	2
ACTIVE	3
COMPLETE	4
STDOUT_DOWNLOAD	5
STDERROR_DOWNLOAD	6
CANCELING	7
CANCELED	8
FAILED	9
HELD	10
SUSPENDED	11
UNKNOWN	12

Enumeration: ActionableGroup

RESOURCE_ADMINS	0
AIRAVATA_ADMINS	1
GATEWAYS_ADMINS	2
USER	3
CANNOT_BE_DETERMINED	4

Enumeration: ErrorCategory

FILE_SYSTEM_FAILURE	0
APPLICATION_FAILURE	1
RESOURCE_NODE_FAILURE	2
DISK_FULL	3
INSUFFICIENT_ALLOCATION	4
SYSTEM_MAINTENANCE	5
AIRAVATA_INTERNAL_ERROR	6
CANNOT_BE_DETERMINED	7

Enumeration: CorrectiveAction

RETRY_SUBMISSION	0
CONTACT_SUPPORT	1
CANNOT_BE_DETERMINED	2

Enumeration: DataType

STRING	0
INTEGER	1
URI	2
STDOUT	3
STDERR	4

Enumeration: ExecutionUnit

INPUT	0
APPLICATION	1
OUTPUT	2

Struct: ExperimentStatus

Key	Field	Type	Description	Requiredness	Default value
1	experimentState	ExperimentState		required
2	timeOfStateChange	i64		optional

Struct: WorkflowNodeStatus

Key	Field	Type	Description	Requiredness	Default value
1	workflowNodeState	WorkflowNodeState		required
2	timeOfStateChange	i64		optional

Struct: TaskStatus

Key	Field	Type	Description	Requiredness	Default value
1	executionState	TaskState		required
2	timeOfStateChange	i64		optional

Struct: JobStatus

Key	Field	Type	Description	Requiredness	Default value
1	jobState	JobState		required
2	timeOfStateChange	i64		optional

Struct: TransferStatus

Key	Field	Type	Description	Requiredness	Default value
1	transferState	TransferState		required
2	timeOfStateChange	i64		optional

Struct: ApplicationStatus

Key	Field	Type	Description	Requiredness	Default value
1	applicationState	string		required
2	timeOfStateChange	i64		optional

Struct: DataObjectType

Key	Field	Type	Description	Requiredness	Default value
1	key	string		required
2	value	string		optional
3	type	DataType		optional
4	metaData	string		optional

A structure hold experiment input output

Struct: ComputationalResourceScheduling

Key	Field	Type	Description	Requiredness	Default value
1	resourceHostId	string		optional
2	totalCPUCount	i32		optional
3	nodeCount	i32		optional
4	numberOfThreads	i32		optional
5	queueName	string		optional
6	wallTimeLimit	i32		optional
7	jobStartTime	i32		optional
8	totalPhysicalMemory	i32		optional
9	computationalProjectAccount	string		optional

A structure holding the Computational Resource Scheduling.

Struct: AdvancedInputDataHandling

Key	Field	Type	Description	Requiredness	Default value
1	stageInputFilesToWorkingDir	bool		optional	0
2	parentWorkingDirectory	string		optional
3	uniqueWorkingDirectory	string		optional
4	cleanUpWorkingDirAfterJob	bool		optional	0

A structure holding specified input data handling.

Struct: AdvancedOutputDataHandling

Key	Field	Type	Description	Requiredness	Default value
2	outputDataDir	string		optional
3	dataRegistryURL	string		optional
4	persistOutputData	bool		optional	1

A structure holding specified output data handling.

Struct: QualityOfServiceParams

Key	Field	Type	Description	Requiredness	Default value
1	startExecutionAt	string		optional
2	executeBefore	string		optional
3	numberofRetries	i32		optional

A structure holding Quality of Service Parameters.

Struct: UserConfigurationData

Key	Field	Type	Description	Requiredness	Default value
1	airavataAutoSchedule	bool		required	0
2	overrideManualScheduledParams	bool		required	0
3	shareExperimentPublicly	bool		optional	0
4	computationalResourceScheduling	ComputationalResourceScheduling		optional
5	advanceInputDataHandling	AdvancedInputDataHandling		optional
6	advanceOutputDataHandling	AdvancedOutputDataHandling		optional
7	qosParams	QualityOfServiceParams		optional

A structure holding the experiment configuration.

Struct: ErrorDetails

Key	Field	Type	Description	Requiredness	Default value
1	errorID	string		required	"DO_NOT_SET_AT_CLIENTS"
2	creationTime	i64		optional
3	actualErrorMessage	string		optional
4	userFriendlyMessage	string		optional
5	errorCategory	ErrorCategory		optional
6	transientOrPersistent	bool		optional	0
7	correctiveAction	CorrectiveAction		optional
8	actionableGroup	ActionableGroup		optional
9	rootCauseErrorIdList	list<string>		optional

Struct: JobDetails

Key	Field	Type	Description	Requiredness	Default value
1	jobID	string		required	"DO_NOT_SET_AT_CLIENTS"
2	jobDescription	string		required
3	creationTime	i64		optional
4	jobStatus	JobStatus		optional
5	applicationStatus	ApplicationStatus		optional
6	errors	list<ErrorDetails>		optional
7	computeResourceConsumed	string		optional

Struct: DataTransferDetails

Key	Field	Type	Description	Requiredness	Default value
1	transferID	string		required	"DO_NOT_SET_AT_CLIENTS"
2	creationTime	i64		optional
3	transferDescription	string		required
4	transferStatus	TransferStatus		optional

Struct: TaskDetails

Key	Field	Type	Description	Requiredness	Default value
1	taskID	string		required	"DO_NOT_SET_AT_CLIENTS"
2	creationTime	i64		optional
3	applicationId	string		optional
4	applicationVersion	string		optional
5	applicationDeploymentId	string		optional
6	applicationInputs	list<DataObjectType>		optional
7	applicationOutputs	list<DataObjectType>		optional
8	taskScheduling	ComputationalResourceScheduling		optional
9	advancedInputDataHandling	AdvancedInputDataHandling		optional
10	advancedOutputDataHandling	AdvancedOutputDataHandling		optional
11	taskStatus	TaskStatus		optional
12	jobDetailsList	list<JobDetails>		optional
13	dataTransferDetailsList	list<DataTransferDetails>		optional
14	errors	list<ErrorDetails>		optional

A structure holding the actual execution context decided based on user provided configuration data or system inferred information from scheduling and QoS parameters. One experiment can have multiple tasks. Each tasks results in data transfers and jobs

Struct: WorkflowNodeDetails

Key	Field	Type	Description	Requiredness	Default value
1	nodeInstanceId	string		required	"DO_NOT_SET_AT_CLIENTS"
2	creationTime	i64		optional
3	nodeName	string		required	"SINGLE_APP_NODE"
4	executionUnit	ExecutionUnit		required	UNKNOWN
5	executionUnitData	string		optional
6	nodeInputs	list<DataObjectType>		optional
7	nodeOutputs	list<DataObjectType>		optional
8	workflowNodeStatus	WorkflowNodeStatus		optional
9	taskDetailsList	list<TaskDetails>		optional
10	errors	list<ErrorDetails>		optional

A structure holding the node data. nodeInstanceId - unique node identifier for each run

Struct: ValidatorResult

Key	Field	Type	Description	Requiredness	Default value
1	result	bool		required
2	errorDetails	string		optional

This data structure can be used to store the validation results captured during validation step and during the launchExperiment operation it can be easilly checked to see the errors occured during the experiment launch operation

Struct: ValidationResults

Key	Field	Type	Description	Requiredness	Default value
1	validationState	bool		required
2	validationResultList	list<ValidatorResult>		required

Struct: Experiment

Key	Field	Type	Description	Requiredness	Default value
1	experimentID	string		required	"DO_NOT_SET_AT_CLIENTS"
2	projectID	string		required	"DEFAULT"
3	creationTime	i64		optional
4	userName	string		required
5	name	string		required
6	description	string		optional
7	applicationId	string		optional
8	applicationVersion	string		optional
9	workflowTemplateId	string		optional
10	workflowTemplateVersion	string		optional
11	userConfigurationData	UserConfigurationData		optional
12	workflowExecutionInstanceId	string		optional
13	experimentInputs	list<DataObjectType>		optional
14	experimentOutputs	list<DataObjectType>		optional
15	experimentStatus	ExperimentStatus		optional
16	stateChangeList	list<WorkflowNodeStatus>		optional
17	workflowNodeDetailsList	list<WorkflowNodeDetails>		optional
18	errors	list<ErrorDetails>		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: ExperimentSummary

Key	Field	Type	Description	Requiredness	Default value
1	experimentID	string		required
2	projectID	string		required
3	creationTime	i64		optional
4	userName	string		required
5	name	string		required
6	description	string		optional
7	applicationId	string		optional
8	experimentStatus	ExperimentStatus		optional
9	errors	list<ErrorDetails>		optional