You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by bu...@apache.org on 2014/07/10 18:41:20 UTC
svn commit: r915700 [1/2] - in /websites/staging/airavata/trunk/content: ./
documentation/api-docs/0.13/
Author: buildbot
Date: Thu Jul 10 16:41:20 2014
New Revision: 915700
Log:
Staging update by buildbot for airavata
Modified:
websites/staging/airavata/trunk/content/ (props changed)
websites/staging/airavata/trunk/content/documentation/api-docs/0.13/airavataAPI.html
websites/staging/airavata/trunk/content/documentation/api-docs/0.13/applicationDeploymentModel.html
websites/staging/airavata/trunk/content/documentation/api-docs/0.13/applicationInterfaceModel.html
websites/staging/airavata/trunk/content/documentation/api-docs/0.13/computeResourceModel.html
websites/staging/airavata/trunk/content/documentation/api-docs/0.13/gatewayResourceProfileModel.html
websites/staging/airavata/trunk/content/documentation/api-docs/0.13/index.html
Propchange: websites/staging/airavata/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Jul 10 16:41:20 2014
@@ -1 +1 @@
-1607838
+1609497
Modified: websites/staging/airavata/trunk/content/documentation/api-docs/0.13/airavataAPI.html
==============================================================================
--- websites/staging/airavata/trunk/content/documentation/api-docs/0.13/airavataAPI.html (original)
+++ websites/staging/airavata/trunk/content/documentation/api-docs/0.13/airavataAPI.html Thu Jul 10 16:41:20 2014
@@ -11,14 +11,33 @@
<tr>
<td>airavataAPI</td><td><a href="#Svc_Airavata">Airavata</a><br/>
<ul>
+<li><a href="#Fn_Airavata_addGatewayComputeResourcePreference">addGatewayComputeResourcePreference</a></li>
+<li><a href="#Fn_Airavata_addGridFTPDataMovementDetails">addGridFTPDataMovementDetails</a></li>
+<li><a href="#Fn_Airavata_addLocalDataMovementDetails">addLocalDataMovementDetails</a></li>
+<li><a href="#Fn_Airavata_addLocalSubmissionDetails">addLocalSubmissionDetails</a></li>
+<li><a href="#Fn_Airavata_addSCPDataMovementDetails">addSCPDataMovementDetails</a></li>
+<li><a href="#Fn_Airavata_addSSHJobSubmissionDetails">addSSHJobSubmissionDetails</a></li>
+<li><a href="#Fn_Airavata_changeDataMovementPriorities">changeDataMovementPriorities</a></li>
+<li><a href="#Fn_Airavata_changeDataMovementPriority">changeDataMovementPriority</a></li>
+<li><a href="#Fn_Airavata_changeJobSubmissionPriorities">changeJobSubmissionPriorities</a></li>
+<li><a href="#Fn_Airavata_changeJobSubmissionPriority">changeJobSubmissionPriority</a></li>
<li><a href="#Fn_Airavata_cloneExperiment">cloneExperiment</a></li>
<li><a href="#Fn_Airavata_createExperiment">createExperiment</a></li>
<li><a href="#Fn_Airavata_createProject">createProject</a></li>
<li><a href="#Fn_Airavata_deleteApplicationDeployment">deleteApplicationDeployment</a></li>
<li><a href="#Fn_Airavata_deleteApplicationInterface">deleteApplicationInterface</a></li>
<li><a href="#Fn_Airavata_deleteApplicationModule">deleteApplicationModule</a></li>
+<li><a href="#Fn_Airavata_deleteComputeResource">deleteComputeResource</a></li>
+<li><a href="#Fn_Airavata_deleteDataMovementInterface">deleteDataMovementInterface</a></li>
+<li><a href="#Fn_Airavata_deleteGatewayComputeResourcePreference">deleteGatewayComputeResourcePreference</a></li>
+<li><a href="#Fn_Airavata_deleteGatewayResourceProfile">deleteGatewayResourceProfile</a></li>
+<li><a href="#Fn_Airavata_deleteJobSubmissionInterface">deleteJobSubmissionInterface</a></li>
<li><a href="#Fn_Airavata_getAPIVersion">getAPIVersion</a></li>
+<li><a href="#Fn_Airavata_getAllApplicationInterfaceNames">getAllApplicationInterfaceNames</a></li>
+<li><a href="#Fn_Airavata_getAllApplicationInterfaces">getAllApplicationInterfaces</a></li>
+<li><a href="#Fn_Airavata_getAllComputeResourceNames">getAllComputeResourceNames</a></li>
<li><a href="#Fn_Airavata_getAllExperimentsInProject">getAllExperimentsInProject</a></li>
+<li><a href="#Fn_Airavata_getAllGatewayComputeResourcePreferences">getAllGatewayComputeResourcePreferences</a></li>
<li><a href="#Fn_Airavata_getAllUserExperiments">getAllUserExperiments</a></li>
<li><a href="#Fn_Airavata_getAllUserProjects">getAllUserProjects</a></li>
<li><a href="#Fn_Airavata_getAppModuleDeployedResources">getAppModuleDeployedResources</a></li>
@@ -27,15 +46,21 @@
<li><a href="#Fn_Airavata_getApplicationInterface">getApplicationInterface</a></li>
<li><a href="#Fn_Airavata_getApplicationModule">getApplicationModule</a></li>
<li><a href="#Fn_Airavata_getApplicationOutputs">getApplicationOutputs</a></li>
+<li><a href="#Fn_Airavata_getAvailableAppInterfaceComputeResources">getAvailableAppInterfaceComputeResources</a></li>
+<li><a href="#Fn_Airavata_getComputeResource">getComputeResource</a></li>
<li><a href="#Fn_Airavata_getExperiment">getExperiment</a></li>
<li><a href="#Fn_Airavata_getExperimentOutputs">getExperimentOutputs</a></li>
<li><a href="#Fn_Airavata_getExperimentStatus">getExperimentStatus</a></li>
+<li><a href="#Fn_Airavata_getGatewayComputeResourcePreference">getGatewayComputeResourcePreference</a></li>
+<li><a href="#Fn_Airavata_getGatewayResourceProfile">getGatewayResourceProfile</a></li>
<li><a href="#Fn_Airavata_getJobStatuses">getJobStatuses</a></li>
<li><a href="#Fn_Airavata_getProject">getProject</a></li>
<li><a href="#Fn_Airavata_launchExperiment">launchExperiment</a></li>
<li><a href="#Fn_Airavata_registerApplicationDeployment">registerApplicationDeployment</a></li>
<li><a href="#Fn_Airavata_registerApplicationInterface">registerApplicationInterface</a></li>
<li><a href="#Fn_Airavata_registerApplicationModule">registerApplicationModule</a></li>
+<li><a href="#Fn_Airavata_registerComputeResource">registerComputeResource</a></li>
+<li><a href="#Fn_Airavata_registerGatewayResourceProfile">registerGatewayResourceProfile</a></li>
<li><a href="#Fn_Airavata_searchExperimentsByApplication">searchExperimentsByApplication</a></li>
<li><a href="#Fn_Airavata_searchExperimentsByDesc">searchExperimentsByDesc</a></li>
<li><a href="#Fn_Airavata_searchExperimentsByName">searchExperimentsByName</a></li>
@@ -45,10 +70,18 @@
<li><a href="#Fn_Airavata_updateApplicationDeployment">updateApplicationDeployment</a></li>
<li><a href="#Fn_Airavata_updateApplicationInterface">updateApplicationInterface</a></li>
<li><a href="#Fn_Airavata_updateApplicationModule">updateApplicationModule</a></li>
+<li><a href="#Fn_Airavata_updateComputeResource">updateComputeResource</a></li>
<li><a href="#Fn_Airavata_updateExperiment">updateExperiment</a></li>
<li><a href="#Fn_Airavata_updateExperimentConfiguration">updateExperimentConfiguration</a></li>
+<li><a href="#Fn_Airavata_updateGatewayComputeResourcePreference">updateGatewayComputeResourcePreference</a></li>
+<li><a href="#Fn_Airavata_updateGatewayResourceProfile">updateGatewayResourceProfile</a></li>
+<li><a href="#Fn_Airavata_updateGridFTPDataMovementDetails">updateGridFTPDataMovementDetails</a></li>
+<li><a href="#Fn_Airavata_updateLocalDataMovementDetails">updateLocalDataMovementDetails</a></li>
+<li><a href="#Fn_Airavata_updateLocalSubmissionDetails">updateLocalSubmissionDetails</a></li>
<li><a href="#Fn_Airavata_updateProject">updateProject</a></li>
<li><a href="#Fn_Airavata_updateResourceScheduleing">updateResourceScheduleing</a></li>
+<li><a href="#Fn_Airavata_updateSCPDataMovementDetails">updateSCPDataMovementDetails</a></li>
+<li><a href="#Fn_Airavata_updateSSHJobSubmissionDetails">updateSSHJobSubmissionDetails</a></li>
<li><a href="#Fn_Airavata_validateExperiment">validateExperiment</a></li>
</ul>
</td>
@@ -58,12 +91,24 @@
</tr></table>
<hr/><h2 id="Constants">Constants</h2>
<table class="table-bordered table-striped table-condensed"><thead><th>Constant</th><th>Type</th><th>Value</th></thead>
-<tr id="Const_AIRAVATA_API_VERSION"><td><code>AIRAVATA_API_VERSION</code></td><td><code>string</code></td><td><code>"0.12.0"</code></td></tr></table><hr/><h2 id="Services">Services</h2>
+<tr id="Const_AIRAVATA_API_VERSION"><td><code>AIRAVATA_API_VERSION</code></td><td><code>string</code></td><td><code>"0.13.0"</code></td></tr><tr><td colspan="3"><blockquote>Airavata Interface Versions depend upon this Thrift Interface File. When Making changes, please edit the
+ Version Constants according to Semantic Versioning Specification (SemVer) http://semver.org.
+<p/>
+Note: The Airavata API version may be different from the Airavata software release versions.
+<p/>
+The Airavata API version is composed as a dot delimited string with major, minor, and patch level components.
+<p/>
+ - Major: Incremented for backward incompatible changes. An example would be changes to interfaces.
+ - Minor: Incremented for backward compatible changes. An example would be the addition of a new optional methods.
+ - Patch: Incremented for bug fixes. The patch level should be increased for every edit that doesn't result
+ in a change to major/minor version numbers.
+<p/>
+<br/></blockquote></td></tr></table><hr/><h2 id="Services">Services</h2>
<h3 id="Svc_Airavata">Service: Airavata</h3>
<div class="definition"><h4 id="Fn_Airavata_getAPIVersion">Function: Airavata.getAPIVersion</h4>
<pre><code>string</code> getAPIVersion()
throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
-</pre>Query Airavata to fetch the API version
+</pre>Fetch Apache Airavata API version
<br/></div><div class="definition"><h4 id="Fn_Airavata_createProject">Function: Airavata.createProject</h4>
<pre><code>string</code> createProject(<code><a href="workspaceModel.html#Struct_Project">workspaceModel.Project</a></code> project)
throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
@@ -390,7 +435,6 @@
@return appModuleId
Returns a server-side generated airavata appModule globally unique identifier.
<p/>
-<p/>
<br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationModule">Function: Airavata.getApplicationModule</h4>
<pre><code><a href="applicationDeploymentModel.html#Struct_ApplicationModule">applicationDeploymentModel.ApplicationModule</a></code> getApplicationModule(<code>string</code> appModuleId)
throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
@@ -402,7 +446,6 @@
@return applicationModule
Returns a application Module Object.
<p/>
-<p/>
<br/></div><div class="definition"><h4 id="Fn_Airavata_updateApplicationModule">Function: Airavata.updateApplicationModule</h4>
<pre><code>bool</code> updateApplicationModule(<code>string</code> appModuleId,
<code><a href="applicationDeploymentModel.html#Struct_ApplicationModule">applicationDeploymentModel.ApplicationModule</a></code> applicationModule)
@@ -418,7 +461,6 @@
@return status
Returns a success/failure of the update.
<p/>
-<p/>
<br/></div><div class="definition"><h4 id="Fn_Airavata_deleteApplicationModule">Function: Airavata.deleteApplicationModule</h4>
<pre><code>bool</code> deleteApplicationModule(<code>string</code> appModuleId)
throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
@@ -430,7 +472,6 @@
@return status
Returns a success/failure of the deletion.
<p/>
-<p/>
<br/></div><div class="definition"><h4 id="Fn_Airavata_registerApplicationDeployment">Function: Airavata.registerApplicationDeployment</h4>
<pre><code>string</code> registerApplicationDeployment(<code><a href="applicationDeploymentModel.html#Struct_ApplicationDeploymentDescription">applicationDeploymentModel.ApplicationDeploymentDescription</a></code> applicationDeployment)
throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
@@ -442,7 +483,6 @@
@return appDeploymentId
Returns a server-side generated airavata appDeployment globally unique identifier.
<p/>
-<p/>
<br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationDeployment">Function: Airavata.getApplicationDeployment</h4>
<pre><code><a href="applicationDeploymentModel.html#Struct_ApplicationDeploymentDescription">applicationDeploymentModel.ApplicationDeploymentDescription</a></code> getApplicationDeployment(<code>string</code> appDeploymentId)
throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
@@ -454,7 +494,6 @@
@return applicationDeployment
Returns a application Deployment Object.
<p/>
-<p/>
<br/></div><div class="definition"><h4 id="Fn_Airavata_updateApplicationDeployment">Function: Airavata.updateApplicationDeployment</h4>
<pre><code>bool</code> updateApplicationDeployment(<code>string</code> appDeploymentId,
<code><a href="applicationDeploymentModel.html#Struct_ApplicationDeploymentDescription">applicationDeploymentModel.ApplicationDeploymentDescription</a></code> applicationDeployment)
@@ -470,7 +509,6 @@
@return status
Returns a success/failure of the update.
<p/>
-<p/>
<br/></div><div class="definition"><h4 id="Fn_Airavata_deleteApplicationDeployment">Function: Airavata.deleteApplicationDeployment</h4>
<pre><code>bool</code> deleteApplicationDeployment(<code>string</code> appDeploymentId)
throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
@@ -482,7 +520,6 @@
@return status
Returns a success/failure of the deletion.
<p/>
-<p/>
<br/></div><div class="definition"><h4 id="Fn_Airavata_getAppModuleDeployedResources">Function: Airavata.getAppModuleDeployedResources</h4>
<pre><code>list<<code>string</code>></code> getAppModuleDeployedResources(<code>string</code> appModuleId)
throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
@@ -505,7 +542,6 @@
@return appInterfaceId
Returns a server-side generated airavata application interface globally unique identifier.
<p/>
-<p/>
<br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationInterface">Function: Airavata.getApplicationInterface</h4>
<pre><code><a href="applicationInterfaceModel.html#Struct_ApplicationInterfaceDescription">applicationInterfaceModel.ApplicationInterfaceDescription</a></code> getApplicationInterface(<code>string</code> appInterfaceId)
throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
@@ -546,6 +582,24 @@
Returns a success/failure of the deletion.
<p/>
<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getAllApplicationInterfaceNames">Function: Airavata.getAllApplicationInterfaceNames</h4>
+<pre><code>map<<code>string</code>, <code>string</code>></code> getAllApplicationInterfaceNames()
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch name and id of Application Interface documents.
+<p/>
+<p/>
+@return map<applicationId, applicationInterfaceNames>
+ Returns a list of application interfaces with corresponsing id's
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getAllApplicationInterfaces">Function: Airavata.getAllApplicationInterfaces</h4>
+<pre><code>list<<code><a href="applicationInterfaceModel.html#Struct_ApplicationInterfaceDescription">applicationInterfaceModel.ApplicationInterfaceDescription</a></code>></code> getAllApplicationInterfaces()
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch all Application Interface documents.
+<p/>
+<p/>
+@return map<applicationId, applicationInterfaceNames>
+ Returns a list of application interfaces documents
+<p/>
<br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationInputs">Function: Airavata.getApplicationInputs</h4>
<pre><code>list<<code><a href="applicationInterfaceModel.html#Struct_InputDataObjectType">applicationInterfaceModel.InputDataObjectType</a></code>></code> getApplicationInputs(<code>string</code> appInterfaceId)
throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
@@ -568,4 +622,453 @@
@return list<applicationInterfaceModel.OutputDataObjectType>
Returns a list of application outputs.
<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getAvailableAppInterfaceComputeResources">Function: Airavata.getAvailableAppInterfaceComputeResources</h4>
+<pre><code>map<<code>string</code>, <code>string</code>></code> getAvailableAppInterfaceComputeResources(<code>string</code> appInterfaceId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch a list of all deployed Compute Hosts for a given application interfaces.
+<p/>
+@param appInterfaceId
+ The identifier for the requested application interface
+<p/>
+@return map<computeResourceId, computeResourceName>
+ A map of registered compute resource id's and their corresponding hostnames.
+ Deployments of each modules listed within the interfaces will be listed.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_registerComputeResource">Function: Airavata.registerComputeResource</h4>
+<pre><code>string</code> registerComputeResource(<code><a href="computeResourceModel.html#Struct_ComputeResourceDescription">computeResourceModel.ComputeResourceDescription</a></code> computeResourceDescription)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Register a Compute Resource.
+<p/>
+@param computeResourceDescription
+ Compute Resource Object created from the datamodel.
+<p/>
+@return computeResourceId
+ Returns a server-side generated airavata compute resource globally unique identifier.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getComputeResource">Function: Airavata.getComputeResource</h4>
+<pre><code><a href="computeResourceModel.html#Struct_ComputeResourceDescription">computeResourceModel.ComputeResourceDescription</a></code> getComputeResource(<code>string</code> computeResourceId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch the given Compute Resource.
+<p/>
+@param computeResourceId
+ The identifier for the requested compute resource
+<p/>
+@return computeResourceDescription
+ Compute Resource Object created from the datamodel..
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getAllComputeResourceNames">Function: Airavata.getAllComputeResourceNames</h4>
+<pre><code>map<<code>string</code>, <code>string</code>></code> getAllComputeResourceNames()
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch all registered Compute Resources.
+<p/>
+@return A map of registered compute resource id's and thier corresponding hostnames.
+ Compute Resource Object created from the datamodel..
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateComputeResource">Function: Airavata.updateComputeResource</h4>
+<pre><code>bool</code> updateComputeResource(<code>string</code> computeResourceId,
+ <code><a href="computeResourceModel.html#Struct_ComputeResourceDescription">computeResourceModel.ComputeResourceDescription</a></code> computeResourceDescription)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Update a Compute Resource.
+<p/>
+@param computeResourceId
+ The identifier for the requested compute resource to be updated.
+<p/>
+@param computeResourceDescription
+ Compute Resource Object created from the datamodel.
+<p/>
+@return status
+ Returns a success/failure of the update.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_deleteComputeResource">Function: Airavata.deleteComputeResource</h4>
+<pre><code>bool</code> deleteComputeResource(<code>string</code> computeResourceId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Delete a Compute Resource.
+<p/>
+@param computeResourceId
+ The identifier for the requested compute resource to be deleted.
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_addLocalSubmissionDetails">Function: Airavata.addLocalSubmissionDetails</h4>
+<pre><code>bool</code> addLocalSubmissionDetails(<code>string</code> computeResourceId,
+ <code>i32</code> priorityOrder,
+ <code><a href="computeResourceModel.html#Struct_LOCALSubmission">computeResourceModel.LOCALSubmission</a></code> localSubmission)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Add a Local Job Submission details to a compute resource
+ App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
+<p/>
+@param computeResourceId
+ The identifier of the compute resource to which JobSubmission protocol to be added
+<p/>
+@param priorityOrder
+ Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
+<p/>
+@param localSubmission
+ The LOCALSubmission object to be added to the resource.
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateLocalSubmissionDetails">Function: Airavata.updateLocalSubmissionDetails</h4>
+<pre><code>bool</code> updateLocalSubmissionDetails(<code>string</code> jobSubmissionInterfaceId,
+ <code><a href="computeResourceModel.html#Struct_LOCALSubmission">computeResourceModel.LOCALSubmission</a></code> localSubmission)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Update the given Local Job Submission details
+<p/>
+@param jobSubmissionInterfaceId
+ The identifier of the JobSubmission Interface to be updated.
+<p/>
+@param localSubmission
+ The LOCALSubmission object to be updated.
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_addSSHJobSubmissionDetails">Function: Airavata.addSSHJobSubmissionDetails</h4>
+<pre><code>bool</code> addSSHJobSubmissionDetails(<code>string</code> computeResourceId,
+ <code>i32</code> priorityOrder,
+ <code><a href="computeResourceModel.html#Struct_SSHJobSubmission">computeResourceModel.SSHJobSubmission</a></code> sshJobSubmission)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Add a SSH Job Submission details to a compute resource
+ App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
+<p/>
+@param computeResourceId
+ The identifier of the compute resource to which JobSubmission protocol to be added
+<p/>
+@param priorityOrder
+ Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
+<p/>
+@param sshJobSubmission
+ The SSHJobSubmission object to be added to the resource.
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateSSHJobSubmissionDetails">Function: Airavata.updateSSHJobSubmissionDetails</h4>
+<pre><code>bool</code> updateSSHJobSubmissionDetails(<code>string</code> jobSubmissionInterfaceId,
+ <code><a href="computeResourceModel.html#Struct_SSHJobSubmission">computeResourceModel.SSHJobSubmission</a></code> sshJobSubmission)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Update the given SSH Job Submission details
+<p/>
+@param jobSubmissionInterfaceId
+ The identifier of the JobSubmission Interface to be updated.
+<p/>
+@param sshJobSubmission
+ The SSHJobSubmission object to be updated.
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_addLocalDataMovementDetails">Function: Airavata.addLocalDataMovementDetails</h4>
+<pre><code>bool</code> addLocalDataMovementDetails(<code>string</code> computeResourceId,
+ <code>i32</code> priorityOrder,
+ <code><a href="computeResourceModel.html#Struct_LOCALDataMovement">computeResourceModel.LOCALDataMovement</a></code> localDataMovement)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Add a Local data movement details to a compute resource
+ App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
+<p/>
+@param computeResourceId
+ The identifier of the compute resource to which JobSubmission protocol to be added
+<p/>
+@param priorityOrder
+ Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
+<p/>
+@param localDataMovement
+ The LOCALDataMovement object to be added to the resource.
+<p/>
+@return status
+ Returns a success/failure of the addition.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateLocalDataMovementDetails">Function: Airavata.updateLocalDataMovementDetails</h4>
+<pre><code>bool</code> updateLocalDataMovementDetails(<code>string</code> jobSubmissionInterfaceId,
+ <code><a href="computeResourceModel.html#Struct_LOCALDataMovement">computeResourceModel.LOCALDataMovement</a></code> localDataMovement)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Update the given Local data movement details
+<p/>
+@param jobSubmissionInterfaceId
+ The identifier of the JobSubmission Interface to be updated.
+<p/>
+@param localDataMovement
+ The LOCALDataMovement object to be updated.
+<p/>
+@return status
+ Returns a success/failure of the update.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_addSCPDataMovementDetails">Function: Airavata.addSCPDataMovementDetails</h4>
+<pre><code>bool</code> addSCPDataMovementDetails(<code>string</code> computeResourceId,
+ <code>i32</code> priorityOrder,
+ <code><a href="computeResourceModel.html#Struct_SCPDataMovement">computeResourceModel.SCPDataMovement</a></code> scpDataMovement)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Add a SCP data movement details to a compute resource
+ App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
+<p/>
+@param computeResourceId
+ The identifier of the compute resource to which JobSubmission protocol to be added
+<p/>
+@param priorityOrder
+ Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
+<p/>
+@param scpDataMovement
+ The SCPDataMovement object to be added to the resource.
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateSCPDataMovementDetails">Function: Airavata.updateSCPDataMovementDetails</h4>
+<pre><code>bool</code> updateSCPDataMovementDetails(<code>string</code> jobSubmissionInterfaceId,
+ <code><a href="computeResourceModel.html#Struct_SCPDataMovement">computeResourceModel.SCPDataMovement</a></code> scpDataMovement)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Update the given scp data movement details
+ App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
+<p/>
+@param jobSubmissionInterfaceId
+ The identifier of the JobSubmission Interface to be updated.
+<p/>
+@param scpDataMovement
+ The SCPDataMovement object to be updated.
+<p/>
+@return status
+ Returns a success/failure of the update.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_addGridFTPDataMovementDetails">Function: Airavata.addGridFTPDataMovementDetails</h4>
+<pre><code>bool</code> addGridFTPDataMovementDetails(<code>string</code> computeResourceId,
+ <code>i32</code> priorityOrder,
+ <code><a href="computeResourceModel.html#Struct_GridFTPDataMovement">computeResourceModel.GridFTPDataMovement</a></code> gridFTPDataMovement)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Add a GridFTP data movement details to a compute resource
+ App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
+<p/>
+@param computeResourceId
+ The identifier of the compute resource to which JobSubmission protocol to be added
+<p/>
+@param priorityOrder
+ Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
+<p/>
+@param gridFTPDataMovement
+ The GridFTPDataMovement object to be added to the resource.
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateGridFTPDataMovementDetails">Function: Airavata.updateGridFTPDataMovementDetails</h4>
+<pre><code>bool</code> updateGridFTPDataMovementDetails(<code>string</code> jobSubmissionInterfaceId,
+ <code><a href="computeResourceModel.html#Struct_GridFTPDataMovement">computeResourceModel.GridFTPDataMovement</a></code> gridFTPDataMovement)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Update the given GridFTP data movement details to a compute resource
+ App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
+<p/>
+@param jobSubmissionInterfaceId
+ The identifier of the JobSubmission Interface to be updated.
+<p/>
+@param gridFTPDataMovement
+ The GridFTPDataMovement object to be updated.
+<p/>
+@return status
+ Returns a success/failure of the updation.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_changeJobSubmissionPriority">Function: Airavata.changeJobSubmissionPriority</h4>
+<pre><code>bool</code> changeJobSubmissionPriority(<code>string</code> jobSubmissionInterfaceId,
+ <code>i32</code> newPriorityOrder)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Change the priority of a given job submisison interface
+<p/>
+@param jobSubmissionInterfaceId
+ The identifier of the JobSubmission Interface to be changed
+<p/>
+@param priorityOrder
+ The new priority of the job manager interface.
+<p/>
+@return status
+ Returns a success/failure of the change.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_changeDataMovementPriority">Function: Airavata.changeDataMovementPriority</h4>
+<pre><code>bool</code> changeDataMovementPriority(<code>string</code> dataMovementInterfaceId,
+ <code>i32</code> newPriorityOrder)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Change the priority of a given data movement interface
+<p/>
+@param dataMovementInterfaceId
+ The identifier of the DataMovement Interface to be changed
+<p/>
+@param priorityOrder
+ The new priority of the data movement interface.
+<p/>
+@return status
+ Returns a success/failure of the change.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_changeJobSubmissionPriorities">Function: Airavata.changeJobSubmissionPriorities</h4>
+<pre><code>bool</code> changeJobSubmissionPriorities(<code>map<<code>string</code>, <code>i32</code>></code> jobSubmissionPriorityMap)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Change the priorities of a given set of job submission interfaces
+<p/>
+@param jobSubmissionPriorityMap
+ A Map of identifiers of the JobSubmission Interfaces and thier associated priorities to be set.
+<p/>
+@return status
+ Returns a success/failure of the changes.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_changeDataMovementPriorities">Function: Airavata.changeDataMovementPriorities</h4>
+<pre><code>bool</code> changeDataMovementPriorities(<code>map<<code>string</code>, <code>i32</code>></code> dataMovementPriorityMap)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Change the priorities of a given set of data movement interfaces
+<p/>
+@param dataMovementPriorityMap
+ A Map of identifiers of the DataMovement Interfaces and thier associated priorities to be set.
+<p/>
+@return status
+ Returns a success/failure of the changes.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_deleteJobSubmissionInterface">Function: Airavata.deleteJobSubmissionInterface</h4>
+<pre><code>bool</code> deleteJobSubmissionInterface(<code>string</code> jobSubmissionInterfaceId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Delete a given job submisison interface
+<p/>
+@param jobSubmissionInterfaceId
+ The identifier of the JobSubmission Interface to be changed
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_deleteDataMovementInterface">Function: Airavata.deleteDataMovementInterface</h4>
+<pre><code>bool</code> deleteDataMovementInterface(<code>string</code> dataMovementInterfaceId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Delete a given data movement interface
+<p/>
+@param dataMovementInterfaceId
+ The identifier of the DataMovement Interface to be changed
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_registerGatewayResourceProfile">Function: Airavata.registerGatewayResourceProfile</h4>
+<pre><code>string</code> registerGatewayResourceProfile(<code><a href="gatewayResourceProfileModel.html#Struct_GatewayResourceProfile">gatewayResourceProfileModel.GatewayResourceProfile</a></code> gatewayResourceProfile)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Register a Gateway Resource Profile.
+<p/>
+@param gatewayResourceProfile
+ Gateway Resource Profile Object.
+ The GatewayID should be obtained from Airavata gateway registration and passed to register a corresponding
+ resource profile.
+<p/>
+@return status
+ Returns a success/failure of the update.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getGatewayResourceProfile">Function: Airavata.getGatewayResourceProfile</h4>
+<pre><code><a href="gatewayResourceProfileModel.html#Struct_GatewayResourceProfile">gatewayResourceProfileModel.GatewayResourceProfile</a></code> getGatewayResourceProfile(<code>string</code> gatewayID)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch the given Gateway Resource Profile.
+<p/>
+@param gatewayID
+ The identifier for the requested gateway resource
+<p/>
+@return gatewayResourceProfile
+ Gateway Resource Profile Object.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateGatewayResourceProfile">Function: Airavata.updateGatewayResourceProfile</h4>
+<pre><code>bool</code> updateGatewayResourceProfile(<code>string</code> gatewayID,
+ <code><a href="gatewayResourceProfileModel.html#Struct_GatewayResourceProfile">gatewayResourceProfileModel.GatewayResourceProfile</a></code> gatewayResourceProfile)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Update a Gateway Resource Profile.
+<p/>
+@param gatewayID
+ The identifier for the requested gateway resource to be updated.
+<p/>
+@param gatewayResourceProfile
+ Gateway Resource Profile Object.
+<p/>
+@return status
+ Returns a success/failure of the update.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_deleteGatewayResourceProfile">Function: Airavata.deleteGatewayResourceProfile</h4>
+<pre><code>bool</code> deleteGatewayResourceProfile(<code>string</code> gatewayID)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Delete the given Gateway Resource Profile.
+<p/>
+@param gatewayID
+ The identifier for the requested gateway resource to be deleted.
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_addGatewayComputeResourcePreference">Function: Airavata.addGatewayComputeResourcePreference</h4>
+<pre><code>bool</code> addGatewayComputeResourcePreference(<code>string</code> gatewayID,
+ <code>string</code> computeResourceId,
+ <code><a href="gatewayResourceProfileModel.html#Struct_ComputeResourcePreference">gatewayResourceProfileModel.ComputeResourcePreference</a></code> computeResourcePreference)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Add a Compute Resource Preference to a registered gateway profile.
+<p/>
+@param gatewayID
+ The identifier for the gateway profile to be added.
+<p/>
+@param computeResourceId
+ Preferences related to a particular compute resource
+<p/>
+@param computeResourcePreference
+ The ComputeResourcePreference object to be added to the resource profile.
+<p/>
+@return status
+ Returns a success/failure of the addition. If a profile already exists, this operation will fail.
+ Instead an update should be used.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getGatewayComputeResourcePreference">Function: Airavata.getGatewayComputeResourcePreference</h4>
+<pre><code><a href="gatewayResourceProfileModel.html#Struct_ComputeResourcePreference">gatewayResourceProfileModel.ComputeResourcePreference</a></code> getGatewayComputeResourcePreference(<code>string</code> gatewayID,
+ <code>string</code> computeResourceId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch a Compute Resource Preference of a registered gateway profile.
+<p/>
+@param gatewayID
+ The identifier for the gateway profile to be requested
+<p/>
+@param computeResourceId
+ Preferences related to a particular compute resource
+<p/>
+@return computeResourcePreference
+ Returns the ComputeResourcePreference object.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getAllGatewayComputeResourcePreferences">Function: Airavata.getAllGatewayComputeResourcePreferences</h4>
+<pre><code>list<<code><a href="gatewayResourceProfileModel.html#Struct_ComputeResourcePreference">gatewayResourceProfileModel.ComputeResourcePreference</a></code>></code> getAllGatewayComputeResourcePreferences(<code>string</code> gatewayID)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch all Compute Resource Preferences of a registered gateway profile.
+<p/>
+@param gatewayID
+ The identifier for the gateway profile to be requested
+<p/>
+@return computeResourcePreference
+ Returns the ComputeResourcePreference object.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateGatewayComputeResourcePreference">Function: Airavata.updateGatewayComputeResourcePreference</h4>
+<pre><code>bool</code> updateGatewayComputeResourcePreference(<code>string</code> gatewayID,
+ <code>string</code> computeResourceId,
+ <code><a href="gatewayResourceProfileModel.html#Struct_ComputeResourcePreference">gatewayResourceProfileModel.ComputeResourcePreference</a></code> computeResourcePreference)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Update a Compute Resource Preference to a registered gateway profile.
+<p/>
+@param gatewayID
+ The identifier for the gateway profile to be updated.
+<p/>
+@param computeResourceId
+ Preferences related to a particular compute resource
+<p/>
+@param computeResourcePreference
+ The ComputeResourcePreference object to be updated to the resource profile.
+<p/>
+@return status
+ Returns a success/failure of the updation.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_deleteGatewayComputeResourcePreference">Function: Airavata.deleteGatewayComputeResourcePreference</h4>
+<pre><code>bool</code> deleteGatewayComputeResourcePreference(<code>string</code> gatewayID,
+ <code>string</code> computeResourceId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Delete the Compute Resource Preference of a registered gateway profile.
+<p/>
+@param gatewayID
+ The identifier for the gateway profile to be deleted.
+<p/>
+@param computeResourceId
+ Preferences related to a particular compute resource
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
<br/></div></div></body></html>
Modified: websites/staging/airavata/trunk/content/documentation/api-docs/0.13/applicationDeploymentModel.html
==============================================================================
--- websites/staging/airavata/trunk/content/documentation/api-docs/0.13/applicationDeploymentModel.html (original)
+++ websites/staging/airavata/trunk/content/documentation/api-docs/0.13/applicationDeploymentModel.html Thu Jul 10 16:41:20 2014
@@ -12,6 +12,7 @@
<td>applicationDeploymentModel</td><td></td>
<td><a href="#Struct_ApplicationDeploymentDescription">ApplicationDeploymentDescription</a><br/>
<a href="#Struct_ApplicationModule">ApplicationModule</a><br/>
+<a href="#Enum_ApplicationParallelismType">ApplicationParallelismType</a><br/>
<a href="#Struct_SetEnvPaths">SetEnvPaths</a><br/>
</td>
<td><code><a href="#Const_DEFAULT_ID">DEFAULT_ID</a></code><br/>
@@ -19,7 +20,33 @@
</tr></table>
<hr/><h2 id="Constants">Constants</h2>
<table class="table-bordered table-striped table-condensed"><thead><th>Constant</th><th>Type</th><th>Value</th></thead>
-<tr id="Const_DEFAULT_ID"><td><code>DEFAULT_ID</code></td><td><code>string</code></td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr></table><hr/><h2 id="Structs">Data structures</h2>
+<tr id="Const_DEFAULT_ID"><td><code>DEFAULT_ID</code></td><td><code>string</code></td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr></table><hr/><h2 id="Enumerations">Enumerations</h2>
+<div class="definition"><h3 id="Enum_ApplicationParallelismType">Enumeration: ApplicationParallelismType</h3>
+Enumeration of application parallelism supported by Airavata
+<p/>
+SERIAL:
+ Single processor applications without any parallelization.
+<p/>
+MPI:
+ Messaging Passing Interface.
+<p/>
+OPENMP:
+ Shared Memory Implementtaion.
+<p/>
+OPENMP_MPI:
+ Hybrid Applications.
+<p/>
+<br/><br/><table class="table-bordered table-striped table-condensed">
+<tr><td><code>SERIAL</code></td><td><code>0</code></td><td>
+</td></tr>
+<tr><td><code>MPI</code></td><td><code>1</code></td><td>
+</td></tr>
+<tr><td><code>OPENMP</code></td><td><code>2</code></td><td>
+</td></tr>
+<tr><td><code>OPENMP_MPI</code></td><td><code>3</code></td><td>
+</td></tr>
+</table></div>
+<hr/><h2 id="Structs">Data structures</h2>
<div class="definition"><h3 id="Struct_SetEnvPaths">Struct: SetEnvPaths</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
<tr><td>1</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
@@ -33,11 +60,10 @@ value:
Value of the environment variable to set
<br/></div><div class="definition"><h3 id="Struct_ApplicationModule">Struct: ApplicationModule</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
-<tr><td>1</td><td>isEmpty</td><td><code>bool</code></td><td></td><td>required</td><td>0</td></tr>
-<tr><td>2</td><td>appModuleId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
-<tr><td>3</td><td>appModuleName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
-<tr><td>4</td><td>appModuleVersion</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>5</td><td>appModuleDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>1</td><td>appModuleId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
+<tr><td>2</td><td>appModuleName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>3</td><td>appModuleVersion</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>appModuleDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
</table><br/>Application Module Information. A module has to be registered before registering a deployment.
<p/>
appModuleId: Airavata Internal Unique Job ID. This is set by the registry.
@@ -53,11 +79,11 @@ appModuleDescription:
<p/>
<br/></div><div class="definition"><h3 id="Struct_ApplicationDeploymentDescription">Struct: ApplicationDeploymentDescription</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
-<tr><td>1</td><td>isEmpty</td><td><code>bool</code></td><td></td><td>required</td><td>0</td></tr>
-<tr><td>2</td><td>appDeploymentId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
-<tr><td>3</td><td>appModuleId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
-<tr><td>4</td><td>computeHostId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
-<tr><td>5</td><td>executablePath</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>1</td><td>appDeploymentId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
+<tr><td>2</td><td>appModuleId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>3</td><td>computeHostId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>4</td><td>executablePath</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>5</td><td>parallelism</td><td><code><a href="applicationDeploymentModel.html#Enum_ApplicationParallelismType">ApplicationParallelismType</a></code></td><td></td><td>required</td><td>UNKNOWN</td></tr>
<tr><td>6</td><td>appDeploymentDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>moduleLoadCmds</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
<tr><td>8</td><td>libPrependPaths</td><td><code>list<<code><a href="applicationDeploymentModel.html#Struct_SetEnvPaths">SetEnvPaths</a></code>></code></td><td></td><td>optional</td><td></td></tr>
Modified: websites/staging/airavata/trunk/content/documentation/api-docs/0.13/applicationInterfaceModel.html
==============================================================================
--- websites/staging/airavata/trunk/content/documentation/api-docs/0.13/applicationInterfaceModel.html (original)
+++ websites/staging/airavata/trunk/content/documentation/api-docs/0.13/applicationInterfaceModel.html Thu Jul 10 16:41:20 2014
@@ -37,14 +37,13 @@ Data Types supported in Airavata. The pr
<hr/><h2 id="Structs">Data structures</h2>
<div class="definition"><h3 id="Struct_InputDataObjectType">Struct: InputDataObjectType</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
-<tr><td>1</td><td>isEmpty</td><td><code>bool</code></td><td></td><td>required</td><td>0</td></tr>
-<tr><td>2</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
-<tr><td>3</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>4</td><td>type</td><td><code><a href="applicationInterfaceModel.html#Enum_DataType">DataType</a></code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>5</td><td>applicationArgument</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>6</td><td>standardInput</td><td><code>bool</code></td><td></td><td>optional</td><td>0</td></tr>
-<tr><td>7</td><td>userFriendlyDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>8</td><td>metaData</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>1</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>2</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>type</td><td><code><a href="applicationInterfaceModel.html#Enum_DataType">DataType</a></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>applicationArgument</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>standardInput</td><td><code>bool</code></td><td></td><td>optional</td><td>0</td></tr>
+<tr><td>6</td><td>userFriendlyDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>7</td><td>metaData</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
</table><br/>Application Inputs. The paramters describe how inputs are passed to the application.
<p/>
name:
@@ -71,10 +70,9 @@ metaData:
<p/>
<br/></div><div class="definition"><h3 id="Struct_OutputDataObjectType">Struct: OutputDataObjectType</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
-<tr><td>1</td><td>isEmpty</td><td><code>bool</code></td><td></td><td>required</td><td>0</td></tr>
-<tr><td>2</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
-<tr><td>3</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>4</td><td>type</td><td><code><a href="applicationInterfaceModel.html#Enum_DataType">DataType</a></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>1</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>2</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>type</td><td><code><a href="applicationInterfaceModel.html#Enum_DataType">DataType</a></code></td><td></td><td>optional</td><td></td></tr>
</table><br/>Application Outputs. The paramters describe how outputs generated by the application.
<p/>
name:
@@ -101,17 +99,21 @@ metaData:
<p/>
<br/></div><div class="definition"><h3 id="Struct_ApplicationInterfaceDescription">Struct: ApplicationInterfaceDescription</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
-<tr><td>1</td><td>isEmpty</td><td><code>bool</code></td><td></td><td>required</td><td>0</td></tr>
-<tr><td>2</td><td>applicationInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
-<tr><td>3</td><td>applicationName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>1</td><td>applicationInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
+<tr><td>2</td><td>applicationName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>3</td><td>applicationDesription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>applicationModules</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>applicationInputs</td><td><code>list<<code><a href="applicationInterfaceModel.html#Struct_InputDataObjectType">InputDataObjectType</a></code>></code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>applicationOutputs</td><td><code>list<<code><a href="applicationInterfaceModel.html#Struct_OutputDataObjectType">OutputDataObjectType</a></code>></code></td><td></td><td>optional</td><td></td></tr>
</table><br/>Application Interface Description
<p/>
+applicationModules:
+ Associate all application modules with versions which interface is applicable to.
<p/>
-appDeploymentId:
- Corelated the interface to a particular application deployment
+applicationInputs:
+ Inputs to be passed to the application
<p/>
+applicationOutputs:
+ Outputs generated from the application
<p/>
<br/></div></div></body></html>
Modified: websites/staging/airavata/trunk/content/documentation/api-docs/0.13/computeResourceModel.html
==============================================================================
--- websites/staging/airavata/trunk/content/documentation/api-docs/0.13/computeResourceModel.html (original)
+++ websites/staging/airavata/trunk/content/documentation/api-docs/0.13/computeResourceModel.html Thu Jul 10 16:41:20 2014
@@ -17,11 +17,13 @@
<a href="#Enum_FileSystems">FileSystems</a><br/>
<a href="#Struct_GlobusJobSubmission">GlobusJobSubmission</a><br/>
<a href="#Struct_GridFTPDataMovement">GridFTPDataMovement</a><br/>
+<a href="#Enum_JobManagerCommand">JobManagerCommand</a><br/>
<a href="#Struct_JobSubmissionInterface">JobSubmissionInterface</a><br/>
<a href="#Enum_JobSubmissionProtocol">JobSubmissionProtocol</a><br/>
<a href="#Struct_LOCALDataMovement">LOCALDataMovement</a><br/>
<a href="#Struct_LOCALSubmission">LOCALSubmission</a><br/>
-<a href="#Enum_ResourceJobManager">ResourceJobManager</a><br/>
+<a href="#Struct_ResourceJobManager">ResourceJobManager</a><br/>
+<a href="#Enum_ResourceJobManagerType">ResourceJobManagerType</a><br/>
<a href="#Struct_SCPDataMovement">SCPDataMovement</a><br/>
<a href="#Struct_SSHJobSubmission">SSHJobSubmission</a><br/>
<a href="#Enum_SecurityProtocol">SecurityProtocol</a><br/>
@@ -32,8 +34,8 @@
<hr/><h2 id="Constants">Constants</h2>
<table class="table-bordered table-striped table-condensed"><thead><th>Constant</th><th>Type</th><th>Value</th></thead>
<tr id="Const_DEFAULT_ID"><td><code>DEFAULT_ID</code></td><td><code>string</code></td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr></table><hr/><h2 id="Enumerations">Enumerations</h2>
-<div class="definition"><h3 id="Enum_ResourceJobManager">Enumeration: ResourceJobManager</h3>
-Enumeration of local resource job managers supported by Airavata
+<div class="definition"><h3 id="Enum_ResourceJobManagerType">Enumeration: ResourceJobManagerType</h3>
+Enumeration of local resource job manager types supported by Airavata
<p/>
FORK:
Forking of commands without any job manager
@@ -57,6 +59,46 @@ SLURM:
<tr><td><code>SLURM</code></td><td><code>3</code></td><td>
</td></tr>
</table></div>
+<div class="definition"><h3 id="Enum_JobManagerCommand">Enumeration: JobManagerCommand</h3>
+Enumeration of resource job manager commands
+<p/>
+SUBMISSION:
+ Ex: qsub, sbatch
+<p/>
+JOBMONITORING:
+ Ex: qstat, squeue
+<p/>
+DELETION:
+ Ex: qdel, scancel
+<p/>
+CHECK_JOB:
+ Detailed Status about the Job. Ex: checkjob
+<p/>
+SHOW_QUEUE:
+ List of Queued Job by the schedular. Ex: showq
+<p/>
+SHOW_RESERVATION:
+ List all reservations. Ex:showres, show_res
+<p/>
+SHOW_START:
+ Display the start time of the specified job. Ex: showstart
+<p/>
+<br/><br/><table class="table-bordered table-striped table-condensed">
+<tr><td><code>SUBMISSION</code></td><td><code>0</code></td><td>
+</td></tr>
+<tr><td><code>JOB_MONITORING</code></td><td><code>1</code></td><td>
+</td></tr>
+<tr><td><code>DELETION</code></td><td><code>2</code></td><td>
+</td></tr>
+<tr><td><code>CHECK_JOB</code></td><td><code>3</code></td><td>
+</td></tr>
+<tr><td><code>SHOW_QUEUE</code></td><td><code>4</code></td><td>
+</td></tr>
+<tr><td><code>SHOW_RESERVATION</code></td><td><code>5</code></td><td>
+</td></tr>
+<tr><td><code>SHOW_START</code></td><td><code>6</code></td><td>
+</td></tr>
+</table></div>
<div class="definition"><h3 id="Enum_FileSystems">Enumeration: FileSystems</h3>
Enumeration of File Systems on the resource
<p/>
@@ -108,7 +150,7 @@ SSH_KEYS:
</td></tr>
</table></div>
<div class="definition"><h3 id="Enum_JobSubmissionProtocol">Enumeration: JobSubmissionProtocol</h3>
-Enumeration of Airavata supported Job Submission Mechanisms for High Perforamance Computing Clusters.
+Enumeration of Airavata supported Job Submission Mechanisms for High Performance Computing Clusters.
<p/>
SSH:
Execute remote job submission commands using via secure shell protocol.
@@ -124,11 +166,9 @@ UNICORE:
</td></tr>
<tr><td><code>SSH</code></td><td><code>1</code></td><td>
</td></tr>
-<tr><td><code>GSISSH</code></td><td><code>2</code></td><td>
-</td></tr>
-<tr><td><code>GRAM</code></td><td><code>3</code></td><td>
+<tr><td><code>GLOBUS</code></td><td><code>2</code></td><td>
</td></tr>
-<tr><td><code>UNICORE</code></td><td><code>4</code></td><td>
+<tr><td><code>UNICORE</code></td><td><code>3</code></td><td>
</td></tr>
</table></div>
<div class="definition"><h3 id="Enum_DataMovementProtocol">Enumeration: DataMovementProtocol</h3>
@@ -159,7 +199,29 @@ UNICORE_STORAGE_SERVICE:
</td></tr>
</table></div>
<hr/><h2 id="Structs">Data structures</h2>
-<div class="definition"><h3 id="Struct_BatchQueue">Struct: BatchQueue</h3>
+<div class="definition"><h3 id="Struct_ResourceJobManager">Struct: ResourceJobManager</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>resourceJobManagerId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
+<tr><td>2</td><td>resourceJobManagerType</td><td><code><a href="computeResourceModel.html#Enum_ResourceJobManagerType">ResourceJobManagerType</a></code></td><td></td><td>required</td><td></td></tr>
+<tr><td>3</td><td>pushMonitoringEndpoint</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>jobManagerBinPath</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>jobManagerCommands</td><td><code>map<<code><a href="computeResourceModel.html#Enum_JobManagerCommand">JobManagerCommand</a></code>, <code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
+</table><br/>Resource Job Manager Information
+<p/>
+resourceJobManagerType:
+ A typical HPC cluster has a single Job Manager to manage the resources.
+<p/>
+pushMonitoringEndpoint:
+ If the job manager pushes out state changes to a database or bus, specify the service endpoint.
+ Ex: Moab Web Service, Moab MongoDB URL, AMQP (GLUE2) Broker
+<p/>
+jobManagerBinPath:
+ Path to the Job Manager Installation Binary directory.
+<p/>
+jobManagerCommands:
+ An enumeration of commonly used manager commands.
+<p/>
+<br/></div><div class="definition"><h3 id="Struct_BatchQueue">Struct: BatchQueue</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
<tr><td>1</td><td>queueName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>2</td><td>queueDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
@@ -183,7 +245,7 @@ alternativeSCPHostName:
If the login to scp is different than the hostname itself, specify it here
<p/>
sshPort:
- If a non-defualt port needs to used, specify it.
+ If a non-default port needs to used, specify it.
<br/></div><div class="definition"><h3 id="Struct_GridFTPDataMovement">Struct: GridFTPDataMovement</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
<tr><td>1</td><td>dataMovementInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
@@ -195,19 +257,18 @@ alternativeSCPHostName:
If the login to scp is different than the hostname itself, specify it here
<p/>
sshPort:
- If a non-defualt port needs to used, specify it.
+ If a non-default port needs to used, specify it.
<br/></div><div class="definition"><h3 id="Struct_LOCALSubmission">Struct: LOCALSubmission</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
<tr><td>1</td><td>jobSubmissionInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
-<tr><td>3</td><td>resourceJobManager</td><td><code><a href="computeResourceModel.html#Enum_ResourceJobManager">ResourceJobManager</a></code></td><td></td><td>required</td><td></td></tr>
-<tr><td>6</td><td>monitoringMechanism</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>2</td><td>resourceJobManager</td><td><code><a href="computeResourceModel.html#Struct_ResourceJobManager">ResourceJobManager</a></code></td><td></td><td>required</td><td></td></tr>
</table><br/>Locally Fork Jobs as OS processes
<p/>
alternativeSSHHostName:
If the login to ssh is different than the hostname itself, specify it here
<p/>
sshPort:
- If a non-defualt port needs to used, specify it.
+ If a non-default port needs to used, specify it.
<br/></div><div class="definition"><h3 id="Struct_LOCALDataMovement">Struct: LOCALDataMovement</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
<tr><td>1</td><td>dataMovementInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
@@ -222,23 +283,21 @@ sshPort:
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
<tr><td>1</td><td>jobSubmissionInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
<tr><td>2</td><td>securityProtocol</td><td><code><a href="computeResourceModel.html#Enum_SecurityProtocol">SecurityProtocol</a></code></td><td></td><td>required</td><td></td></tr>
-<tr><td>3</td><td>resourceJobManager</td><td><code><a href="computeResourceModel.html#Enum_ResourceJobManager">ResourceJobManager</a></code></td><td></td><td>required</td><td></td></tr>
+<tr><td>3</td><td>resourceJobManager</td><td><code><a href="computeResourceModel.html#Struct_ResourceJobManager">ResourceJobManager</a></code></td><td></td><td>required</td><td></td></tr>
<tr><td>4</td><td>alternativeSSHHostName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>sshPort</td><td><code>i32</code></td><td></td><td>optional</td><td>22</td></tr>
-<tr><td>6</td><td>monitoringMechanism</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
</table><br/>Authenticate using Secured Shell
<p/>
alternativeSSHHostName:
If the login to ssh is different than the hostname itself, specify it here
<p/>
sshPort:
- If a non-defualt port needs to used, specify it.
+ If a non-default port needs to used, specify it.
<br/></div><div class="definition"><h3 id="Struct_GlobusJobSubmission">Struct: GlobusJobSubmission</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
<tr><td>1</td><td>jobSubmissionInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
<tr><td>2</td><td>securityProtocol</td><td><code><a href="computeResourceModel.html#Enum_SecurityProtocol">SecurityProtocol</a></code></td><td></td><td>required</td><td></td></tr>
-<tr><td>3</td><td>resourceJobManager</td><td><code><a href="computeResourceModel.html#Enum_ResourceJobManager">ResourceJobManager</a></code></td><td></td><td>required</td><td></td></tr>
-<tr><td>4</td><td>globusGateKeeperEndPoint</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>globusGateKeeperEndPoint</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
</table><br/></div><div class="definition"><h3 id="Struct_JobSubmissionInterface">Struct: JobSubmissionInterface</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
<tr><td>1</td><td>jobSubmissionInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
@@ -267,17 +326,15 @@ priorityOrder:
<p/>
<br/></div><div class="definition"><h3 id="Struct_ComputeResourceDescription">Struct: ComputeResourceDescription</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
-<tr><td>1</td><td>isEmpty</td><td><code>bool</code></td><td></td><td>required</td><td>0</td></tr>
-<tr><td>2</td><td>computeResourceId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
-<tr><td>3</td><td>hostName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
-<tr><td>4</td><td>hostAliases</td><td><code>set<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>5</td><td>ipAddresses</td><td><code>set<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>6</td><td>computeResourceDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>7</td><td>resourceJobManager</td><td><code><a href="computeResourceModel.html#Enum_ResourceJobManager">ResourceJobManager</a></code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>8</td><td>batchQueues</td><td><code>list<<code><a href="computeResourceModel.html#Struct_BatchQueue">BatchQueue</a></code>></code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>9</td><td>fileSystems</td><td><code>map<<code><a href="computeResourceModel.html#Enum_FileSystems">FileSystems</a></code>, <code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>10</td><td>jobSubmissionInterfaces</td><td><code>list<<code><a href="computeResourceModel.html#Struct_JobSubmissionInterface">JobSubmissionInterface</a></code>></code></td><td></td><td>optional</td><td></td></tr>
-<tr><td>11</td><td>dataMovemenetInterfaces</td><td><code>list<<code><a href="computeResourceModel.html#Struct_DataMovementInterface">DataMovementInterface</a></code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>1</td><td>computeResourceId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
+<tr><td>2</td><td>hostName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>3</td><td>hostAliases</td><td><code>set<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>ipAddresses</td><td><code>set<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>resourceDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>6</td><td>batchQueues</td><td><code>list<<code><a href="computeResourceModel.html#Struct_BatchQueue">BatchQueue</a></code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>7</td><td>fileSystems</td><td><code>map<<code><a href="computeResourceModel.html#Enum_FileSystems">FileSystems</a></code>, <code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>8</td><td>jobSubmissionInterfaces</td><td><code>list<<code><a href="computeResourceModel.html#Struct_JobSubmissionInterface">JobSubmissionInterface</a></code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>9</td><td>dataMovementInterfaces</td><td><code>list<<code><a href="computeResourceModel.html#Struct_DataMovementInterface">DataMovementInterface</a></code>></code></td><td></td><td>optional</td><td></td></tr>
</table><br/>Computational Resource Description
<p/>
computeResourceId: Airavata Internal Unique Identifier to distinguish Compute Resource.
@@ -285,6 +342,9 @@ computeResourceId: Airavata Internal Uni
hostName:
Fully Qualified Host Name.
<p/>
+hostAliases:
+ Aliases if any.
+<p/>
ipAddress:
IP Addresses of the Resource.
<p/>
Modified: websites/staging/airavata/trunk/content/documentation/api-docs/0.13/gatewayResourceProfileModel.html
==============================================================================
--- websites/staging/airavata/trunk/content/documentation/api-docs/0.13/gatewayResourceProfileModel.html (original)
+++ websites/staging/airavata/trunk/content/documentation/api-docs/0.13/gatewayResourceProfileModel.html Thu Jul 10 16:41:20 2014
@@ -11,7 +11,7 @@
<tr>
<td>gatewayResourceProfileModel</td><td></td>
<td><a href="#Struct_ComputeResourcePreference">ComputeResourcePreference</a><br/>
-<a href="#Struct_GatewayProfile">GatewayProfile</a><br/>
+<a href="#Struct_GatewayResourceProfile">GatewayResourceProfile</a><br/>
</td>
<td><code><a href="#Const_DEFAULT_ID">DEFAULT_ID</a></code><br/>
</code></td>
@@ -28,52 +28,50 @@
<tr><td>5</td><td>preferredBatchQueue</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>scratchLocation</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>allocationProjectNumber</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
-</table><br/>Resource Preferences for each of the gateway
+</table><br/>Gateway specific preferences for a Computer Resource
<p/>
computeResourceId:
- Corelate the preference for compute resource to
+ Corelate the preference to a compute resource.
<p/>
-gatewayName:
- Name of the Gateway.
+overridebyAiravata:
+ If turned true, Airavata will override the preferences of better alternatives exist.
<p/>
-ipAddress:
- IP Addresse of the Hostname.
+preferredJobSubmissionProtocol:
+ For resources with multiple job submission protocols, the gateway can pick a preferred option.
<p/>
-resourceDescription:
- A user friendly description of the hostname.
+preferredDataMovementProtocol:
+ For resources with multiple data movement protocols, the gateway can pick a preferred option.
<p/>
-JobSubmissionProtocols:
- A computational resources may have one or more ways of submitting Jobs. This structure
- will hold all available mechanisms to interact with the resource.
+preferredBatchQueue:
+ Gateways can choose a defualt batch queue based on average job dimention, reservations or other metrics.
<p/>
-DataMovementProtocol:
- Option to specify a prefered data movement mechanism of the available options.
+scratchLocation:
+ Path to the local scratch space on a HPC cluster. Typically used to create working directory for job execution.
<p/>
-<br/></div><div class="definition"><h3 id="Struct_GatewayProfile">Struct: GatewayProfile</h3>
+allocationProjectNumber:
+ Typically used on HPC machines to charge computing usage to a account number. For instance, on XSEDE once an
+ allocation is approved, an allocation number is assigned. Before passing this number with job submittions, the
+ account to be used has to be added to the allocation.
+<p/>
+<br/></div><div class="definition"><h3 id="Struct_GatewayResourceProfile">Struct: GatewayResourceProfile</h3>
<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
<tr><td>1</td><td>gatewayID</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
<tr><td>2</td><td>gatewayName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>3</td><td>gatewayDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>computeResourcePreferences</td><td><code>list<<code><a href="gatewayResourceProfileModel.html#Struct_ComputeResourcePreference">ComputeResourcePreference</a></code>></code></td><td></td><td>optional</td><td></td></tr>
-</table><br/>Gateway Profile
+</table><br/>Gateway Resource Profile
<p/>
gatewayID:
- Unique identifier for the gateway assigned by Airavata
+ Unique identifier for the gateway assigned by Airavata. Corelate this to Airavata Admin API Gateway Registration.
<p/>
gatewayName:
Name of the Gateway.
<p/>
-ipAddress:
- IP Addresse of the Hostname.
-<p/>
-resourceDescription:
- A user friendly description of the hostname.
+gatewayDescription:
+ A user friendly description of the gateway.
<p/>
-JobSubmissionProtocols:
- A computational resources may have one or more ways of submitting Jobs. This structure
- will hold all available mechanisms to interact with the resource.
+computeResourcePreferences:
+ List of resource preferences for each of the registered compute resources.
<p/>
-DataMovementProtocol:
- Option to specify a prefered data movement mechanism of the available options.
<p/>
<br/></div></div></body></html>