; Wed, 16 Dec 2015 16:25:39 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1720388 [4/5] - /airavata/site/trunk/content/documentation/api-docs/0.16/ Date: Wed, 16 Dec 2015 16:25:38 -0000 To: commits@airavata.apache.org From: smarru@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20151216162539.225B93A205E@svn01-us-west.apache.org> Added: airavata/site/trunk/content/documentation/api-docs/0.16/index.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/index.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/index.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/index.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,340 @@ + + +All Thrift declarations +

All Thrift declarations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Module	Services	Data types	Constants
airavata_api	Airavata + + addCloudJobSubmissionDetails + addGateway + addGatewayComputeResourcePreference + addGatewayStoragePreference + addGridFTPDataMovementDetails + addLocalDataMovementDetails + addLocalSubmissionDetails + addSCPDataMovementDetails + addSSHForkJobSubmissionDetails + addSSHJobSubmissionDetails + addUNICOREJobSubmissionDetails + addUnicoreDataMovementDetails + changeDataMovementPriorities + changeDataMovementPriority + changeJobSubmissionPriorities + changeJobSubmissionPriority + cloneExperiment + createExperiment + createProject + deleteApplicationDeployment + deleteApplicationInterface + deleteApplicationModule + deleteBatchQueue + deleteComputeResource + deleteDataMovementInterface + deleteExperiment + deleteGateway + deleteGatewayComputeResourcePreference + deleteGatewayResourceProfile + deleteGatewayStoragePreference + deleteJobSubmissionInterface + deleteProject + deleteResourceJobManager + deleteSSHPubKey + deleteStorageResource + deleteWorkflow + generateAndRegisterSSHKeys + getAPIVersion + getAllAppModules + getAllApplicationDeployments + getAllApplicationInterfaceNames + getAllApplicationInterfaces + getAllComputeResourceNames + getAllGatewayComputeResourcePreferences + getAllGatewayResourceProfiles + getAllGatewaySSHPubKeys + getAllGatewayStoragePreferences + getAllGateways + getAllStorageResourceNames + getAllUserSSHPubKeys + getAllWorkflows + getAppModuleDeployedResources + getApplicationDeployment + getApplicationInputs + getApplicationInterface + getApplicationModule + getApplicationOutputs + getAvailableAppInterfaceComputeResources + getCloudJobSubmission + getComputeResource + getDataResource + getDetailedExperimentTree + getExperiment + getExperimentOutputs + getExperimentStatistics + getExperimentStatus + getExperimentsInProject + getGateway + getGatewayComputeResourcePreference + getGatewayResourceProfile + getGatewayStoragePreference + getGridFTPDataMovement + getIntermediateOutputs + getJobDetails + getJobStatuses + getLocalDataMovement + getLocalJobSubmission + getProject + getResourceJobManager + getSCPDataMovement + getSSHJobSubmission + getSSHPubKey + getStorageResource + getUnicoreDataMovement + getUnicoreJobSubmission + getUserExperiments + getUserProjects + getWorkflow + getWorkflowTemplateId + isGatewayExist + isWorkflowExistWithName + launchExperiment + registerApplicationDeployment + registerApplicationInterface + registerApplicationModule + registerComputeResource + registerDataResource + registerGatewayResourceProfile + registerResourceJobManager + registerStorageResource + registerWorkflow + removeDataResource + searchExperiments + searchExperimentsByApplication + searchExperimentsByCreationTime + searchExperimentsByDesc + searchExperimentsByName + searchExperimentsByStatus + searchProjectsByProjectDesc + searchProjectsByProjectName + terminateExperiment + updateApplicationDeployment + updateApplicationInterface + updateApplicationModule + updateCloudJobSubmissionDetails + updateComputeResource + updateDataResource + updateExperiment + updateExperimentConfiguration + updateGateway + updateGatewayComputeResourcePreference + updateGatewayResourceProfile + updateGatewayStoragePreference + updateGridFTPDataMovementDetails + updateLocalDataMovementDetails + updateLocalSubmissionDetails + updateProject + updateResourceJobManager + updateResourceScheduleing + updateSCPDataMovementDetails + updateSSHJobSubmissionDetails + updateStorageResource + updateUnicoreDataMovementDetails + updateUnicoreJobSubmissionDetails + updateWorkflow + validateExperiment + +		`AIRAVATA_API_VERSION` +
airavata_errors		AiravataClientException +AiravataErrorType +AiravataSystemException +AuthenticationException +AuthorizationException +ExperimentNotFoundException +InvalidRequestException +LaunchValidationException +ProjectNotFoundException +TimedOutException +ValidationResults +ValidatorResult +
experiment_model		ExperimentModel +ExperimentSearchFields +ExperimentStatistics +ExperimentSummaryModel +ExperimentType +UserConfigurationDataModel +
airavata_commons		ErrorModel +ValidationResults +ValidatorResult +	`DEFAULT_ID` +
application_io_models		DataType +InputDataObjectType +OutputDataObjectType +
compute_resource_model		BatchQueue +CloudJobSubmission +ComputeResourceDescription +DMType +FileSystems +GlobusJobSubmission +JobManagerCommand +JobSubmissionInterface +JobSubmissionProtocol +LOCALSubmission +MonitorMode +ProviderName +ResourceJobManager +ResourceJobManagerType +SSHJobSubmission +UnicoreJobSubmission +
data_movement_models		DMType +DataMovementInterface +DataMovementProtocol +GridFTPDataMovement +LOCALDataMovement +SCPDataMovement +SecurityProtocol +UnicoreDataMovement +
scheduling_model		ComputationalResourceSchedulingModel +
status_models		ExperimentState +ExperimentStatus +JobState +JobStatus +ProcessState +ProcessStatus +TaskState +TaskStatus +
process_model		ProcessModel +
task_model		DataStageType +DataStagingTaskModel +EnvironmentSetupTaskModel +JobSubmissionTaskModel +MonitorTaskModel +TaskModel +TaskTypes +
job_model		JobModel +
security_model		AuthzToken +
airavata_data_models
workspace_model		Gateway +Group +Project +User +
messaging_events		ExperimentStatusChangeEvent +JobIdentifier +JobStatusChangeEvent +JobStatusChangeRequestEvent +Message +MessageLevel +MessageType +ProcessIdentifier +ProcessStatusChangeEvent +ProcessStatusChangeRequestEvent +ProcessSubmitEvent +ProcessTerminateEvent +TaskIdentifier +TaskOutputChangeEvent +TaskStatusChangeEvent +TaskStatusChangeRequestEvent +
replica_catalog_models		DataReplicaLocationModel +DataResourceModel +DataResourceType +ReplicaLocationCategory +ReplicaPersistentType +
application_deployment_model		ApplicationDeploymentDescription +ApplicationModule +ApplicationParallelismType +CommandObject +SetEnvPaths +
application_interface_model		ApplicationInterfaceDescription +
storage_resource_model		StorageResourceDescription +
gateway_resource_profile_model		ComputeResourcePreference +GatewayResourceProfile +StoragePreference +
workflow_data_model		Workflow +

Added: airavata/site/trunk/content/documentation/api-docs/0.16/job_model.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/job_model.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/job_model.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/job_model.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,32 @@ + + + + + +Thrift module: job_model +

Thrift module: job_model

+ + + + + +

Module	Services	Data types	Constants
job_model		JobModel +

Data structures

Struct: JobModel

+ + + + + + + + + + + + + +

Key	Field	Type	Requiredness
1	jobId	`string`	required
2	taskId	`string`	required
3	processId	`string`	required
4	jobDescription	`string`	required
5	creationTime	`i64`	optional
6	jobStatus	`status_models.JobStatus`	optional
7	computeResourceConsumed	`string`	optional
8	jobName	`string`	optional
9	workingDir	`string`	optional
10	stdOut	`string`	optional
11	stdErr	`string`	optional
12	exitCode	`i32`	optional

Added: airavata/site/trunk/content/documentation/api-docs/0.16/messaging_events.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/messaging_events.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/messaging_events.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/messaging_events.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,131 @@ + + + + + +Thrift module: messaging_events +

Thrift module: messaging_events

+ + + + + +

Module	Services	Data types	Constants
messaging_events		ExperimentStatusChangeEvent +JobIdentifier +JobStatusChangeEvent +JobStatusChangeRequestEvent +Message +MessageLevel +MessageType +ProcessIdentifier +ProcessStatusChangeEvent +ProcessStatusChangeRequestEvent +ProcessSubmitEvent +ProcessTerminateEvent +TaskIdentifier +TaskOutputChangeEvent +TaskStatusChangeEvent +TaskStatusChangeRequestEvent +

Enumerations

Enumeration: MessageLevel

+
+ + + + +

`INFO`	`0`	+
`DEBUG`	`1`	+
`ERROR`	`2`	+
`ACK`	`3`	+

Enumeration: MessageType

+
+ + + + + + + +

`EXPERIMENT`	`0`	+
`TASK`	`1`	+
`PROCESS`	`2`	+
`JOB`	`3`	+
`LAUNCHPROCESS`	`4`	+
`TERMINATEPROCESS`	`5`	+
`PROCESSOUTPUT`	`6`	+

Data structures

Struct: ExperimentStatusChangeEvent

+ + + + +

Key	Field	Type	Requiredness
1	state	`status_models.ExperimentState`	required
2	experimentId	`string`	required
3	gatewayId	`string`	required

Struct: ProcessIdentifier

+ + + + +

Key	Field	Type	Requiredness
1	processId	`string`	required
2	experimentId	`string`	required
3	gatewayId	`string`	required

Struct: TaskIdentifier

+ + + + + +

Key	Field	Type	Requiredness
1	taskId	`string`	required
2	processId	`string`	required
3	experimentId	`string`	required
4	gatewayId	`string`	required

Struct: TaskStatusChangeEvent

+ + + +

Key	Field	Type	Description	Requiredness	Default value
1	state	`status_models.TaskState`		required
2	taskIdentity	`TaskIdentifier`		required

Struct: TaskStatusChangeRequestEvent

+ + + +

Key	Field	Type	Description	Requiredness	Default value
1	state	`status_models.TaskState`		required
2	taskIdentity	`TaskIdentifier`		required

Struct: ProcessStatusChangeEvent

+ + + +

Key	Field	Type	Description	Requiredness	Default value
1	state	`status_models.ProcessState`		required
2	processIdentity	`ProcessIdentifier`		required

Struct: ProcessStatusChangeRequestEvent

+ + + +

Key	Field	Type	Description	Requiredness	Default value
1	state	`status_models.ProcessState`		required
2	processIdentity	`ProcessIdentifier`		required

Struct: TaskOutputChangeEvent

+ + + +

Key	Field	Type	Description	Requiredness	Default value
1	output	`list<application_io_models.OutputDataObjectType>`		required
2	taskIdentity	`TaskIdentifier`		required

Struct: JobIdentifier

+ + + + + + +

Key	Field	Type	Requiredness
1	jobId	`string`	required
2	taskId	`string`	required
3	processId	`string`	required
4	experimentId	`string`	required
5	gatewayId	`string`	required

Struct: ProcessSubmitEvent

+ + + + + +

Key	Field	Type	Requiredness
1	processId	`string`	required
2	gatewayId	`string`	required
3	experimentId	`string`	required
4	tokenId	`string`	required

Struct: ProcessTerminateEvent

+ + + + +

Key	Field	Type	Requiredness
1	processId	`string`	required
2	gatewayId	`string`	required
3	tokenId	`string`	required

Struct: JobStatusChangeEvent

+ + + +

Key	Field	Type	Description	Requiredness	Default value
1	state	`status_models.JobState`		required
2	jobIdentity	`JobIdentifier`		required

Struct: JobStatusChangeRequestEvent

+ + + +

Key	Field	Type	Description	Requiredness	Default value
1	state	`status_models.JobState`		required
2	jobIdentity	`JobIdentifier`		required

Struct: Message

+ + + + + + +

Key	Field	Type	Requiredness	Default value
1	event	`binary`	required
2	messageId	`string`	required	`"DO_NOT_SET_AT_CLIENTS"`
3	messageType	`MessageType`	required
4	updatedTime	`i64`	optional
5	messageLevel	`MessageLevel`	optional

Added: airavata/site/trunk/content/documentation/api-docs/0.16/process_model.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/process_model.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/process_model.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/process_model.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,48 @@ + + + + + +Thrift module: process_model +

Thrift module: process_model

+ + + + + +

Module	Services	Data types	Constants
process_model		ProcessModel +

Data structures

Struct: ProcessModel

+ + + + + + + + + + + + + + + + + + + + + + +

Key	Field	Type	Requiredness	Default value
1	processId	`string`	required	`"DO_NOT_SET_AT_CLIENTS"`
2	experimentId	`string`	required
3	creationTime	`i64`	optional
4	lastUpdateTime	`i64`	optional
5	processStatus	`status_models.ProcessStatus`	optional
6	processDetail	`string`	optional
7	applicationInterfaceId	`string`	optional
8	applicationDeploymentId	`string`	optional
9	computeResourceId	`string`	optional
10	processInputs	`list<application_io_models.InputDataObjectType>`	optional
11	processOutputs	`list<application_io_models.OutputDataObjectType>`	optional
12	resourceSchedule	`scheduling_model.ComputationalResourceSchedulingModel`	optional
13	tasks	`list<task_model.TaskModel>`	optional
14	taskDag	`string`	optional
15	processError	`airavata_commons.ErrorModel`	optional
16	gatewayExecutionId	`string`	optional
17	enableEmailNotification	`bool`	optional
18	emailAddresses	`list<string>`	optional
19	storageResourceId	`string`	optional
20	userDn	`string`	optional
21	generateCert	`bool`	optional	`false`

ProcessModel: A structure holding the process details. The infromation is derived based on user provided + configuration data or system inferred information from scheduling and QoS parameters. + +processDetail: + A friendly description of the process, usally used to communicate information to users. + + +

Added: airavata/site/trunk/content/documentation/api-docs/0.16/replica_catalog_models.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/replica_catalog_models.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/replica_catalog_models.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/replica_catalog_models.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,80 @@ + + + + + +Thrift module: replica_catalog_models +

Thrift module: replica_catalog_models

+ + + + + +

Module	Services	Data types	Constants
replica_catalog_models		DataReplicaLocationModel +DataResourceModel +DataResourceType +ReplicaLocationCategory +ReplicaPersistentType +

Enumerations

Enumeration: ReplicaLocationCategory

+
+ + + + +

`GATEWAY_DATA_STORE`	`0`	+
`COMPUTE_RESOURCE`	`1`	+
`LONG_TERM_STORAGE_RESOURCE`	`2`	+
`OTHER`	`3`	+

Enumeration: ReplicaPersistentType

+
+ + +

`TRANSIENT`	`0`	+
`PERSISTENT`	`1`	+

Enumeration: DataResourceType

+
+ + +

`COLLECTION`	`0`	+
`FILE`	`1`	+

Data structures

Struct: DataResourceModel

+ + + + + + + + + + + + + + +

Key	Field	Type	Requiredness
1	resourceId	`string`	optional
2	gatewayId	`string`	optional
3	parentResourceId	`string`	optional
4	resourceName	`string`	optional
5	resourceDescription	`string`	optional
6	ownerName	`string`	optional
7	dataResourceType	`DataResourceType`	optional
8	resourceSize	`i32`	optional
9	creationTime	`i64`	optional
10	lastModifiedTime	`i64`	optional
11	resourceMetadata	`map<string, string>`	optional
12	replicaLocations	`list<DataReplicaLocationModel>`	optional
13	childResources	`list<DataResourceModel>`	optional

Struct: DataReplicaLocationModel

+ + + + + + + + + + + + + + + + +

Key	Field	Type	Requiredness
1	replicaId	`string`	optional
2	resourceId	`string`	optional
3	replicaName	`string`	optional
4	replicaDescription	`string`	optional
5	creationTime	`i64`	optional
6	lastModifiedTime	`i64`	optional
7	replicaLocationCategory	`ReplicaLocationCategory`	optional
8	replicaPersistentType	`ReplicaPersistentType`	optional
9	storageResourceId	`string`	optional
10	storageResourceHostName	`string`	optional
11	dataMovementProtocol	`data_movement_models.DataMovementProtocol`	optional
12	hostPort	`i64`	optional
13	filePath	`string`	optional
14	replicaUrl	`string`	optional
15	replicaMetadata	`map<string, string>`	optional

Added: airavata/site/trunk/content/documentation/api-docs/0.16/scheduling_model.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/scheduling_model.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/scheduling_model.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/scheduling_model.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,32 @@ + + + + + +Thrift module: scheduling_model +

Thrift module: scheduling_model

+ + + + + +

Module	Services	Data types	Constants
scheduling_model		ComputationalResourceSchedulingModel +

Data structures

Struct: ComputationalResourceSchedulingModel

+ + + + + + + + + + +

Key	Field	Type	Requiredness
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	totalPhysicalMemory	`i32`	optional
8	chessisNumber	`string`	optional
9	staticWorkingDir	`string`	optional

ComputationalResourceSchedulingModel: + + +

Added: airavata/site/trunk/content/documentation/api-docs/0.16/security_model.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/security_model.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/security_model.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/security_model.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,22 @@ + + + + + +Thrift module: security_model +

Thrift module: security_model

+ + + + + +

Module	Services	Data types	Constants
security_model		AuthzToken +

Data structures

Struct: AuthzToken

+ + + +

Key	Field	Type	Description	Requiredness	Default value
1	accessToken	`string`		required
2	claimsMap	`map<string, string>`		optional

Added: airavata/site/trunk/content/documentation/api-docs/0.16/status_models.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/status_models.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/status_models.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/status_models.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,141 @@ + + + + + +Thrift module: status_models +

Thrift module: status_models

+ + + + + +

Module	Services	Data types	Constants
status_models		ExperimentState +ExperimentStatus +JobState +JobStatus +ProcessState +ProcessStatus +TaskState +TaskStatus +

Enumerations

Enumeration: ExperimentState

+
+ + + + + + + + + +

`CREATED`	`0`	+
`VALIDATED`	`1`	+
`SCHEDULED`	`2`	+
`LAUNCHED`	`3`	+
`EXECUTING`	`4`	+
`CANCELING`	`5`	+
`CANCELED`	`6`	+
`COMPLETED`	`7`	+
`FAILED`	`8`	+

Enumeration: TaskState

+
+ + + + + +

`CREATED`	`0`	+
`EXECUTING`	`1`	+
`COMPLETED`	`2`	+
`FAILED`	`3`	+
`CANCELED`	`4`	+

Enumeration: ProcessState

+
+ + + + + + + + + + + + + + +

`CREATED`	`0`	+
`VALIDATED`	`1`	+
`STARTED`	`2`	+
`PRE_PROCESSING`	`3`	+
`CONFIGURING_WORKSPACE`	`4`	+
`INPUT_DATA_STAGING`	`5`	+
`EXECUTING`	`6`	+
`MONITORING`	`7`	+
`OUTPUT_DATA_STAGING`	`8`	+
`POST_PROCESSING`	`9`	+
`COMPLETED`	`10`	+
`FAILED`	`11`	+
`CANCELLING`	`12`	+
`CANCELED`	`13`	+

Enumeration: JobState

+
+ + + + + + + + +

`SUBMITTED`	`0`	+
`QUEUED`	`1`	+
`ACTIVE`	`2`	+
`COMPLETE`	`3`	+
`CANCELED`	`4`	+
`FAILED`	`5`	+
`SUSPENDED`	`6`	+
`UNKNOWN`	`7`	+

Data structures

Struct: ExperimentStatus

+ + + + +

Key	Field	Type	Requiredness
1	state	`ExperimentState`	required
2	timeOfStateChange	`i64`	optional
3	reason	`string`	optional

Status: A generic status object. + +state: + State . + +timeOfStateChange: + time the status was last updated. + +reason: + User friendly reason on how the state is inferred. + +

Struct: ProcessStatus

+ + + + +

Key	Field	Type	Requiredness
1	state	`ProcessState`	required
2	timeOfStateChange	`i64`	optional
3	reason	`string`	optional

Struct: TaskStatus

+ + + + +

Key	Field	Type	Requiredness
1	state	`TaskState`	required
2	timeOfStateChange	`i64`	optional
3	reason	`string`	optional

Struct: JobStatus

+ + + + +

Key	Field	Type	Requiredness
1	jobState	`JobState`	required
2	timeOfStateChange	`i64`	optional
3	reason	`string`	optional

Added: airavata/site/trunk/content/documentation/api-docs/0.16/storage_resource_model.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/storage_resource_model.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/storage_resource_model.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/storage_resource_model.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,40 @@ + + + + + +Thrift module: storage_resource_model +

Thrift module: storage_resource_model

+ + + + + +

Module	Services	Data types	Constants
storage_resource_model		StorageResourceDescription +

Data structures

Struct: StorageResourceDescription

+ + + + + + +

Key	Field	Type	Requiredness	Default value
1	storageResourceId	`string`	required	`"DO_NOT_SET_AT_CLIENTS"`
2	hostName	`string`	required
3	storageResourceDescription	`string`	optional
4	enabled	`bool`	optional
5	dataMovementInterfaces	`list<data_movement_models.DataMovementInterface>`	optional

Storage Resource Description + +storageResourceId: Airavata Internal Unique Identifier to distinguish Compute Resource. + +hostName: + Fully Qualified Host Name. + +storageResourceDescription: + A user friendly description of the resource. + + +DataMovementProtocol: + Option to specify a prefered data movement mechanism of the available options. + + +

Added: airavata/site/trunk/content/documentation/api-docs/0.16/style.css URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/style.css?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/style.css (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/style.css Wed Dec 16 16:25:38 2015 @@ -0,0 +1,184 @@ +/*! + * Bootstrap v2.0.3 + * + * Copyright 2012 Twitter, Inc + * Licensed under the Apache License v2.0 + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Designed and built with all the love in the world @twitter by @mdo and @fat. + */ +.clearfix{*zoom:1;}.clearfix:before,.clearfix:after{display:table;content:"";} +.clearfix:after{clear:both;} +.hide-text{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0;} +.input-block-level{display:block;width:100%;min-height:28px;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;-ms-box-sizing:border-box;box-sizing:border-box;} +article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block;} +audio,canvas,video{display:inline-block;*display:inline;*zoom:1;} +audio:not([controls]){display:none;} +html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%;} +a:focus{outline:thin dotted #333;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px;} +a:hover,a:active{outline:0;} +sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline;} +sup{top:-0.5em;} +sub{bottom:-0.25em;} +img{max-width:100%;vertical-align:middle;border:0;-ms-interpolation-mode:bicubic;} +button,input,select,textarea{margin:0;font-size:100%;vertical-align:middle;} +button,input{*overflow:visible;line-height:normal;} +button::-moz-focus-inner,input::-moz-focus-inner{padding:0;border:0;} +button,input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button;} +input[type="search"]{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;-webkit-appearance:textfield;} +input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none;} +textarea{overflow:auto;vertical-align:top;} +body{margin:0;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:13px;line-height:18px;color:#333333;background-color:#ffffff;} +a{color:#0088cc;text-decoration:none;} +a:hover{color:#005580;text-decoration:underline;} +.row{margin-left:-20px;*zoom:1;}.row:before,.row:after{display:table;content:"";} +.row:after{clear:both;} +[class*="span"]{float:left;margin-left:20px;} +.container,.navbar-fixed-top .container,.navbar-fixed-bottom .container{width:940px;} +.span12{width:940px;} +.span11{width:860px;} +.span10{width:780px;} +.span9{width:700px;} +.span8{width:620px;} +.span7{width:540px;} +.span6{width:460px;} +.span5{width:380px;} +.span4{width:300px;} +.span3{width:220px;} +.span2{width:140px;} +.span1{width:60px;} +.offset12{margin-left:980px;} +.offset11{margin-left:900px;} +.offset10{margin-left:820px;} +.offset9{margin-left:740px;} +.offset8{margin-left:660px;} +.offset7{margin-left:580px;} +.offset6{margin-left:500px;} +.offset5{margin-left:420px;} +.offset4{margin-left:340px;} +.offset3{margin-left:260px;} +.offset2{margin-left:180px;} +.offset1{margin-left:100px;} +.row-fluid{width:100%;*zoom:1;}.row-fluid:before,.row-fluid:after{display:table;content:"";} +.row-fluid:after{clear:both;} +.row-fluid [class*="span"]{display:block;width:100%;min-height:28px;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;-ms-box-sizing:border-box;box-sizing:border-box;float:left;margin-left:2.127659574%;*margin-left:2.0744680846382977%;} +.row-fluid [class*="span"]:first-child{margin-left:0;} +.row-fluid .span12{width:99.99999998999999%;*width:99.94680850063828%;} +.row-fluid .span11{width:91.489361693%;*width:91.4361702036383%;} +.row-fluid .span10{width:82.97872339599999%;*width:82.92553190663828%;} +.row-fluid .span9{width:74.468085099%;*width:74.4148936096383%;} +.row-fluid .span8{width:65.95744680199999%;*width:65.90425531263828%;} +.row-fluid .span7{width:57.446808505%;*width:57.3936170156383%;} +.row-fluid .span6{width:48.93617020799999%;*width:48.88297871863829%;} +.row-fluid .span5{width:40.425531911%;*width:40.3723404216383%;} +.row-fluid .span4{width:31.914893614%;*width:31.8617021246383%;} +.row-fluid .span3{width:23.404255317%;*width:23.3510638276383%;} +.row-fluid .span2{width:14.89361702%;*width:14.8404255306383%;} +.row-fluid .span1{width:6.382978723%;*width:6.329787233638298%;} +.container{margin-right:auto;margin-left:auto;*zoom:1;}.container:before,.container:after{display:table;content:"";} +.container:after{clear:both;} +.container-fluid{padding-right:20px;padding-left:20px;*zoom:1;}.container-fluid:before,.container-fluid:after{display:table;content:"";} +.container-fluid:after{clear:both;} +p{margin:0 0 9px;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:13px;line-height:18px;}p small{font-size:11px;color:#999999;} +.lead{margin-bottom:18px;font-size:20px;font-weight:200;line-height:27px;} +h1,h2,h3,h4,h5,h6{margin:0;font-family:inherit;font-weight:bold;color:inherit;text-rendering:optimizelegibility;}h1 small,h2 small,h3 small,h4 small,h5 small,h6 small{font-weight:normal;color:#999999;} +h1{font-size:30px;line-height:36px;}h1 small{font-size:18px;} +h2{font-size:24px;line-height:36px;}h2 small{font-size:18px;} +h3{font-size:18px;line-height:27px;}h3 small{font-size:14px;} +h4,h5,h6{line-height:18px;} +h4{font-size:14px;}h4 small{font-size:12px;} +h5{font-size:12px;} +h6{font-size:11px;color:#999999;text-transform:uppercase;} +.page-header{padding-bottom:17px;margin:18px 0;border-bottom:1px solid #eeeeee;} +.page-header h1{line-height:1;} +ul,ol{padding:0;margin:0 0 9px 25px;} +ul ul,ul ol,ol ol,ol ul{margin-bottom:0;} +ul{list-style:disc;} +ol{list-style:decimal;} +li{line-height:18px;} +ul.unstyled,ol.unstyled{margin-left:0;list-style:none;} +dl{margin-bottom:18px;} +dt,dd{line-height:18px;} +dt{font-weight:bold;line-height:17px;} +dd{margin-left:9px;} +.dl-horizontal dt{float:left;width:120px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;} +.dl-horizontal dd{margin-left:130px;} +hr{margin:18px 0;border:0;border-top:1px solid #eeeeee;border-bottom:1px solid #ffffff;} +strong{font-weight:bold;} +em{font-style:italic;} +.muted{color:#999999;} +abbr[title]{cursor:help;border-bottom:1px dotted #ddd;} +abbr.initialism{font-size:90%;text-transform:uppercase;} +blockquote{padding:0 0 0 15px;margin:0 0 18px;border-left:5px solid #eeeeee;}blockquote p{margin-bottom:0;font-size:16px;font-weight:300;line-height:22.5px;} +blockquote small{display:block;line-height:18px;color:#999999;}blockquote small:before{content:'\2014 \00A0';} +blockquote.pull-right{float:right;padding-right:15px;padding-left:0;border-right:5px solid #eeeeee;border-left:0;}blockquote.pull-right p,blockquote.pull-right small{text-align:right;} +q:before,q:after,blockquote:before,blockquote:after{content:"";} +address{display:block;margin-bottom:18px;font-style:normal;line-height:18px;} +small{font-size:100%;} +cite{font-style:normal;} +code,pre{padding:0 3px 2px;font-family:Menlo,Monaco,Consolas,"Courier New",monospace;font-size:12px;color:#333333;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px;} +code{padding:2px 4px;color:#d14;background-color:#f7f7f9;border:1px solid #e1e1e8;} +pre{display:block;padding:8.5px;margin:0 0 9px;font-size:12.025px;line-height:18px;word-break:break-all;word-wrap:break-word;white-space:pre;white-space:pre-wrap;background-color:#f5f5f5;border:1px solid #ccc;border:1px solid rgba(0, 0, 0, 0.15);-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px;}pre.prettyprint{margin-bottom:18px;} +pre code{padding:0;color:inherit;background-color:transparent;border:0;} +.pre-scrollable{max-height:340px;overflow-y:scroll;} +.label,.badge{font-size:10.998px;font-weight:bold;line-height:14px;color:#ffffff;vertical-align:baseline;white-space:nowrap;text-shadow:0 -1px 0 rgba(0, 0, 0, 0.25);background-color:#999999;} +.label{padding:1px 4px 2px;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px;} +.badge{padding:1px 9px 2px;-webkit-border-radius:9px;-moz-border-radius:9px;border-radius:9px;} +a.label:hover,a.badge:hover{color:#ffffff;text-decoration:none;cursor:pointer;} +.label-important,.badge-important{background-color:#b94a48;} +.label-important[href],.badge-important[href]{background-color:#953b39;} +.label-warning,.badge-warning{background-color:#f89406;} +.label-warning[href],.badge-warning[href]{background-color:#c67605;} +.label-success,.badge-success{background-color:#468847;} +.label-success[href],.badge-success[href]{background-color:#356635;} +.label-info,.badge-info{background-color:#3a87ad;} +.label-info[href],.badge-info[href]{background-color:#2d6987;} +.label-inverse,.badge-inverse{background-color:#333333;} +.label-inverse[href],.badge-inverse[href]{background-color:#1a1a1a;} +table{max-width:100%;background-color:transparent;border-collapse:collapse;border-spacing:0;} +.table{width:100%;margin-bottom:18px;}.table th,.table td{padding:8px;line-height:18px;text-align:left;vertical-align:top;border-top:1px solid #dddddd;} +.table th{font-weight:bold;} +.table thead th{vertical-align:bottom;} +.table caption+thead tr:first-child th,.table caption+thead tr:first-child td,.table colgroup+thead tr:first-child th,.table colgroup+thead tr:first-child td,.table thead:first-child tr:first-child th,.table thead:first-child tr:first-child td{border-top:0;} +.table tbody+tbody{border-top:2px solid #dddddd;} +.table-condensed th,.table-condensed td{padding:4px 5px;} +.table-bordered{border:1px solid #dddddd;border-collapse:separate;*border-collapse:collapsed;border-left:0;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px;}.table-bordered th,.table-bordered td{border-left:1px solid #dddddd;} +.table-bordered caption+thead tr:first-child th,.table-bordered caption+tbody tr:first-child th,.table-bordered caption+tbody tr:first-child td,.table-bordered colgroup+thead tr:first-child th,.table-bordered colgroup+tbody tr:first-child th,.table-bordered colgroup+tbody tr:first-child td,.table-bordered thead:first-child tr:first-child th,.table-bordered tbody:first-child tr:first-child th,.table-bordered tbody:first-child tr:first-child td{border-top:0;} +.table-bordered thead:first-child tr:first-child th:first-child,.table-bordered tbody:first-child tr:first-child td:first-child{-webkit-border-top-left-radius:4px;border-top-left-radius:4px;-moz-border-radius-topleft:4px;} +.table-bordered thead:first-child tr:first-child th:last-child,.table-bordered tbody:first-child tr:first-child td:last-child{-webkit-border-top-right-radius:4px;border-top-right-radius:4px;-moz-border-radius-topright:4px;} +.table-bordered thead:last-child tr:last-child th:first-child,.table-bordered tbody:last-child tr:last-child td:first-child{-webkit-border-radius:0 0 0 4px;-moz-border-radius:0 0 0 4px;border-radius:0 0 0 4px;-webkit-border-bottom-left-radius:4px;border-bottom-left-radius:4px;-moz-border-radius-bottomleft:4px;} +.table-bordered thead:last-child tr:last-child th:last-child,.table-bordered tbody:last-child tr:last-child td:last-child{-webkit-border-bottom-right-radius:4px;border-bottom-right-radius:4px;-moz-border-radius-bottomright:4px;} +.table-striped tbody tr:nth-child(odd) td,.table-striped tbody tr:nth-child(odd) th{background-color:#f9f9f9;} +.table tbody tr:hover td,.table tbody tr:hover th{background-color:#f5f5f5;} +table .span1{float:none;width:44px;margin-left:0;} +table .span2{float:none;width:124px;margin-left:0;} +table .span3{float:none;width:204px;margin-left:0;} +table .span4{float:none;width:284px;margin-left:0;} +table .span5{float:none;width:364px;margin-left:0;} +table .span6{float:none;width:444px;margin-left:0;} +table .span7{float:none;width:524px;margin-left:0;} +table .span8{float:none;width:604px;margin-left:0;} +table .span9{float:none;width:684px;margin-left:0;} +table .span10{float:none;width:764px;margin-left:0;} +table .span11{float:none;width:844px;margin-left:0;} +table .span12{float:none;width:924px;margin-left:0;} +table .span13{float:none;width:1004px;margin-left:0;} +table .span14{float:none;width:1084px;margin-left:0;} +table .span15{float:none;width:1164px;margin-left:0;} +table .span16{float:none;width:1244px;margin-left:0;} +table .span17{float:none;width:1324px;margin-left:0;} +table .span18{float:none;width:1404px;margin-left:0;} +table .span19{float:none;width:1484px;margin-left:0;} +table .span20{float:none;width:1564px;margin-left:0;} +table .span21{float:none;width:1644px;margin-left:0;} +table .span22{float:none;width:1724px;margin-left:0;} +table .span23{float:none;width:1804px;margin-left:0;} +table .span24{float:none;width:1884px;margin-left:0;} +/* Auto-generated CSS for generated Thrift docs */ +h3, h4 { margin-bottom: 6px; } +div.definition { border: 1px solid #CCC; margin-bottom: 10px; padding: 10px; } +div.extends { margin: -0.5em 0 1em 5em } +td { vertical-align: top; } +table { empty-cells: show; } +code { line-height: 20px; } +.table-bordered th, .table-bordered td { border-bottom: 1px solid #DDDDDD; } Added: airavata/site/trunk/content/documentation/api-docs/0.16/task_model.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/task_model.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/task_model.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/task_model.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,97 @@ + + + + + +Thrift module: task_model +

Thrift module: task_model

+ + + + + +

Module	Services	Data types	Constants
task_model		DataStageType +DataStagingTaskModel +EnvironmentSetupTaskModel +JobSubmissionTaskModel +MonitorTaskModel +TaskModel +TaskTypes +

Enumerations

Enumeration: TaskTypes

+TaskTypes: An enumerated list of TaskTypes. Task being generic, the task type will provide the concrete interpretation. + +

+ + + + + + +

`ENV_SETUP`	`0`	+
`DATA_STAGING`	`1`	+
`JOB_SUBMISSION`	`2`	+
`ENV_CLEANUP`	`3`	+
`MONITORING`	`4`	+
`OUTPUT_FETCHING`	`5`	+

Enumeration: DataStageType

+DataStagingTaskModel: A structure holding the data staging task details. + +Source and Destination locations includes standard representation of protocol, host, port and path + A friendly description of the task, usally used to communicate information to users. + +

+ + +

`INPUT`	`0`	+
`OUPUT`	`1`	+

Data structures

Struct: TaskModel

+ + + + + + + + + + + +

Key	Field	Type	Requiredness	Default value
1	taskId	`string`	required	`"DO_NOT_SET_AT_CLIENTS"`
2	taskType	`TaskTypes`	required
3	parentProcessId	`string`	required
4	creationTime	`i64`	required
5	lastUpdateTime	`i64`	required
6	taskStatus	`status_models.TaskStatus`	required
7	taskDetail	`string`	optional
8	subTaskModel	`binary`	optional
9	taskError	`airavata_commons.ErrorModel`	optional
10	jobs	`list<job_model.JobModel>`	optional

TaskModel: A structure holding the generic task details. + +taskDetail: + A friendly description of the task, usally used to communicate information to users. + +subTaskModel: + A generic byte object for the Task developer to store internal serialized data into registry catalogs. +

Struct: DataStagingTaskModel

+ + + + + + + + + +

Key	Field	Type	Requiredness
1	source	`string`	required
2	destination	`string`	required
3	type	`DataStageType`	required
4	transferStartTime	`i64`	optional
5	transferEndTime	`i64`	optional
6	transferRate	`string`	optional
7	processInput	`application_io_models.InputDataObjectType`	optional
8	processOutput	`application_io_models.OutputDataObjectType`	optional

Struct: EnvironmentSetupTaskModel

+ + + +

Key	Field	Type	Description	Requiredness	Default value
1	location	`string`		required
2	protocol	`data_movement_models.SecurityProtocol`		required

EnvironmentSetupTaskModel: A structure holding the environment creation task details + +

Struct: JobSubmissionTaskModel

+ + + + +

Key	Field	Type	Requiredness
1	jobSubmissionProtocol	`compute_resource_model.JobSubmissionProtocol`	required
2	monitorMode	`compute_resource_model.MonitorMode`	required
3	wallTime	`i32`	optional

Struct: MonitorTaskModel

+ + +

Key	Field	Type	Description	Requiredness	Default value
1	monitorMode	`compute_resource_model.MonitorMode`		required