| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> |
| <link href="style.css" rel="stylesheet" type="text/css"/> |
| <title>Thrift module: airavata_api</title></head><body> |
| <div class="container-fluid"> |
| <h1>Thrift module: airavata_api</h1> |
| <pre>Application Programming Interface definition for Apache Airavata Services. |
| this parent thrift file is contains all service interfaces. The data models are |
| described in respective thrift files. |
| </pre><br/><table class="table-bordered table-striped table-condensed"><thead><tr><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></tr></thead><tbody> |
| <tr> |
| <td>airavata_api</td><td><a href="#Svc_Airavata">Airavata</a><br/> |
| <ul> |
| <li><a href="#Fn_Airavata_addCloudJobSubmissionDetails">addCloudJobSubmissionDetails</a></li> |
| <li><a href="#Fn_Airavata_addGateway">addGateway</a></li> |
| <li><a href="#Fn_Airavata_addGatewayComputeResourcePreference">addGatewayComputeResourcePreference</a></li> |
| <li><a href="#Fn_Airavata_addGatewayStoragePreference">addGatewayStoragePreference</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_addSSHForkJobSubmissionDetails">addSSHForkJobSubmissionDetails</a></li> |
| <li><a href="#Fn_Airavata_addSSHJobSubmissionDetails">addSSHJobSubmissionDetails</a></li> |
| <li><a href="#Fn_Airavata_addUNICOREJobSubmissionDetails">addUNICOREJobSubmissionDetails</a></li> |
| <li><a href="#Fn_Airavata_addUnicoreDataMovementDetails">addUnicoreDataMovementDetails</a></li> |
| <li><a href="#Fn_Airavata_addUserComputeResourcePreference">addUserComputeResourcePreference</a></li> |
| <li><a href="#Fn_Airavata_addUserStoragePreference">addUserStoragePreference</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_cloneApplicationInterface">cloneApplicationInterface</a></li> |
| <li><a href="#Fn_Airavata_cloneExperiment">cloneExperiment</a></li> |
| <li><a href="#Fn_Airavata_cloneExperimentByAdmin">cloneExperimentByAdmin</a></li> |
| <li><a href="#Fn_Airavata_createExperiment">createExperiment</a></li> |
| <li><a href="#Fn_Airavata_createGroupResourceProfile">createGroupResourceProfile</a></li> |
| <li><a href="#Fn_Airavata_createNotification">createNotification</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_deleteBatchQueue">deleteBatchQueue</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_deleteExperiment">deleteExperiment</a></li> |
| <li><a href="#Fn_Airavata_deleteGateway">deleteGateway</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_deleteGatewayStoragePreference">deleteGatewayStoragePreference</a></li> |
| <li><a href="#Fn_Airavata_deleteJobSubmissionInterface">deleteJobSubmissionInterface</a></li> |
| <li><a href="#Fn_Airavata_deleteNotification">deleteNotification</a></li> |
| <li><a href="#Fn_Airavata_deletePWDCredential">deletePWDCredential</a></li> |
| <li><a href="#Fn_Airavata_deleteProject">deleteProject</a></li> |
| <li><a href="#Fn_Airavata_deleteResourceJobManager">deleteResourceJobManager</a></li> |
| <li><a href="#Fn_Airavata_deleteSSHPubKey">deleteSSHPubKey</a></li> |
| <li><a href="#Fn_Airavata_deleteStorageResource">deleteStorageResource</a></li> |
| <li><a href="#Fn_Airavata_deleteUserComputeResourcePreference">deleteUserComputeResourcePreference</a></li> |
| <li><a href="#Fn_Airavata_deleteUserResourceProfile">deleteUserResourceProfile</a></li> |
| <li><a href="#Fn_Airavata_deleteUserStoragePreference">deleteUserStoragePreference</a></li> |
| <li><a href="#Fn_Airavata_doesUserHaveSSHAccount">doesUserHaveSSHAccount</a></li> |
| <li><a href="#Fn_Airavata_generateAndRegisterSSHKeys">generateAndRegisterSSHKeys</a></li> |
| <li><a href="#Fn_Airavata_getAccessibleAppModules">getAccessibleAppModules</a></li> |
| <li><a href="#Fn_Airavata_getAccessibleApplicationDeployments">getAccessibleApplicationDeployments</a></li> |
| <li><a href="#Fn_Airavata_getAllAccessibleGroups">getAllAccessibleGroups</a></li> |
| <li><a href="#Fn_Airavata_getAllAccessibleUsers">getAllAccessibleUsers</a></li> |
| <li><a href="#Fn_Airavata_getAllAppModules">getAllAppModules</a></li> |
| <li><a href="#Fn_Airavata_getAllApplicationDeployments">getAllApplicationDeployments</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_getAllCredentialSummaries">getAllCredentialSummaries</a></li> |
| <li><a href="#Fn_Airavata_getAllDirectlyAccessibleGroups">getAllDirectlyAccessibleGroups</a></li> |
| <li><a href="#Fn_Airavata_getAllDirectlyAccessibleUsers">getAllDirectlyAccessibleUsers</a></li> |
| <li><a href="#Fn_Airavata_getAllGatewayComputeResourcePreferences">getAllGatewayComputeResourcePreferences</a></li> |
| <li><a href="#Fn_Airavata_getAllGatewayResourceProfiles">getAllGatewayResourceProfiles</a></li> |
| <li><a href="#Fn_Airavata_getAllGatewayStoragePreferences">getAllGatewayStoragePreferences</a></li> |
| <li><a href="#Fn_Airavata_getAllGateways">getAllGateways</a></li> |
| <li><a href="#Fn_Airavata_getAllNotifications">getAllNotifications</a></li> |
| <li><a href="#Fn_Airavata_getAllStorageResourceNames">getAllStorageResourceNames</a></li> |
| <li><a href="#Fn_Airavata_getAllUserComputeResourcePreferences">getAllUserComputeResourcePreferences</a></li> |
| <li><a href="#Fn_Airavata_getAllUserResourceProfiles">getAllUserResourceProfiles</a></li> |
| <li><a href="#Fn_Airavata_getAllUserStoragePreferences">getAllUserStoragePreferences</a></li> |
| <li><a href="#Fn_Airavata_getAllUsersInGateway">getAllUsersInGateway</a></li> |
| <li><a href="#Fn_Airavata_getAppModuleDeployedResources">getAppModuleDeployedResources</a></li> |
| <li><a href="#Fn_Airavata_getApplicationDeployment">getApplicationDeployment</a></li> |
| <li><a href="#Fn_Airavata_getApplicationDeploymentsForAppModuleAndGroupResourceProfile">getApplicationDeploymentsForAppModuleAndGroupResourceProfile</a></li> |
| <li><a href="#Fn_Airavata_getApplicationInputs">getApplicationInputs</a></li> |
| <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_getBatchQueueResourcePolicy">getBatchQueueResourcePolicy</a></li> |
| <li><a href="#Fn_Airavata_getChildDataProducts">getChildDataProducts</a></li> |
| <li><a href="#Fn_Airavata_getCloudJobSubmission">getCloudJobSubmission</a></li> |
| <li><a href="#Fn_Airavata_getComputeResource">getComputeResource</a></li> |
| <li><a href="#Fn_Airavata_getCredentialSummary">getCredentialSummary</a></li> |
| <li><a href="#Fn_Airavata_getDataProduct">getDataProduct</a></li> |
| <li><a href="#Fn_Airavata_getDetailedExperimentTree">getDetailedExperimentTree</a></li> |
| <li><a href="#Fn_Airavata_getExperiment">getExperiment</a></li> |
| <li><a href="#Fn_Airavata_getExperimentByAdmin">getExperimentByAdmin</a></li> |
| <li><a href="#Fn_Airavata_getExperimentOutputs">getExperimentOutputs</a></li> |
| <li><a href="#Fn_Airavata_getExperimentStatistics">getExperimentStatistics</a></li> |
| <li><a href="#Fn_Airavata_getExperimentStatus">getExperimentStatus</a></li> |
| <li><a href="#Fn_Airavata_getExperimentsInProject">getExperimentsInProject</a></li> |
| <li><a href="#Fn_Airavata_getGateway">getGateway</a></li> |
| <li><a href="#Fn_Airavata_getGatewayComputeResourcePreference">getGatewayComputeResourcePreference</a></li> |
| <li><a href="#Fn_Airavata_getGatewayGroups">getGatewayGroups</a></li> |
| <li><a href="#Fn_Airavata_getGatewayResourceProfile">getGatewayResourceProfile</a></li> |
| <li><a href="#Fn_Airavata_getGatewayStoragePreference">getGatewayStoragePreference</a></li> |
| <li><a href="#Fn_Airavata_getGridFTPDataMovement">getGridFTPDataMovement</a></li> |
| <li><a href="#Fn_Airavata_getGroupBatchQueueResourcePolicyList">getGroupBatchQueueResourcePolicyList</a></li> |
| <li><a href="#Fn_Airavata_getGroupComputeResourcePolicy">getGroupComputeResourcePolicy</a></li> |
| <li><a href="#Fn_Airavata_getGroupComputeResourcePolicyList">getGroupComputeResourcePolicyList</a></li> |
| <li><a href="#Fn_Airavata_getGroupComputeResourcePrefList">getGroupComputeResourcePrefList</a></li> |
| <li><a href="#Fn_Airavata_getGroupComputeResourcePreference">getGroupComputeResourcePreference</a></li> |
| <li><a href="#Fn_Airavata_getGroupResourceList">getGroupResourceList</a></li> |
| <li><a href="#Fn_Airavata_getGroupResourceProfile">getGroupResourceProfile</a></li> |
| <li><a href="#Fn_Airavata_getIntermediateOutputs">getIntermediateOutputs</a></li> |
| <li><a href="#Fn_Airavata_getJobDetails">getJobDetails</a></li> |
| <li><a href="#Fn_Airavata_getJobStatuses">getJobStatuses</a></li> |
| <li><a href="#Fn_Airavata_getLatestQueueStatuses">getLatestQueueStatuses</a></li> |
| <li><a href="#Fn_Airavata_getLocalDataMovement">getLocalDataMovement</a></li> |
| <li><a href="#Fn_Airavata_getLocalJobSubmission">getLocalJobSubmission</a></li> |
| <li><a href="#Fn_Airavata_getNotification">getNotification</a></li> |
| <li><a href="#Fn_Airavata_getParentDataProduct">getParentDataProduct</a></li> |
| <li><a href="#Fn_Airavata_getParser">getParser</a></li> |
| <li><a href="#Fn_Airavata_getParsingTemplate">getParsingTemplate</a></li> |
| <li><a href="#Fn_Airavata_getParsingTemplatesForExperiment">getParsingTemplatesForExperiment</a></li> |
| <li><a href="#Fn_Airavata_getProject">getProject</a></li> |
| <li><a href="#Fn_Airavata_getResourceJobManager">getResourceJobManager</a></li> |
| <li><a href="#Fn_Airavata_getSCPDataMovement">getSCPDataMovement</a></li> |
| <li><a href="#Fn_Airavata_getSSHAccountProvisioners">getSSHAccountProvisioners</a></li> |
| <li><a href="#Fn_Airavata_getSSHJobSubmission">getSSHJobSubmission</a></li> |
| <li><a href="#Fn_Airavata_getStorageResource">getStorageResource</a></li> |
| <li><a href="#Fn_Airavata_getUnicoreDataMovement">getUnicoreDataMovement</a></li> |
| <li><a href="#Fn_Airavata_getUnicoreJobSubmission">getUnicoreJobSubmission</a></li> |
| <li><a href="#Fn_Airavata_getUserComputeResourcePreference">getUserComputeResourcePreference</a></li> |
| <li><a href="#Fn_Airavata_getUserExperiments">getUserExperiments</a></li> |
| <li><a href="#Fn_Airavata_getUserProjects">getUserProjects</a></li> |
| <li><a href="#Fn_Airavata_getUserResourceProfile">getUserResourceProfile</a></li> |
| <li><a href="#Fn_Airavata_getUserStoragePreference">getUserStoragePreference</a></li> |
| <li><a href="#Fn_Airavata_isGatewayExist">isGatewayExist</a></li> |
| <li><a href="#Fn_Airavata_isSSHSetupCompleteForUserComputeResourcePreference">isSSHSetupCompleteForUserComputeResourcePreference</a></li> |
| <li><a href="#Fn_Airavata_isUserExists">isUserExists</a></li> |
| <li><a href="#Fn_Airavata_isUserResourceProfileExists">isUserResourceProfileExists</a></li> |
| <li><a href="#Fn_Airavata_launchExperiment">launchExperiment</a></li> |
| <li><a href="#Fn_Airavata_listAllParsers">listAllParsers</a></li> |
| <li><a href="#Fn_Airavata_listAllParsingTemplates">listAllParsingTemplates</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_registerDataProduct">registerDataProduct</a></li> |
| <li><a href="#Fn_Airavata_registerGatewayResourceProfile">registerGatewayResourceProfile</a></li> |
| <li><a href="#Fn_Airavata_registerPwdCredential">registerPwdCredential</a></li> |
| <li><a href="#Fn_Airavata_registerReplicaLocation">registerReplicaLocation</a></li> |
| <li><a href="#Fn_Airavata_registerResourceJobManager">registerResourceJobManager</a></li> |
| <li><a href="#Fn_Airavata_registerStorageResource">registerStorageResource</a></li> |
| <li><a href="#Fn_Airavata_registerUserResourceProfile">registerUserResourceProfile</a></li> |
| <li><a href="#Fn_Airavata_removeGroupBatchQueueResourcePolicy">removeGroupBatchQueueResourcePolicy</a></li> |
| <li><a href="#Fn_Airavata_removeGroupComputePrefs">removeGroupComputePrefs</a></li> |
| <li><a href="#Fn_Airavata_removeGroupComputeResourcePolicy">removeGroupComputeResourcePolicy</a></li> |
| <li><a href="#Fn_Airavata_removeGroupResourceProfile">removeGroupResourceProfile</a></li> |
| <li><a href="#Fn_Airavata_removeParser">removeParser</a></li> |
| <li><a href="#Fn_Airavata_removeParsingTemplate">removeParsingTemplate</a></li> |
| <li><a href="#Fn_Airavata_revokeSharingOfResourceFromGroups">revokeSharingOfResourceFromGroups</a></li> |
| <li><a href="#Fn_Airavata_revokeSharingOfResourceFromUsers">revokeSharingOfResourceFromUsers</a></li> |
| <li><a href="#Fn_Airavata_saveParser">saveParser</a></li> |
| <li><a href="#Fn_Airavata_saveParsingTemplate">saveParsingTemplate</a></li> |
| <li><a href="#Fn_Airavata_searchExperiments">searchExperiments</a></li> |
| <li><a href="#Fn_Airavata_searchProjects">searchProjects</a></li> |
| <li><a href="#Fn_Airavata_setupUserComputeResourcePreferencesForSSH">setupUserComputeResourcePreferencesForSSH</a></li> |
| <li><a href="#Fn_Airavata_shareResourceWithGroups">shareResourceWithGroups</a></li> |
| <li><a href="#Fn_Airavata_shareResourceWithUsers">shareResourceWithUsers</a></li> |
| <li><a href="#Fn_Airavata_terminateExperiment">terminateExperiment</a></li> |
| <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_updateCloudJobSubmissionDetails">updateCloudJobSubmissionDetails</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_updateGateway">updateGateway</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_updateGatewayStoragePreference">updateGatewayStoragePreference</a></li> |
| <li><a href="#Fn_Airavata_updateGridFTPDataMovementDetails">updateGridFTPDataMovementDetails</a></li> |
| <li><a href="#Fn_Airavata_updateGroupResourceProfile">updateGroupResourceProfile</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_updateNotification">updateNotification</a></li> |
| <li><a href="#Fn_Airavata_updateProject">updateProject</a></li> |
| <li><a href="#Fn_Airavata_updateResourceJobManager">updateResourceJobManager</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_updateStorageResource">updateStorageResource</a></li> |
| <li><a href="#Fn_Airavata_updateUnicoreDataMovementDetails">updateUnicoreDataMovementDetails</a></li> |
| <li><a href="#Fn_Airavata_updateUnicoreJobSubmissionDetails">updateUnicoreJobSubmissionDetails</a></li> |
| <li><a href="#Fn_Airavata_updateUserComputeResourcePreference">updateUserComputeResourcePreference</a></li> |
| <li><a href="#Fn_Airavata_updateUserResourceProfile">updateUserResourceProfile</a></li> |
| <li><a href="#Fn_Airavata_updateUserStoragePreference">updateUserStoragePreference</a></li> |
| <li><a href="#Fn_Airavata_userHasAccess">userHasAccess</a></li> |
| <li><a href="#Fn_Airavata_validateExperiment">validateExperiment</a></li> |
| </ul> |
| </td> |
| <td></td> |
| <td><code><a href="#Const_AIRAVATA_API_VERSION">AIRAVATA_API_VERSION</a></code><br/> |
| </td> |
| </tr></tbody></table> |
| <hr/><h2 id="Constants">Constants</h2> |
| <table class="table-bordered table-striped table-condensed"><thead><tr><th>Constant</th><th>Type</th><th>Value</th></tr></thead><tbody> |
| <tr id="Const_AIRAVATA_API_VERSION"><td><code>AIRAVATA_API_VERSION</code></td><td><code>string</code></td><td><code>"0.18.0"</code></td></tr><tr><td colspan="3"><blockquote><pre>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. |
| |
| Note: The Airavata API version may be different from the Airavata software release versions. |
| |
| The Airavata API version is composed as a dot delimited string with major, minor, and patch level components. |
| |
| - 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. |
| |
| </pre><br/></blockquote></td></tr></tbody></table><hr/><h2 id="Services">Services</h2> |
| <h3 id="Svc_Airavata">Service: Airavata</h3> |
| <div class="extends"><em>extends</em> <code><a href="base_api.html#Svc_BaseAPI">base_api.BaseAPI</a></code></div> |
| <div class="definition"><h4 id="Fn_Airavata_isUserExists">Function: Airavata.isUserExists</h4> |
| <pre><code>bool</code> isUserExists(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code>string</code> userName) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Verify if User Exists within Airavata. |
| |
| @param gatewayId |
| |
| @param userName |
| |
| @return true/false |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addGateway">Function: Airavata.addGateway</h4> |
| <pre><code>string</code> addGateway(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="workspace_model.html#Struct_Gateway">workspace_model.Gateway</a></code> gateway) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Register a Gateway with Airavata. |
| |
| @param gateway |
| The gateway data model. |
| |
| @return gatewayId |
| Th unique identifier of the newly registered gateway. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllUsersInGateway">Function: Airavata.getAllUsersInGateway</h4> |
| <pre><code>list<<code>string</code>></code> getAllUsersInGateway(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Get all users in the gateway |
| |
| @param gatewayId |
| The gateway data model. |
| |
| @return users |
| list of usernames of the users in the gateway |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateGateway">Function: Airavata.updateGateway</h4> |
| <pre><code>bool</code> updateGateway(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code><a href="workspace_model.html#Struct_Gateway">workspace_model.Gateway</a></code> updatedGateway) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Update previously registered Gateway metadata. |
| |
| @param gatewayId |
| The gateway Id of the Gateway which require an update. |
| |
| @return gateway |
| Modified gateway obejct. |
| |
| @exception AiravataClientException |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getGateway">Function: Airavata.getGateway</h4> |
| <pre><code><a href="workspace_model.html#Struct_Gateway">workspace_model.Gateway</a></code> getGateway(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Get Gateway details by providing gatewayId |
| |
| @param gatewayId |
| The gateway Id of the Gateway. |
| |
| @return gateway |
| Gateway obejct. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteGateway">Function: Airavata.deleteGateway</h4> |
| <pre><code>bool</code> deleteGateway(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete a Gateway |
| |
| @param gatewayId |
| The gateway Id of the Gateway to be deleted. |
| |
| @return boolean |
| Boolean identifier for the success or failure of the deletion operation. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllGateways">Function: Airavata.getAllGateways</h4> |
| <pre><code>list<<code><a href="workspace_model.html#Struct_Gateway">workspace_model.Gateway</a></code>></code> getAllGateways(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Get All the Gateways Connected to Airavata. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_isGatewayExist">Function: Airavata.isGatewayExist</h4> |
| <pre><code>bool</code> isGatewayExist(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Check for the Existance of a Gateway within Airavata |
| |
| @param gatewayId |
| Provide the gatewayId of the gateway you want to check the existancy |
| |
| @return boolean |
| Boolean idetifier for the existance or non-existane of the gatewayId |
| |
| @return gatewayId |
| return the gatewayId of the existing gateway. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_createNotification">Function: Airavata.createNotification</h4> |
| <pre><code>string</code> createNotification(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="workspace_model.html#Struct_Notification">workspace_model.Notification</a></code> notification) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> * API methods to retrieve notifications |
| * |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateNotification">Function: Airavata.updateNotification</h4> |
| <pre><code>bool</code> updateNotification(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="workspace_model.html#Struct_Notification">workspace_model.Notification</a></code> notification) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_deleteNotification">Function: Airavata.deleteNotification</h4> |
| <pre><code>bool</code> deleteNotification(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code>string</code> notificationId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getNotification">Function: Airavata.getNotification</h4> |
| <pre><code><a href="workspace_model.html#Struct_Notification">workspace_model.Notification</a></code> getNotification(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code>string</code> notificationId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getAllNotifications">Function: Airavata.getAllNotifications</h4> |
| <pre><code>list<<code><a href="workspace_model.html#Struct_Notification">workspace_model.Notification</a></code>></code> getAllNotifications(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_generateAndRegisterSSHKeys">Function: Airavata.generateAndRegisterSSHKeys</h4> |
| <pre><code>string</code> generateAndRegisterSSHKeys(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> description) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code> |
| </pre><pre>Generate and Register SSH Key Pair with Airavata Credential Store. |
| |
| @param description |
| The description field for a credential type, all type of credential can have a description. |
| |
| @return airavataCredStoreToken |
| An SSH Key pair is generated and stored in the credential store and associated with users or community account |
| belonging to a Gateway. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_registerPwdCredential">Function: Airavata.registerPwdCredential</h4> |
| <pre><code>string</code> registerPwdCredential(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> loginUserName, |
| <code>string</code> password, |
| <code>string</code> description) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code> |
| </pre><pre>Generate and Register Username PWD Pair with Airavata Credential Store. |
| |
| @param loginUserName |
| |
| @param password |
| |
| @return airavataCredStoreToken |
| An SSH Key pair is generated and stored in the credential store and associated with users or community account |
| belonging to a Gateway. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getCredentialSummary">Function: Airavata.getCredentialSummary</h4> |
| <pre><code><a href="credential_store_data_models.html#Struct_CredentialSummary">credential_store_data_models.CredentialSummary</a></code> getCredentialSummary(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> tokenId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getAllCredentialSummaries">Function: Airavata.getAllCredentialSummaries</h4> |
| <pre><code>list<<code><a href="credential_store_data_models.html#Struct_CredentialSummary">credential_store_data_models.CredentialSummary</a></code>></code> getAllCredentialSummaries(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="credential_store_data_models.html#Enum_SummaryType">credential_store_data_models.SummaryType</a></code> type) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_deleteSSHPubKey">Function: Airavata.deleteSSHPubKey</h4> |
| <pre><code>bool</code> deleteSSHPubKey(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataCredStoreToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_deletePWDCredential">Function: Airavata.deletePWDCredential</h4> |
| <pre><code>bool</code> deletePWDCredential(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataCredStoreToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_createProject">Function: Airavata.createProject</h4> |
| <pre><code>string</code> createProject(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code><a href="workspace_model.html#Struct_Project">workspace_model.Project</a></code> project) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Creates a Project with basic metadata. |
| A Project is a container of experiments. |
| |
| @param gatewayId |
| The identifier for the requested gateway. |
| |
| @param Project |
| The Project Object described in the workspace_model. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateProject">Function: Airavata.updateProject</h4> |
| <pre><code>void</code> updateProject(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> projectId, |
| <code><a href="workspace_model.html#Struct_Project">workspace_model.Project</a></code> updatedProject) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_ProjectNotFoundException">airavata_errors.ProjectNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Update an Existing Project |
| |
| @param projectId |
| The projectId of the project needed an update. |
| |
| @return void |
| Currently this does not return any value. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getProject">Function: Airavata.getProject</h4> |
| <pre><code><a href="workspace_model.html#Struct_Project">workspace_model.Project</a></code> getProject(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> projectId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_ProjectNotFoundException">airavata_errors.ProjectNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Get a Project by ID |
| This method is to obtain a project by providing a projectId. |
| |
| @param projectId |
| projectId of the project you require. |
| |
| @return project |
| project data model will be returned. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteProject">Function: Airavata.deleteProject</h4> |
| <pre><code>bool</code> deleteProject(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> projectId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_ProjectNotFoundException">airavata_errors.ProjectNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Delete a Project |
| This method is used to delete an existing Project. |
| |
| @param projectId |
| projectId of the project you want to delete. |
| |
| @return boolean |
| Boolean identifier for the success or failure of the deletion operation. |
| |
| NOTE: This method is not used within gateways connected with Airavata. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getUserProjects">Function: Airavata.getUserProjects</h4> |
| <pre><code>list<<code><a href="workspace_model.html#Struct_Project">workspace_model.Project</a></code>></code> getUserProjects(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code>string</code> userName, |
| <code>i32</code> limit, |
| <code>i32</code> offset) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Get All User Projects |
| Get all Project for the user with pagination. Results will be ordered based on creation time DESC. |
| |
| @param gatewayId |
| The identifier for the requested gateway. |
| |
| @param userName |
| The identifier of the user. |
| |
| @param limit |
| The amount results to be fetched. |
| |
| @param offset |
| The starting point of the results to be fetched. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_searchProjects">Function: Airavata.searchProjects</h4> |
| <pre><code>list<<code><a href="workspace_model.html#Struct_Project">workspace_model.Project</a></code>></code> searchProjects(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code>string</code> userName, |
| <code>map<<code><a href="experiment_model.html#Enum_ProjectSearchFields">experiment_model.ProjectSearchFields</a></code>, <code>string</code>></code> filters, |
| <code>i32</code> limit, |
| <code>i32</code> offset) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Search User Projects |
| Search and get all Projects for user by project description or/and project name with pagination. |
| Results will be ordered based on creation time DESC. |
| |
| @param gatewayId |
| The unique identifier of the gateway making the request. |
| |
| @param userName |
| The identifier of the user. |
| |
| @param filters |
| Map of multiple filter criteria. Currenlt search filters includes Project Name and Project Description |
| |
| @param limit |
| The amount results to be fetched. |
| |
| @param offset |
| The starting point of the results to be fetched. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_searchExperiments">Function: Airavata.searchExperiments</h4> |
| <pre><code>list<<code><a href="experiment_model.html#Struct_ExperimentSummaryModel">experiment_model.ExperimentSummaryModel</a></code>></code> searchExperiments(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code>string</code> userName, |
| <code>map<<code><a href="experiment_model.html#Enum_ExperimentSearchFields">experiment_model.ExperimentSearchFields</a></code>, <code>string</code>></code> filters, |
| <code>i32</code> limit, |
| <code>i32</code> offset) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Search Experiments. |
| Search Experiments by using multiple filter criteria with pagination. Results will be sorted based on creation time DESC. |
| |
| @param gatewayId |
| Identifier of the requested gateway. |
| |
| @param userName |
| Username of the user requesting the search function. |
| |
| @param filters |
| Map of multiple filter criteria. Currenlt search filters includes Experiment Name, Description, Application, etc.... |
| |
| @param limit |
| Amount of results to be fetched. |
| |
| @param offset |
| The starting point of the results to be fetched. |
| |
| @return ExperimentSummaryModel |
| List of experiments for the given search filter. Here only the Experiment summary will be returned. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getExperimentStatistics">Function: Airavata.getExperimentStatistics</h4> |
| <pre><code><a href="experiment_model.html#Struct_ExperimentStatistics">experiment_model.ExperimentStatistics</a></code> getExperimentStatistics(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code>i64</code> fromTime, |
| <code>i64</code> toTime, |
| <code>string</code> userName, |
| <code>string</code> applicationName, |
| <code>string</code> resourceHostName) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Get Experiment Statistics |
| Get Experiment Statisitics for a given gateway for a specific time period. This feature is available only for admins of a particular gateway. Gateway admin access is managed by the user roles. |
| |
| @param gatewayId |
| Unique identifier of the gateway making the request to fetch statistics. |
| |
| @param fromTime |
| Starting date time. |
| |
| @param toTime |
| Ending data time. |
| |
| @param userName |
| Gateway username substring with which to further filter statistics. |
| |
| @param applicationName |
| Application id substring with which to further filter statistics. |
| |
| @param resourceHostName |
| Hostname id substring with which to further filter statistics. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getExperimentsInProject">Function: Airavata.getExperimentsInProject</h4> |
| <pre><code>list<<code><a href="experiment_model.html#Struct_ExperimentModel">experiment_model.ExperimentModel</a></code>></code> getExperimentsInProject(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> projectId, |
| <code>i32</code> limit, |
| <code>i32</code> offset) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_ProjectNotFoundException">airavata_errors.ProjectNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Get All Experiments of the Project |
| Get Experiments within project with pagination. Results will be sorted based on creation time DESC. |
| |
| @param projectId |
| Uniqie identifier of the project. |
| |
| @param limit |
| Amount of results to be fetched. |
| |
| @param offset |
| The starting point of the results to be fetched. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getUserExperiments">Function: Airavata.getUserExperiments</h4> |
| <pre><code>list<<code><a href="experiment_model.html#Struct_ExperimentModel">experiment_model.ExperimentModel</a></code>></code> getUserExperiments(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code>string</code> userName, |
| <code>i32</code> limit, |
| <code>i32</code> offset) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Get All Experiments of the User |
| Get experiments by user with pagination. Results will be sorted based on creation time DESC. |
| |
| @param gatewayId |
| Identifier of the requesting gateway. |
| |
| @param userName |
| Username of the requested end user. |
| |
| @param limit |
| Amount of results to be fetched. |
| |
| @param offset |
| The starting point of the results to be fetched. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_createExperiment">Function: Airavata.createExperiment</h4> |
| <pre><code>string</code> createExperiment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code><a href="experiment_model.html#Struct_ExperimentModel">experiment_model.ExperimentModel</a></code> experiment) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> * |
| * Create New Experiment |
| * Create an experiment for the specified user belonging to the gateway. The gateway identity is not explicitly passed |
| * but inferred from the sshKeyAuthentication header. This experiment is just a persistent place holder. The client |
| * has to subsequently configure and launch the created experiment. No action is taken on Airavata Server except |
| * registering the experiment in a persistent store. |
| * |
| * @param gatewayId |
| * The unique ID of the gateway where the experiment is been created. |
| * |
| * @param ExperimentModel |
| * The create experiment will require the basic experiment metadata like the name and description, intended user, |
| * the gateway identifer and if the experiment should be shared public by defualt. During the creation of an experiment |
| * the ExperimentMetadata is a required field. |
| * |
| * @return |
| * The server-side generated.airavata.registry.core.experiment.globally unique identifier. |
| * |
| * @throws org.apache.airavata.model.error.InvalidRequestException |
| * For any incorrect forming of the request itself. |
| * |
| * @throws org.apache.airavata.model.error.AiravataClientException |
| * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: |
| * |
| * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative |
| * step, then Airavata Registry will not have a provenance area setup. The client has to follow |
| * gateway registration steps and retry this request. |
| * |
| * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. |
| * For now this is a place holder. |
| * |
| * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake |
| * is implemented, the authorization will be more substantial. |
| * |
| * @throws org.apache.airavata.model.error.AiravataSystemException |
| * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client |
| * rather an Airavata Administrator will be notified to take corrective action. |
| * |
| * |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteExperiment">Function: Airavata.deleteExperiment</h4> |
| <pre><code>bool</code> deleteExperiment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> experimentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Delete an Experiment |
| If the experiment is not already launched experiment can be deleted. |
| |
| @param authzToken |
| |
| @param experiementId |
| Experiment ID of the experimnet you want to delete. |
| |
| @return boolean |
| Identifier for the success or failure of the deletion operation. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getExperiment">Function: Airavata.getExperiment</h4> |
| <pre><code><a href="experiment_model.html#Struct_ExperimentModel">experiment_model.ExperimentModel</a></code> getExperiment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> * |
| * Get Experiment |
| * Fetch previously created experiment metadata. |
| * |
| * @param airavataExperimentId |
| * The unique identifier of the requested experiment. This ID is returned during the create experiment step. |
| * |
| * @return ExperimentModel |
| * This method will return the previously stored experiment metadata. |
| * |
| * @throws org.apache.airavata.model.error.InvalidRequestException |
| * For any incorrect forming of the request itself. |
| * |
| * @throws org.apache.airavata.model.error.ExperimentNotFoundException |
| * If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. |
| * |
| * @throws org.apache.airavata.model.error.AiravataClientException |
| * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: |
| * |
| * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative |
| * step, then Airavata Registry will not have a provenance area setup. The client has to follow |
| * gateway registration steps and retry this request. |
| * |
| * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. |
| * For now this is a place holder. |
| * |
| * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake |
| * is implemented, the authorization will be more substantial. |
| * |
| * @throws org.apache.airavata.model.error.AiravataSystemException |
| * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client |
| * rather an Airavata Administrator will be notified to take corrective action. |
| * |
| * |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getExperimentByAdmin">Function: Airavata.getExperimentByAdmin</h4> |
| <pre><code><a href="experiment_model.html#Struct_ExperimentModel">experiment_model.ExperimentModel</a></code> getExperimentByAdmin(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> * |
| * Get Experiment by an admin user |
| * |
| * Used by an admin user to fetch previously created experiment metadata. |
| * |
| * @param airavataExperimentId |
| * The unique identifier of the requested experiment. This ID is returned during the create experiment step. |
| * |
| * @return ExperimentModel |
| * This method will return the previously stored experiment metadata. |
| * |
| * @throws org.apache.airavata.model.error.InvalidRequestException |
| * For any incorrect forming of the request itself. |
| * |
| * @throws org.apache.airavata.model.error.ExperimentNotFoundException |
| * If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. |
| * |
| * @throws org.apache.airavata.model.error.AiravataClientException |
| * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: |
| * |
| * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative |
| * step, then Airavata Registry will not have a provenance area setup. The client has to follow |
| * gateway registration steps and retry this request. |
| * |
| * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. |
| * For now this is a place holder. |
| * |
| * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake |
| * is implemented, the authorization will be more substantial. |
| * |
| * @throws org.apache.airavata.model.error.AiravataSystemException |
| * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client |
| * rather an Airavata Administrator will be notified to take corrective action. |
| * |
| * |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getDetailedExperimentTree">Function: Airavata.getDetailedExperimentTree</h4> |
| <pre><code><a href="experiment_model.html#Struct_ExperimentModel">experiment_model.ExperimentModel</a></code> getDetailedExperimentTree(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Get Complete Experiment Details |
| Fetch the completed nested tree structue of previously created experiment metadata which includes processes -> |
| tasks -> jobs information. |
| |
| @param airavataExperimentId |
| The identifier for the requested experiment. This is returned during the create experiment step. |
| |
| @return ExperimentModel |
| This method will return the previously stored experiment metadata including application input parameters, computational resource scheduling |
| information, special input output handling and additional quality of service parameters. |
| |
| @throws org.apache.airavata.model.error.InvalidRequestException |
| For any incorrect forming of the request itself. |
| |
| @throws org.apache.airavata.model.error.ExperimentNotFoundException |
| If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. |
| |
| @throws org.apache.airavata.model.error.AiravataClientException |
| The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: |
| |
| UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative |
| step, then Airavata Registry will not have a provenance area setup. The client has to follow |
| gateway registration steps and retry this request. |
| |
| AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. |
| For now this is a place holder. |
| |
| INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake |
| is implemented, the authorization will be more substantial. |
| |
| @throws org.apache.airavata.model.error.AiravataSystemException |
| This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client |
| rather an Airavata Administrator will be notified to take corrective action. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateExperiment">Function: Airavata.updateExperiment</h4> |
| <pre><code>void</code> updateExperiment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId, |
| <code><a href="experiment_model.html#Struct_ExperimentModel">experiment_model.ExperimentModel</a></code> experiment) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Update a Previously Created Experiment |
| Configure the CREATED experiment with required inputs, scheduling and other quality of service parameters. This method only updates the experiment object within the registry. |
| The experiment has to be launched to make it actionable by the server. |
| |
| @param airavataExperimentId |
| The identifier for the requested experiment. This is returned during the create experiment step. |
| |
| @param ExperimentModel |
| The configuration information of the experiment with application input parameters, computational resource scheduling |
| information, special input output handling and additional quality of service parameters. |
| |
| @return |
| This method call does not have a return value. |
| |
| @throws org.apache.airavata.model.error.InvalidRequestException |
| For any incorrect forming of the request itself. |
| |
| @throws org.apache.airavata.model.error.ExperimentNotFoundException |
| If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. |
| |
| @throws org.apache.airavata.model.error.AiravataClientException |
| The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: |
| |
| UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative |
| step, then Airavata Registry will not have a provenance area setup. The client has to follow |
| gateway registration steps and retry this request. |
| |
| AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. |
| For now this is a place holder. |
| |
| INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake |
| is implemented, the authorization will be more substantial. |
| |
| @throws org.apache.airavata.model.error.AiravataSystemException |
| This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client |
| rather an Airavata Administrator will be notified to take corrective action. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateExperimentConfiguration">Function: Airavata.updateExperimentConfiguration</h4> |
| <pre><code>void</code> updateExperimentConfiguration(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId, |
| <code><a href="experiment_model.html#Struct_UserConfigurationDataModel">experiment_model.UserConfigurationDataModel</a></code> userConfiguration) |
| throws <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_updateResourceScheduleing">Function: Airavata.updateResourceScheduleing</h4> |
| <pre><code>void</code> updateResourceScheduleing(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId, |
| <code><a href="scheduling_model.html#Struct_ComputationalResourceSchedulingModel">scheduling_model.ComputationalResourceSchedulingModel</a></code> resourceScheduling) |
| throws <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_validateExperiment">Function: Airavata.validateExperiment</h4> |
| <pre><code>bool</code> validateExperiment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> * |
| * Validate experiment configuration. |
| * A true in general indicates, the experiment is ready to be launched. |
| * |
| * @param airavataExperimentId |
| * Unique identifier of the experiment (Experimnent ID) of the experiment which need to be validated. |
| * |
| * @return boolean |
| * Identifier for the success or failure of the validation operation. |
| * |
| * |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_launchExperiment">Function: Airavata.launchExperiment</h4> |
| <pre><code>void</code> launchExperiment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Launch a Previously Created & Configured Experiment. |
| Airavata Server will then start processing the request and appropriate notifications and intermediate and output data will be subsequently available for this experiment. |
| |
| @gatewayId |
| ID of the gateway which will launch the experiment. |
| |
| @param airavataExperimentId |
| The identifier for the requested experiment. This is returned during the create experiment step. |
| |
| @return |
| This method call does not have a return value. |
| |
| @throws org.apache.airavata.model.error.InvalidRequestException |
| For any incorrect forming of the request itself. |
| |
| @throws org.apache.airavata.model.error.ExperimentNotFoundException |
| If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. |
| |
| @throws org.apache.airavata.model.error.AiravataClientException |
| The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: |
| |
| UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative |
| step, then Airavata Registry will not have a provenance area setup. The client has to follow |
| gateway registration steps and retry this request. |
| |
| AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. |
| For now this is a place holder. |
| |
| INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake |
| is implemented, the authorization will be more substantial. |
| |
| @throws org.apache.airavata.model.error.AiravataSystemException |
| This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client |
| rather an Airavata Administrator will be notified to take corrective action. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getExperimentStatus">Function: Airavata.getExperimentStatus</h4> |
| <pre><code><a href="status_models.html#Struct_ExperimentStatus">status_models.ExperimentStatus</a></code> getExperimentStatus(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Get Experiment Status |
| |
| Obtain the status of an experiment by providing the Experiment Id |
| |
| @param authzToken |
| |
| @param airavataExperimentId |
| Experiment ID of the experimnet you require the status. |
| |
| @return ExperimentStatus |
| ExperimentStatus model with the current status will be returned. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getExperimentOutputs">Function: Airavata.getExperimentOutputs</h4> |
| <pre><code>list<<code><a href="application_io_models.html#Struct_OutputDataObjectType">application_io_models.OutputDataObjectType</a></code>></code> getExperimentOutputs(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Get Experiment Outputs |
| This method to be used when need to obtain final outputs of a certain Experiment |
| |
| @param authzToken |
| |
| @param airavataExperimentId |
| Experiment ID of the experimnet you need the outputs. |
| |
| @return list |
| List of experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getIntermediateOutputs">Function: Airavata.getIntermediateOutputs</h4> |
| <pre><code>list<<code><a href="application_io_models.html#Struct_OutputDataObjectType">application_io_models.OutputDataObjectType</a></code>></code> getIntermediateOutputs(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Get Intermediate Experiment Outputs |
| This method to be used when need to obtain intermediate outputs of a certain Experiment |
| |
| @param authzToken |
| |
| @param airavataExperimentId |
| Experiment ID of the experimnet you need intermediate outputs. |
| |
| @return list |
| List of intermediate experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getJobStatuses">Function: Airavata.getJobStatuses</h4> |
| <pre><code>map<<code>string</code>, <code><a href="status_models.html#Struct_JobStatus">status_models.JobStatus</a></code>></code> getJobStatuses(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Get Job Statuses for an Experiment |
| This method to be used when need to get the job status of an Experiment. An experiment may have one or many jobs; there for one or many job statuses may turnup |
| |
| @param authzToken |
| |
| @param experiementId |
| Experiment ID of the experimnet you need the job statuses. |
| |
| @return JobStatus |
| Job status (string) for all all the existing jobs for the experiment will be returned in the form of a map |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getJobDetails">Function: Airavata.getJobDetails</h4> |
| <pre><code>list<<code><a href="job_model.html#Struct_JobModel">job_model.JobModel</a></code>></code> getJobDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Get Job Details for all the jobs within an Experiment. |
| This method to be used when need to get the job details for one or many jobs of an Experiment. |
| |
| @param authzToken |
| |
| @param experiementId |
| Experiment ID of the experimnet you need job details. |
| |
| @return list of JobDetails |
| Job details. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_cloneExperiment">Function: Airavata.cloneExperiment</h4> |
| <pre><code>string</code> cloneExperiment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> existingExperimentID, |
| <code>string</code> newExperimentName, |
| <code>string</code> newExperimentProjectId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code>, <code><a href="airavata_errors.html#Struct_ProjectNotFoundException">airavata_errors.ProjectNotFoundException</a></code> |
| </pre><pre> |
| Clone an Existing Experiment |
| Existing specified experiment is cloned and a new name is provided. A copy of the experiment configuration is made and is persisted with new metadata. |
| The client has to subsequently update this configuration if needed and launch the cloned experiment. |
| |
| @param newExperimentName |
| experiment name that should be used in the cloned experiment |
| |
| @param updatedExperiment |
| Once an experiment is cloned, to disambiguate, the users are suggested to provide new metadata. This will again require |
| the basic experiment metadata like the name and description, intended user, the gateway identifier and if the experiment |
| should be shared public by default. |
| @param newExperimentProjectId |
| The project in which to create the cloned experiment. This is optional and if null the experiment will be created |
| in the same project as the existing experiment. |
| |
| @return |
| The server-side generated.airavata.registry.core.experiment.globally unique identifier (Experiment ID) for the newly cloned experiment. |
| |
| @throws org.apache.airavata.model.error.InvalidRequestException |
| For any incorrect forming of the request itself. |
| |
| @throws org.apache.airavata.model.error.ExperimentNotFoundException |
| If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. |
| |
| @throws org.apache.airavata.model.error.AiravataClientException |
| The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: |
| |
| UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative |
| step, then Airavata Registry will not have a provenance area setup. The client has to follow |
| gateway registration steps and retry this request. |
| |
| AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. |
| For now this is a place holder. |
| |
| INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake |
| is implemented, the authorization will be more substantial. |
| |
| @throws org.apache.airavata.model.error.AiravataSystemException |
| This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client |
| rather an Airavata Administrator will be notified to take corrective action. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_cloneExperimentByAdmin">Function: Airavata.cloneExperimentByAdmin</h4> |
| <pre><code>string</code> cloneExperimentByAdmin(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> existingExperimentID, |
| <code>string</code> newExperimentName, |
| <code>string</code> newExperimentProjectId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code>, <code><a href="airavata_errors.html#Struct_ProjectNotFoundException">airavata_errors.ProjectNotFoundException</a></code> |
| </pre><pre> |
| Clone an Existing Experiment by an admin user |
| Existing specified experiment is cloned and a new name is provided. A copy of the experiment configuration is made and is persisted with new metadata. |
| The client has to subsequently update this configuration if needed and launch the cloned experiment. |
| |
| @param newExperimentName |
| experiment name that should be used in the cloned experiment |
| |
| @param updatedExperiment |
| Once an experiment is cloned, to disambiguate, the users are suggested to provide new metadata. This will again require |
| the basic experiment metadata like the name and description, intended user, the gateway identifier and if the experiment |
| should be shared public by default. |
| @param newExperimentProjectId |
| The project in which to create the cloned experiment. This is optional and if null the experiment will be created |
| in the same project as the existing experiment. |
| |
| @return |
| The server-side generated.airavata.registry.core.experiment.globally unique identifier (Experiment ID) for the newly cloned experiment. |
| |
| @throws org.apache.airavata.model.error.InvalidRequestException |
| For any incorrect forming of the request itself. |
| |
| @throws org.apache.airavata.model.error.ExperimentNotFoundException |
| If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. |
| |
| @throws org.apache.airavata.model.error.AiravataClientException |
| The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: |
| |
| UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative |
| step, then Airavata Registry will not have a provenance area setup. The client has to follow |
| gateway registration steps and retry this request. |
| |
| AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. |
| For now this is a place holder. |
| |
| INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake |
| is implemented, the authorization will be more substantial. |
| |
| @throws org.apache.airavata.model.error.AiravataSystemException |
| This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client |
| rather an Airavata Administrator will be notified to take corrective action. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_terminateExperiment">Function: Airavata.terminateExperiment</h4> |
| <pre><code>void</code> terminateExperiment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> airavataExperimentId, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_ExperimentNotFoundException">airavata_errors.ExperimentNotFoundException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Terminate a running Experiment. |
| |
| @gatewayId |
| ID of the gateway which will terminate the running Experiment. |
| |
| @param airavataExperimentId |
| The identifier of the experiment required termination. This ID is returned during the create experiment step. |
| |
| @return status |
| This method call does not have a return value. |
| |
| @throws org.apache.airavata.model.error.InvalidRequestException |
| For any incorrect forming of the request itself. |
| |
| @throws org.apache.airavata.model.error.ExperimentNotFoundException |
| If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. |
| |
| @throws org.apache.airavata.model.error.AiravataClientException |
| The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: |
| |
| UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative |
| step, then Airavata Registry will not have a provenance area setup. The client has to follow |
| gateway registration steps and retry this request. |
| |
| AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. |
| For now this is a place holder. |
| |
| INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake |
| is implemented, the authorization will be more substantial. |
| |
| @throws org.apache.airavata.model.error.AiravataSystemException |
| This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client |
| rather an Airavata Administrator will be notified to take corrective action. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_registerApplicationModule">Function: Airavata.registerApplicationModule</h4> |
| <pre><code>string</code> registerApplicationModule(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code><a href="application_deployment_model.html#Struct_ApplicationModule">application_deployment_model.ApplicationModule</a></code> applicationModule) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Register a Application Module. |
| |
| @gatewayId |
| ID of the gateway which is registering the new Application Module. |
| |
| @param applicationModule |
| Application Module Object created from the datamodel. |
| |
| @return appModuleId |
| Returns the server-side generated airavata appModule globally unique identifier. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationModule">Function: Airavata.getApplicationModule</h4> |
| <pre><code><a href="application_deployment_model.html#Struct_ApplicationModule">application_deployment_model.ApplicationModule</a></code> getApplicationModule(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appModuleId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch a Application Module. |
| |
| @param appModuleId |
| The unique identifier of the application module required |
| |
| @return applicationModule |
| Returns an Application Module Object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateApplicationModule">Function: Airavata.updateApplicationModule</h4> |
| <pre><code>bool</code> updateApplicationModule(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appModuleId, |
| <code><a href="application_deployment_model.html#Struct_ApplicationModule">application_deployment_model.ApplicationModule</a></code> applicationModule) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Update a Application Module. |
| |
| @param appModuleId |
| The identifier for the requested application module to be updated. |
| |
| @param applicationModule |
| Application Module Object created from the datamodel. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllAppModules">Function: Airavata.getAllAppModules</h4> |
| <pre><code>list<<code><a href="application_deployment_model.html#Struct_ApplicationModule">application_deployment_model.ApplicationModule</a></code>></code> getAllAppModules(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch all Application Module Descriptions. |
| |
| @param gatewayId |
| ID of the gateway which need to list all available application deployment documentation. |
| |
| @return list |
| Returns the list of all Application Module Objects. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAccessibleAppModules">Function: Airavata.getAccessibleAppModules</h4> |
| <pre><code>list<<code><a href="application_deployment_model.html#Struct_ApplicationModule">application_deployment_model.ApplicationModule</a></code>></code> getAccessibleAppModules(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch all accessible Application Module Descriptions. |
| |
| @param gatewayId |
| ID of the gateway which need to list all accessible application deployment documentation. |
| |
| @return list |
| Returns the list of all Application Module Objects that are accessible to the user. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteApplicationModule">Function: Airavata.deleteApplicationModule</h4> |
| <pre><code>bool</code> deleteApplicationModule(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appModuleId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Delete an Application Module. |
| |
| @param appModuleId |
| The identifier of the Application Module to be deleted. |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_registerApplicationDeployment">Function: Airavata.registerApplicationDeployment</h4> |
| <pre><code>string</code> registerApplicationDeployment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code><a href="application_deployment_model.html#Struct_ApplicationDeploymentDescription">application_deployment_model.ApplicationDeploymentDescription</a></code> applicationDeployment) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Register an Application Deployment. |
| |
| @param gatewayId |
| ID of the gateway which is registering the new Application Deployment. |
| |
| @param applicationDeployment |
| Application Module Object created from the datamodel. |
| |
| @return appDeploymentId |
| Returns a server-side generated airavata appDeployment globally unique identifier. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationDeployment">Function: Airavata.getApplicationDeployment</h4> |
| <pre><code><a href="application_deployment_model.html#Struct_ApplicationDeploymentDescription">application_deployment_model.ApplicationDeploymentDescription</a></code> getApplicationDeployment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appDeploymentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch a Application Deployment. |
| |
| @param appDeploymentId |
| The identifier for the requested application module |
| |
| @return applicationDeployment |
| Returns a application Deployment Object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateApplicationDeployment">Function: Airavata.updateApplicationDeployment</h4> |
| <pre><code>bool</code> updateApplicationDeployment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appDeploymentId, |
| <code><a href="application_deployment_model.html#Struct_ApplicationDeploymentDescription">application_deployment_model.ApplicationDeploymentDescription</a></code> applicationDeployment) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Update an Application Deployment. |
| |
| @param appDeploymentId |
| The identifier of the requested application deployment to be updated. |
| |
| @param appDeployment |
| Application Deployment Object created from the datamodel. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteApplicationDeployment">Function: Airavata.deleteApplicationDeployment</h4> |
| <pre><code>bool</code> deleteApplicationDeployment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appDeploymentId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Delete an Application Deployment. |
| |
| @param appDeploymentId |
| The unique identifier of application deployment to be deleted. |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllApplicationDeployments">Function: Airavata.getAllApplicationDeployments</h4> |
| <pre><code>list<<code><a href="application_deployment_model.html#Struct_ApplicationDeploymentDescription">application_deployment_model.ApplicationDeploymentDescription</a></code>></code> getAllApplicationDeployments(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch all Application Deployment Descriptions. |
| |
| @param gatewayId |
| ID of the gateway which need to list all available application deployment documentation. |
| |
| @return list<applicationDeployment. |
| Returns the list of all application Deployment Objects. |
| |
| ></pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAccessibleApplicationDeployments">Function: Airavata.getAccessibleApplicationDeployments</h4> |
| <pre><code>list<<code><a href="application_deployment_model.html#Struct_ApplicationDeploymentDescription">application_deployment_model.ApplicationDeploymentDescription</a></code>></code> getAccessibleApplicationDeployments(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code><a href="group_manager_model.html#Enum_ResourcePermissionType">group_manager_model.ResourcePermissionType</a></code> permissionType) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch all accessible Application Deployment Descriptions. |
| |
| @param gatewayId |
| ID of the gateway which need to list all accessible application deployment documentation. |
| @param permissionType |
| ResourcePermissionType to check for this user |
| |
| @return list<applicationDeployment. |
| Returns the list of all application Deployment Objects that are accessible to the user. |
| |
| ></pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAppModuleDeployedResources">Function: Airavata.getAppModuleDeployedResources</h4> |
| <pre><code>list<<code>string</code>></code> getAppModuleDeployedResources(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appModuleId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Fetch a list of Deployed Compute Hosts. |
| |
| @param appModuleId |
| The identifier for the requested application module |
| |
| @return list<string> |
| Returns a list of Deployed Resources. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationDeploymentsForAppModuleAndGroupResourceProfile">Function: Airavata.getApplicationDeploymentsForAppModuleAndGroupResourceProfile</h4> |
| <pre><code>list<<code><a href="application_deployment_model.html#Struct_ApplicationDeploymentDescription">application_deployment_model.ApplicationDeploymentDescription</a></code>></code> getApplicationDeploymentsForAppModuleAndGroupResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appModuleId, |
| <code>string</code> groupResourceProfileId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Fetch a list of Application Deployments that this user can use for executing the given Application Module using the given Group Resource Profile. |
| The user must have at least READ access to the Group Resource Profile. |
| |
| @param appModuleId |
| The identifier for the Application Module |
| |
| @param groupResourceProfileId |
| The identifier for the Group Resource Profile |
| |
| @return list<ApplicationDeploymentDescription> |
| Returns a list of Application Deployments |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_registerApplicationInterface">Function: Airavata.registerApplicationInterface</h4> |
| <pre><code>string</code> registerApplicationInterface(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId, |
| <code><a href="application_interface_model.html#Struct_ApplicationInterfaceDescription">application_interface_model.ApplicationInterfaceDescription</a></code> applicationInterface) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Register a Application Interface. |
| |
| @param applicationInterface |
| Application Module Object created from the datamodel. |
| |
| @return appInterfaceId |
| Returns a server-side generated airavata application interface globally unique identifier. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_cloneApplicationInterface">Function: Airavata.cloneApplicationInterface</h4> |
| <pre><code>string</code> cloneApplicationInterface(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> existingAppInterfaceID, |
| <code>string</code> newApplicationName, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Clone an Application Interface. |
| |
| @gatewayId |
| The identifier for the gateway profile to be requested |
| |
| @param existingAppInterfaceID |
| Identifier of the existing Application interface you wich to clone. |
| |
| @param newApplicationName |
| Name for the new application interface. |
| |
| @return appInterfaceId |
| Returns a server-side generated globally unique identifier for the newly cloned application interface. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationInterface">Function: Airavata.getApplicationInterface</h4> |
| <pre><code><a href="application_interface_model.html#Struct_ApplicationInterfaceDescription">application_interface_model.ApplicationInterfaceDescription</a></code> getApplicationInterface(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appInterfaceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch an Application Interface. |
| |
| @param appInterfaceId |
| The identifier for the requested application interface. |
| |
| @return applicationInterface |
| Returns an application Interface Object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateApplicationInterface">Function: Airavata.updateApplicationInterface</h4> |
| <pre><code>bool</code> updateApplicationInterface(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appInterfaceId, |
| <code><a href="application_interface_model.html#Struct_ApplicationInterfaceDescription">application_interface_model.ApplicationInterfaceDescription</a></code> applicationInterface) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Update a Application Interface. |
| |
| @param appInterfaceId |
| The identifier of the requested application deployment to be updated. |
| |
| @param appInterface |
| Application Interface Object created from the datamodel. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteApplicationInterface">Function: Airavata.deleteApplicationInterface</h4> |
| <pre><code>bool</code> deleteApplicationInterface(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appInterfaceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Delete an Application Interface. |
| |
| @param appInterfaceId |
| The identifier for the requested application interface to be deleted. |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><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(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch name and ID of Application Interface documents. |
| |
| |
| @return map<applicationId, applicationInterfaceNames> |
| Returns a list of application interfaces with corresponsing ID's |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllApplicationInterfaces">Function: Airavata.getAllApplicationInterfaces</h4> |
| <pre><code>list<<code><a href="application_interface_model.html#Struct_ApplicationInterfaceDescription">application_interface_model.ApplicationInterfaceDescription</a></code>></code> getAllApplicationInterfaces(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch all Application Interface documents. |
| |
| |
| @return map<applicationId, applicationInterfaceNames> |
| Returns a list of application interfaces documents (Application Interface ID, name, description, Inputs and Outputs objects). |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationInputs">Function: Airavata.getApplicationInputs</h4> |
| <pre><code>list<<code><a href="application_io_models.html#Struct_InputDataObjectType">application_io_models.InputDataObjectType</a></code>></code> getApplicationInputs(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appInterfaceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch the list of Application Inputs. |
| |
| @param appInterfaceId |
| The identifier of the application interface which need inputs to be fetched. |
| |
| @return list<application_interface_model.InputDataObjectType> |
| Returns a list of application inputs. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationOutputs">Function: Airavata.getApplicationOutputs</h4> |
| <pre><code>list<<code><a href="application_io_models.html#Struct_OutputDataObjectType">application_io_models.OutputDataObjectType</a></code>></code> getApplicationOutputs(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appInterfaceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch list of Application Outputs. |
| |
| @param appInterfaceId |
| The identifier of the application interface which need outputs to be fetched. |
| |
| @return list<application_interface_model.OutputDataObjectType> |
| Returns a list of application outputs. |
| |
| </pre><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><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> appInterfaceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch a list of all deployed Compute Hosts for a given application interfaces. |
| |
| @param appInterfaceId |
| The identifier for the requested application interface. |
| |
| @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. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_registerComputeResource">Function: Airavata.registerComputeResource</h4> |
| <pre><code>string</code> registerComputeResource(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="compute_resource_model.html#Struct_ComputeResourceDescription">compute_resource_model.ComputeResourceDescription</a></code> computeResourceDescription) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Register a Compute Resource. |
| |
| @param computeResourceDescription |
| Compute Resource Object created from the datamodel. |
| |
| @return computeResourceId |
| Returns a server-side generated airavata compute resource globally unique identifier. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getComputeResource">Function: Airavata.getComputeResource</h4> |
| <pre><code><a href="compute_resource_model.html#Struct_ComputeResourceDescription">compute_resource_model.ComputeResourceDescription</a></code> getComputeResource(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Fetch the given Compute Resource. |
| |
| @param computeResourceId |
| The identifier for the requested compute resource |
| |
| @return computeResourceDescription |
| Compute Resource Object created from the datamodel.. |
| |
| </pre><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(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch all registered Compute Resources. |
| |
| @return A map of registered compute resource id's and thier corresponding hostnames. |
| Compute Resource Object created from the datamodel.. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateComputeResource">Function: Airavata.updateComputeResource</h4> |
| <pre><code>bool</code> updateComputeResource(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code><a href="compute_resource_model.html#Struct_ComputeResourceDescription">compute_resource_model.ComputeResourceDescription</a></code> computeResourceDescription) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Update a Compute Resource. |
| |
| @param computeResourceId |
| The identifier for the requested compute resource to be updated. |
| |
| @param computeResourceDescription |
| Compute Resource Object created from the datamodel. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteComputeResource">Function: Airavata.deleteComputeResource</h4> |
| <pre><code>bool</code> deleteComputeResource(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete a Compute Resource. |
| |
| @param computeResourceId |
| The identifier for the requested compute resource to be deleted. |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_registerStorageResource">Function: Airavata.registerStorageResource</h4> |
| <pre><code>string</code> registerStorageResource(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="storage_resource_model.html#Struct_StorageResourceDescription">storage_resource_model.StorageResourceDescription</a></code> storageResourceDescription) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Register a Storage Resource. |
| |
| @param storageResourceDescription |
| Storge Resource Object created from the datamodel. |
| |
| @return storageResourceId |
| Returns a server-side generated airavata storage resource globally unique identifier. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getStorageResource">Function: Airavata.getStorageResource</h4> |
| <pre><code><a href="storage_resource_model.html#Struct_StorageResourceDescription">storage_resource_model.StorageResourceDescription</a></code> getStorageResource(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> storageResourceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Fetch the given Storage Resource. |
| |
| @param storageResourceId |
| The identifier for the requested storage resource |
| |
| @return storageResourceDescription |
| Storage Resource Object created from the datamodel.. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllStorageResourceNames">Function: Airavata.getAllStorageResourceNames</h4> |
| <pre><code>map<<code>string</code>, <code>string</code>></code> getAllStorageResourceNames(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Fetch all registered Storage Resources. |
| |
| @return A map of registered compute resource id's and thier corresponding hostnames. |
| Compute Resource Object created from the datamodel.. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateStorageResource">Function: Airavata.updateStorageResource</h4> |
| <pre><code>bool</code> updateStorageResource(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> storageResourceId, |
| <code><a href="storage_resource_model.html#Struct_StorageResourceDescription">storage_resource_model.StorageResourceDescription</a></code> storageResourceDescription) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Update a Storage Resource. |
| |
| @param storageResourceId |
| The identifier for the requested compute resource to be updated. |
| |
| @param storageResourceDescription |
| Storage Resource Object created from the datamodel. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteStorageResource">Function: Airavata.deleteStorageResource</h4> |
| <pre><code>bool</code> deleteStorageResource(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> storageResourceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete a Storage Resource. |
| |
| @param storageResourceId |
| The identifier of the requested compute resource to be deleted. |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addLocalSubmissionDetails">Function: Airavata.addLocalSubmissionDetails</h4> |
| <pre><code>string</code> addLocalSubmissionDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>i32</code> priorityOrder, |
| <code><a href="compute_resource_model.html#Struct_LOCALSubmission">compute_resource_model.LOCALSubmission</a></code> localSubmission) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Add a Local Job Submission details to a compute resource |
| App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. |
| |
| @param computeResourceId |
| The identifier of the compute resource to which JobSubmission protocol to be added |
| |
| @param priorityOrder |
| Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. |
| |
| @param localSubmission |
| The LOCALSubmission object to be added to the resource. |
| |
| @return status |
| Returns the unique job submission id. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateLocalSubmissionDetails">Function: Airavata.updateLocalSubmissionDetails</h4> |
| <pre><code>bool</code> updateLocalSubmissionDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> jobSubmissionInterfaceId, |
| <code><a href="compute_resource_model.html#Struct_LOCALSubmission">compute_resource_model.LOCALSubmission</a></code> localSubmission) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Update the given Local Job Submission details |
| |
| @param jobSubmissionInterfaceId |
| The identifier of the JobSubmission Interface to be updated. |
| |
| @param localSubmission |
| The LOCALSubmission object to be updated. |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getLocalJobSubmission">Function: Airavata.getLocalJobSubmission</h4> |
| <pre><code><a href="compute_resource_model.html#Struct_LOCALSubmission">compute_resource_model.LOCALSubmission</a></code> getLocalJobSubmission(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> jobSubmissionId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>This method returns localJobSubmission object |
| @param jobSubmissionInterfaceId |
| The identifier of the JobSubmission Interface to be retrieved. |
| @return LOCALSubmission instance |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addSSHJobSubmissionDetails">Function: Airavata.addSSHJobSubmissionDetails</h4> |
| <pre><code>string</code> addSSHJobSubmissionDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>i32</code> priorityOrder, |
| <code><a href="compute_resource_model.html#Struct_SSHJobSubmission">compute_resource_model.SSHJobSubmission</a></code> sshJobSubmission) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Add a SSH Job Submission details to a compute resource |
| App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. |
| |
| @param computeResourceId |
| The identifier of the compute resource to which JobSubmission protocol to be added |
| |
| @param priorityOrder |
| Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. |
| |
| @param sshJobSubmission |
| The SSHJobSubmission object to be added to the resource. |
| |
| @return status |
| Returns the unique job submission id. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addSSHForkJobSubmissionDetails">Function: Airavata.addSSHForkJobSubmissionDetails</h4> |
| <pre><code>string</code> addSSHForkJobSubmissionDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>i32</code> priorityOrder, |
| <code><a href="compute_resource_model.html#Struct_SSHJobSubmission">compute_resource_model.SSHJobSubmission</a></code> sshJobSubmission) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Add a SSH_FORK Job Submission details to a compute resource |
| App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. |
| |
| @param computeResourceId |
| The identifier of the compute resource to which JobSubmission protocol to be added |
| |
| @param priorityOrder |
| Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. |
| |
| @param sshJobSubmission |
| The SSHJobSubmission object to be added to the resource. |
| |
| @return status |
| Returns the unique job submission id. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getSSHJobSubmission">Function: Airavata.getSSHJobSubmission</h4> |
| <pre><code><a href="compute_resource_model.html#Struct_SSHJobSubmission">compute_resource_model.SSHJobSubmission</a></code> getSSHJobSubmission(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> jobSubmissionId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>This method returns SSHJobSubmission object |
| @param jobSubmissionInterfaceId |
| The identifier of the JobSubmission Interface to be retrieved. |
| @return SSHJobSubmission instance |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addUNICOREJobSubmissionDetails">Function: Airavata.addUNICOREJobSubmissionDetails</h4> |
| <pre><code>string</code> addUNICOREJobSubmissionDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>i32</code> priorityOrder, |
| <code><a href="compute_resource_model.html#Struct_UnicoreJobSubmission">compute_resource_model.UnicoreJobSubmission</a></code> unicoreJobSubmission) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Add a UNICORE Job Submission details to a compute resource |
| App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. |
| |
| @param computeResourceId |
| The identifier of the compute resource to which JobSubmission protocol to be added |
| |
| @param priorityOrder |
| Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. |
| |
| @param unicoreJobSubmission |
| The UnicoreJobSubmission object to be added to the resource. |
| |
| @return status |
| Returns the unique job submission id. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getUnicoreJobSubmission">Function: Airavata.getUnicoreJobSubmission</h4> |
| <pre><code><a href="compute_resource_model.html#Struct_UnicoreJobSubmission">compute_resource_model.UnicoreJobSubmission</a></code> getUnicoreJobSubmission(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> jobSubmissionId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> * |
| * This method returns UnicoreJobSubmission object |
| * |
| * @param jobSubmissionInterfaceId |
| * The identifier of the JobSubmission Interface to be retrieved. |
| * @return UnicoreJobSubmission instance |
| * |
| * |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addCloudJobSubmissionDetails">Function: Airavata.addCloudJobSubmissionDetails</h4> |
| <pre><code>string</code> addCloudJobSubmissionDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>i32</code> priorityOrder, |
| <code><a href="compute_resource_model.html#Struct_CloudJobSubmission">compute_resource_model.CloudJobSubmission</a></code> cloudSubmission) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> * |
| * Add a Cloud Job Submission details to a compute resource |
| * App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. |
| * |
| * @param computeResourceId |
| * The identifier of the compute resource to which JobSubmission protocol to be added |
| * |
| * @param priorityOrder |
| * Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. |
| * |
| * @param sshJobSubmission |
| * The SSHJobSubmission object to be added to the resource. |
| * |
| * @return status |
| * Returns the unique job submission id. |
| * |
| * |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getCloudJobSubmission">Function: Airavata.getCloudJobSubmission</h4> |
| <pre><code><a href="compute_resource_model.html#Struct_CloudJobSubmission">compute_resource_model.CloudJobSubmission</a></code> getCloudJobSubmission(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> jobSubmissionId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> * |
| * This method returns cloudJobSubmission object |
| * @param jobSubmissionInterfaceI |
| * The identifier of the JobSubmission Interface to be retrieved. |
| * @return CloudJobSubmission instance |
| * |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateSSHJobSubmissionDetails">Function: Airavata.updateSSHJobSubmissionDetails</h4> |
| <pre><code>bool</code> updateSSHJobSubmissionDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> jobSubmissionInterfaceId, |
| <code><a href="compute_resource_model.html#Struct_SSHJobSubmission">compute_resource_model.SSHJobSubmission</a></code> sshJobSubmission) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Update the given SSH Job Submission details |
| |
| @param jobSubmissionInterfaceId |
| The identifier of the JobSubmission Interface to be updated. |
| |
| @param sshJobSubmission |
| The SSHJobSubmission object to be updated. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateCloudJobSubmissionDetails">Function: Airavata.updateCloudJobSubmissionDetails</h4> |
| <pre><code>bool</code> updateCloudJobSubmissionDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> jobSubmissionInterfaceId, |
| <code><a href="compute_resource_model.html#Struct_CloudJobSubmission">compute_resource_model.CloudJobSubmission</a></code> sshJobSubmission) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Update the cloud Job Submission details |
| |
| @param jobSubmissionInterfaceId |
| The identifier of the JobSubmission Interface to be updated. |
| |
| @param cloudJobSubmission |
| The CloudJobSubmission object to be updated. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateUnicoreJobSubmissionDetails">Function: Airavata.updateUnicoreJobSubmissionDetails</h4> |
| <pre><code>bool</code> updateUnicoreJobSubmissionDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> jobSubmissionInterfaceId, |
| <code><a href="compute_resource_model.html#Struct_UnicoreJobSubmission">compute_resource_model.UnicoreJobSubmission</a></code> unicoreJobSubmission) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Update the UNIOCRE Job Submission details |
| |
| @param jobSubmissionInterfaceId |
| The identifier of the JobSubmission Interface to be updated. |
| |
| @param UnicoreJobSubmission |
| The UnicoreJobSubmission object to be updated. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addLocalDataMovementDetails">Function: Airavata.addLocalDataMovementDetails</h4> |
| <pre><code>string</code> addLocalDataMovementDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> productUri, |
| <code><a href="data_movement_models.html#Enum_DMType">data_movement_models.DMType</a></code> dataMoveType, |
| <code>i32</code> priorityOrder, |
| <code><a href="data_movement_models.html#Struct_LOCALDataMovement">data_movement_models.LOCALDataMovement</a></code> localDataMovement) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Add a Local data movement details to a compute resource |
| App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. |
| |
| @param productUri |
| The identifier of the compute resource to which JobSubmission protocol to be added |
| |
| @param DMType |
| DMType object to be added to the resource. |
| |
| @param priorityOrder |
| Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. |
| |
| @param localDataMovement |
| The LOCALDataMovement object to be added to the resource. |
| |
| @return status |
| Returns the unique job submission id. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateLocalDataMovementDetails">Function: Airavata.updateLocalDataMovementDetails</h4> |
| <pre><code>bool</code> updateLocalDataMovementDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> dataMovementInterfaceId, |
| <code><a href="data_movement_models.html#Struct_LOCALDataMovement">data_movement_models.LOCALDataMovement</a></code> localDataMovement) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Update the given Local data movement details |
| |
| @param dataMovementInterfaceId |
| The identifier of the data movement Interface to be updated. |
| |
| @param localDataMovement |
| The LOCALDataMovement object to be updated. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getLocalDataMovement">Function: Airavata.getLocalDataMovement</h4> |
| <pre><code><a href="data_movement_models.html#Struct_LOCALDataMovement">data_movement_models.LOCALDataMovement</a></code> getLocalDataMovement(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> dataMovementId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| This method returns local datamovement object. |
| |
| @param dataMovementId |
| The identifier of the datamovement Interface to be retrieved. |
| |
| @return LOCALDataMovement instance |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addSCPDataMovementDetails">Function: Airavata.addSCPDataMovementDetails</h4> |
| <pre><code>string</code> addSCPDataMovementDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> productUri, |
| <code><a href="data_movement_models.html#Enum_DMType">data_movement_models.DMType</a></code> dataMoveType, |
| <code>i32</code> priorityOrder, |
| <code><a href="data_movement_models.html#Struct_SCPDataMovement">data_movement_models.SCPDataMovement</a></code> scpDataMovement) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Add a SCP data movement details to a compute resource |
| App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. |
| |
| @param productUri |
| The identifier of the compute resource to which JobSubmission protocol to be added |
| |
| @param priorityOrder |
| Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. |
| |
| @param scpDataMovement |
| The SCPDataMovement object to be added to the resource. |
| |
| @return status |
| Returns the unique job submission id. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateSCPDataMovementDetails">Function: Airavata.updateSCPDataMovementDetails</h4> |
| <pre><code>bool</code> updateSCPDataMovementDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> dataMovementInterfaceId, |
| <code><a href="data_movement_models.html#Struct_SCPDataMovement">data_movement_models.SCPDataMovement</a></code> scpDataMovement) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Update the given scp data movement details |
| App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. |
| |
| @param dataMovementInterfaceId |
| The identifier of the data movement Interface to be updated. |
| |
| @param scpDataMovement |
| The SCPDataMovement object to be updated. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getSCPDataMovement">Function: Airavata.getSCPDataMovement</h4> |
| <pre><code><a href="data_movement_models.html#Struct_SCPDataMovement">data_movement_models.SCPDataMovement</a></code> getSCPDataMovement(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> dataMovementId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>This method returns SCP datamovement object |
| |
| @param dataMovementId |
| The identifier of the datamovement Interface to be retrieved. |
| |
| @return SCPDataMovement instance |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addUnicoreDataMovementDetails">Function: Airavata.addUnicoreDataMovementDetails</h4> |
| <pre><code>string</code> addUnicoreDataMovementDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> productUri, |
| <code><a href="data_movement_models.html#Enum_DMType">data_movement_models.DMType</a></code> dataMoveType, |
| <code>i32</code> priorityOrder, |
| <code><a href="data_movement_models.html#Struct_UnicoreDataMovement">data_movement_models.UnicoreDataMovement</a></code> unicoreDataMovement) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Add a UNICORE data movement details to a compute resource |
| App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. |
| |
| @param productUri |
| The identifier of the compute resource to which data movement protocol to be added |
| |
| @param priorityOrder |
| Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. |
| |
| @param UnicoreDataMovement |
| The UnicoreDataMovement object to be added to the resource. |
| |
| @return status |
| Returns the unique data movement id. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateUnicoreDataMovementDetails">Function: Airavata.updateUnicoreDataMovementDetails</h4> |
| <pre><code>bool</code> updateUnicoreDataMovementDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> dataMovementInterfaceId, |
| <code><a href="data_movement_models.html#Struct_UnicoreDataMovement">data_movement_models.UnicoreDataMovement</a></code> unicoreDataMovement) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Update a selected UNICORE data movement details |
| App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. |
| |
| @param dataMovementInterfaceId |
| The identifier of the data movement Interface to be updated. |
| |
| @param UnicoreDataMovement |
| The UnicoreDataMovement object to be updated. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getUnicoreDataMovement">Function: Airavata.getUnicoreDataMovement</h4> |
| <pre><code><a href="data_movement_models.html#Struct_UnicoreDataMovement">data_movement_models.UnicoreDataMovement</a></code> getUnicoreDataMovement(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> dataMovementId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| This method returns UNICORE datamovement object |
| |
| @param dataMovementId |
| The identifier of the datamovement Interface to be retrieved. |
| |
| @return UnicoreDataMovement instance |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addGridFTPDataMovementDetails">Function: Airavata.addGridFTPDataMovementDetails</h4> |
| <pre><code>string</code> addGridFTPDataMovementDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> productUri, |
| <code><a href="data_movement_models.html#Enum_DMType">data_movement_models.DMType</a></code> dataMoveType, |
| <code>i32</code> priorityOrder, |
| <code><a href="data_movement_models.html#Struct_GridFTPDataMovement">data_movement_models.GridFTPDataMovement</a></code> gridFTPDataMovement) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Add a GridFTP data movement details to a compute resource |
| App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. |
| |
| @param productUri |
| The identifier of the compute resource to which dataMovement protocol to be added |
| |
| @param DMType |
| The DMType object to be added to the resource. |
| |
| @param priorityOrder |
| Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. |
| |
| @param gridFTPDataMovement |
| The GridFTPDataMovement object to be added to the resource. |
| |
| @return status |
| Returns the unique data movement id. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateGridFTPDataMovementDetails">Function: Airavata.updateGridFTPDataMovementDetails</h4> |
| <pre><code>bool</code> updateGridFTPDataMovementDetails(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> dataMovementInterfaceId, |
| <code><a href="data_movement_models.html#Struct_GridFTPDataMovement">data_movement_models.GridFTPDataMovement</a></code> gridFTPDataMovement) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><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. |
| |
| @param dataMovementInterfaceId |
| The identifier of the data movement Interface to be updated. |
| |
| @param gridFTPDataMovement |
| The GridFTPDataMovement object to be updated. |
| |
| @return boolean |
| Returns a success/failure of the update. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getGridFTPDataMovement">Function: Airavata.getGridFTPDataMovement</h4> |
| <pre><code><a href="data_movement_models.html#Struct_GridFTPDataMovement">data_movement_models.GridFTPDataMovement</a></code> getGridFTPDataMovement(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> dataMovementId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>This method returns GridFTP datamovement object |
| |
| @param dataMovementId |
| The identifier of the datamovement Interface to be retrieved. |
| |
| @return GridFTPDataMovement instance |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_changeJobSubmissionPriority">Function: Airavata.changeJobSubmissionPriority</h4> |
| <pre><code>bool</code> changeJobSubmissionPriority(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> jobSubmissionInterfaceId, |
| <code>i32</code> newPriorityOrder) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Change the priority of a given job submisison interface |
| |
| @param jobSubmissionInterfaceId |
| The identifier of the JobSubmission Interface to be changed |
| |
| @param priorityOrder |
| The new priority of the job manager interface. |
| |
| @return status |
| Returns a success/failure of the change. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_changeDataMovementPriority">Function: Airavata.changeDataMovementPriority</h4> |
| <pre><code>bool</code> changeDataMovementPriority(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> dataMovementInterfaceId, |
| <code>i32</code> newPriorityOrder) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Change the priority of a given data movement interface |
| |
| @param dataMovementInterfaceId |
| The identifier of the DataMovement Interface to be changed |
| |
| @param priorityOrder |
| The new priority of the data movement interface. |
| |
| @return status |
| Returns a success/failure of the change. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_changeJobSubmissionPriorities">Function: Airavata.changeJobSubmissionPriorities</h4> |
| <pre><code>bool</code> changeJobSubmissionPriorities(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>map<<code>string</code>, <code>i32</code>></code> jobSubmissionPriorityMap) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Change the priorities of a given set of job submission interfaces |
| |
| @param jobSubmissionPriorityMap |
| A Map of identifiers of the JobSubmission Interfaces and thier associated priorities to be set. |
| |
| @return status |
| Returns a success/failure of the changes. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_changeDataMovementPriorities">Function: Airavata.changeDataMovementPriorities</h4> |
| <pre><code>bool</code> changeDataMovementPriorities(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>map<<code>string</code>, <code>i32</code>></code> dataMovementPriorityMap) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Change the priorities of a given set of data movement interfaces |
| |
| @param dataMovementPriorityMap |
| A Map of identifiers of the DataMovement Interfaces and thier associated priorities to be set. |
| |
| @return status |
| Returns a success/failure of the changes. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteJobSubmissionInterface">Function: Airavata.deleteJobSubmissionInterface</h4> |
| <pre><code>bool</code> deleteJobSubmissionInterface(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>string</code> jobSubmissionInterfaceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete a given job submisison interface |
| |
| @param jobSubmissionInterfaceId |
| The identifier of the JobSubmission Interface to be changed |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteDataMovementInterface">Function: Airavata.deleteDataMovementInterface</h4> |
| <pre><code>bool</code> deleteDataMovementInterface(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> productUri, |
| <code>string</code> dataMovementInterfaceId, |
| <code><a href="data_movement_models.html#Enum_DMType">data_movement_models.DMType</a></code> dataMoveType) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete a given data movement interface |
| |
| @param dataMovementInterfaceId |
| The identifier of the DataMovement Interface to be changed |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_registerResourceJobManager">Function: Airavata.registerResourceJobManager</h4> |
| <pre><code>string</code> registerResourceJobManager(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="compute_resource_model.html#Struct_ResourceJobManager">compute_resource_model.ResourceJobManager</a></code> resourceJobManager) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_updateResourceJobManager">Function: Airavata.updateResourceJobManager</h4> |
| <pre><code>bool</code> updateResourceJobManager(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceJobManagerId, |
| <code><a href="compute_resource_model.html#Struct_ResourceJobManager">compute_resource_model.ResourceJobManager</a></code> updatedResourceJobManager) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getResourceJobManager">Function: Airavata.getResourceJobManager</h4> |
| <pre><code><a href="compute_resource_model.html#Struct_ResourceJobManager">compute_resource_model.ResourceJobManager</a></code> getResourceJobManager(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceJobManagerId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_deleteResourceJobManager">Function: Airavata.deleteResourceJobManager</h4> |
| <pre><code>bool</code> deleteResourceJobManager(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceJobManagerId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_deleteBatchQueue">Function: Airavata.deleteBatchQueue</h4> |
| <pre><code>bool</code> deleteBatchQueue(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>string</code> queueName) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete a Compute Resource Queue |
| |
| @param computeResourceId |
| The identifier of the compute resource which has the queue to be deleted |
| |
| @param queueName |
| Name of the queue need to be deleted. Name is the uniqueue identifier for the queue within a compute resource |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_registerGatewayResourceProfile">Function: Airavata.registerGatewayResourceProfile</h4> |
| <pre><code>string</code> registerGatewayResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="gateway_resource_profile_model.html#Struct_GatewayResourceProfile">gateway_resource_profile_model.GatewayResourceProfile</a></code> gatewayResourceProfile) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Register a Gateway Resource Profile. |
| |
| @param gatewayResourceProfile |
| Gateway Resource Profile Object. |
| The GatewayID should be obtained from Airavata gateway registration and passed to register a corresponding |
| resource profile. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getGatewayResourceProfile">Function: Airavata.getGatewayResourceProfile</h4> |
| <pre><code><a href="gateway_resource_profile_model.html#Struct_GatewayResourceProfile">gateway_resource_profile_model.GatewayResourceProfile</a></code> getGatewayResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Fetch the given Gateway Resource Profile. |
| |
| @param gatewayID |
| The identifier for the requested gateway resource. |
| |
| @return gatewayResourceProfile |
| Gateway Resource Profile Object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateGatewayResourceProfile">Function: Airavata.updateGatewayResourceProfile</h4> |
| <pre><code>bool</code> updateGatewayResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID, |
| <code><a href="gateway_resource_profile_model.html#Struct_GatewayResourceProfile">gateway_resource_profile_model.GatewayResourceProfile</a></code> gatewayResourceProfile) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Update a Gateway Resource Profile. |
| |
| @param gatewayID |
| The identifier for the requested gateway resource to be updated. |
| |
| @param gatewayResourceProfile |
| Gateway Resource Profile Object. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteGatewayResourceProfile">Function: Airavata.deleteGatewayResourceProfile</h4> |
| <pre><code>bool</code> deleteGatewayResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete the given Gateway Resource Profile. |
| |
| @param gatewayID |
| The identifier for the requested gateway resource to be deleted. |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addGatewayComputeResourcePreference">Function: Airavata.addGatewayComputeResourcePreference</h4> |
| <pre><code>bool</code> addGatewayComputeResourcePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID, |
| <code>string</code> computeResourceId, |
| <code><a href="gateway_resource_profile_model.html#Struct_ComputeResourcePreference">gateway_resource_profile_model.ComputeResourcePreference</a></code> computeResourcePreference) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Add a Compute Resource Preference to a registered gateway profile. |
| |
| @param gatewayID |
| The identifier for the gateway profile to be added. |
| |
| @param computeResourceId |
| Preferences related to a particular compute resource |
| |
| @param computeResourcePreference |
| The ComputeResourcePreference object to be added to the resource profile. |
| |
| @return status |
| Returns a success/failure of the addition. If a profile already exists, this operation will fail. |
| Instead an update should be used. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addGatewayStoragePreference">Function: Airavata.addGatewayStoragePreference</h4> |
| <pre><code>bool</code> addGatewayStoragePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID, |
| <code>string</code> storageResourceId, |
| <code><a href="gateway_resource_profile_model.html#Struct_StoragePreference">gateway_resource_profile_model.StoragePreference</a></code> storagePreference) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Add a Storage Resource Preference to a registered gateway profile. |
| |
| @param gatewayID |
| The identifier of the gateway profile to be added. |
| |
| @param storageResourceId |
| Preferences related to a particular compute resource |
| |
| @param computeResourcePreference |
| The ComputeResourcePreference object to be added to the resource profile. |
| |
| @return status |
| Returns a success/failure of the addition. If a profile already exists, this operation will fail. |
| Instead an update should be used. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getGatewayComputeResourcePreference">Function: Airavata.getGatewayComputeResourcePreference</h4> |
| <pre><code><a href="gateway_resource_profile_model.html#Struct_ComputeResourcePreference">gateway_resource_profile_model.ComputeResourcePreference</a></code> getGatewayComputeResourcePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID, |
| <code>string</code> computeResourceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch a Compute Resource Preference of a registered gateway profile. |
| |
| @param gatewayID |
| The identifier for the gateway profile to be requested |
| |
| @param computeResourceId |
| Preferences related to a particular compute resource |
| |
| @return computeResourcePreference |
| Returns the ComputeResourcePreference object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getGatewayStoragePreference">Function: Airavata.getGatewayStoragePreference</h4> |
| <pre><code><a href="gateway_resource_profile_model.html#Struct_StoragePreference">gateway_resource_profile_model.StoragePreference</a></code> getGatewayStoragePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID, |
| <code>string</code> storageResourceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch a Storage Resource Preference of a registered gateway profile. |
| |
| @param gatewayID |
| The identifier of the gateway profile to request to fetch the particular storage resource preference. |
| |
| @param storageResourceId |
| Identifier of the Stprage Preference required to be fetched. |
| |
| @return StoragePreference |
| Returns the StoragePreference object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllGatewayComputeResourcePreferences">Function: Airavata.getAllGatewayComputeResourcePreferences</h4> |
| <pre><code>list<<code><a href="gateway_resource_profile_model.html#Struct_ComputeResourcePreference">gateway_resource_profile_model.ComputeResourcePreference</a></code>></code> getAllGatewayComputeResourcePreferences(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch all Compute Resource Preferences of a registered gateway profile. |
| |
| @param gatewayID |
| The identifier for the gateway profile to be requested |
| |
| @return computeResourcePreference |
| Returns the ComputeResourcePreference object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllGatewayStoragePreferences">Function: Airavata.getAllGatewayStoragePreferences</h4> |
| <pre><code>list<<code><a href="gateway_resource_profile_model.html#Struct_StoragePreference">gateway_resource_profile_model.StoragePreference</a></code>></code> getAllGatewayStoragePreferences(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Fetch all Storage Resource Preferences of a registered gateway profile. |
| |
| @param gatewayID |
| The identifier for the gateway profile to be requested |
| |
| @return StoragePreference |
| Returns the StoragePreference object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllGatewayResourceProfiles">Function: Airavata.getAllGatewayResourceProfiles</h4> |
| <pre><code>list<<code><a href="gateway_resource_profile_model.html#Struct_GatewayResourceProfile">gateway_resource_profile_model.GatewayResourceProfile</a></code>></code> getAllGatewayResourceProfiles(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch all Gateway Profiles registered |
| |
| @return GatewayResourceProfile |
| Returns all the GatewayResourcePrifle list object. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateGatewayComputeResourcePreference">Function: Airavata.updateGatewayComputeResourcePreference</h4> |
| <pre><code>bool</code> updateGatewayComputeResourcePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID, |
| <code>string</code> computeResourceId, |
| <code><a href="gateway_resource_profile_model.html#Struct_ComputeResourcePreference">gateway_resource_profile_model.ComputeResourcePreference</a></code> computeResourcePreference) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Update a Compute Resource Preference to a registered gateway profile. |
| |
| @param gatewayID |
| The identifier for the gateway profile to be updated. |
| |
| @param computeResourceId |
| Preferences related to a particular compute resource |
| |
| @param computeResourcePreference |
| The ComputeResourcePreference object to be updated to the resource profile. |
| |
| @return status |
| Returns a success/failure of the updation. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateGatewayStoragePreference">Function: Airavata.updateGatewayStoragePreference</h4> |
| <pre><code>bool</code> updateGatewayStoragePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID, |
| <code>string</code> storageId, |
| <code><a href="gateway_resource_profile_model.html#Struct_StoragePreference">gateway_resource_profile_model.StoragePreference</a></code> storagePreference) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Update a Storage Resource Preference of a registered gateway profile. |
| |
| @param gatewayID |
| The identifier of the gateway profile to be updated. |
| |
| @param storageId |
| The Storage resource identifier of the one that you want to update |
| |
| @param storagePreference |
| The storagePreference object to be updated to the resource profile. |
| |
| @return status |
| Returns a success/failure of the updation. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteGatewayComputeResourcePreference">Function: Airavata.deleteGatewayComputeResourcePreference</h4> |
| <pre><code>bool</code> deleteGatewayComputeResourcePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID, |
| <code>string</code> computeResourceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete the Compute Resource Preference of a registered gateway profile. |
| |
| @param gatewayID |
| The identifier for the gateway profile to be deleted. |
| |
| @param computeResourceId |
| Preferences related to a particular compute resource |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteGatewayStoragePreference">Function: Airavata.deleteGatewayStoragePreference</h4> |
| <pre><code>bool</code> deleteGatewayStoragePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayID, |
| <code>string</code> storageId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete the Storage Resource Preference of a registered gateway profile. |
| |
| @param gatewayID |
| The identifier of the gateway profile to be deleted. |
| |
| @param storageId |
| ID of the storage preference you want to delete. |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getSSHAccountProvisioners">Function: Airavata.getSSHAccountProvisioners</h4> |
| <pre><code>list<<code><a href="account_provisioning_model.html#Struct_SSHAccountProvisioner">account_provisioning_model.SSHAccountProvisioner</a></code>></code> getSSHAccountProvisioners(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_doesUserHaveSSHAccount">Function: Airavata.doesUserHaveSSHAccount</h4> |
| <pre><code>bool</code> doesUserHaveSSHAccount(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>string</code> userId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Check if user has an SSH account on the given compute resource. This |
| method will only work if the compute resource has an SSHAccountProvisioner configured for it. |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_isSSHSetupCompleteForUserComputeResourcePreference">Function: Airavata.isSSHSetupCompleteForUserComputeResourcePreference</h4> |
| <pre><code>bool</code> isSSHSetupCompleteForUserComputeResourcePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>string</code> airavataCredStoreToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Check if SSH account setup is complete for this user on the given compute resource. |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_setupUserComputeResourcePreferencesForSSH">Function: Airavata.setupUserComputeResourcePreferencesForSSH</h4> |
| <pre><code><a href="user_resource_profile_model.html#Struct_UserComputeResourcePreference">user_resource_profile_model.UserComputeResourcePreference</a></code> setupUserComputeResourcePreferencesForSSH(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>string</code> userId, |
| <code>string</code> airavataCredStoreToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Setup and return a UserComputeResourcePreference object for this user to SSH into the given compute resource with |
| the given SSH credential. This method will only work if the compute resource has an SSHAccountProvisioner |
| configured for it. The returned UserComputeResourcePreference object is not saved; it is up to the client to |
| call addUserComputeResourcePreference to persist it. |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_registerUserResourceProfile">Function: Airavata.registerUserResourceProfile</h4> |
| <pre><code>string</code> registerUserResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="user_resource_profile_model.html#Struct_UserResourceProfile">user_resource_profile_model.UserResourceProfile</a></code> userResourceProfile) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Register User Resource Profile. |
| |
| @param UserResourceProfile |
| User Resource Profile Object. |
| The userId should be obtained from Airavata user profile data model and passed to register a corresponding |
| resource profile. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_isUserResourceProfileExists">Function: Airavata.isUserResourceProfileExists</h4> |
| <pre><code>bool</code> isUserResourceProfileExists(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Check if User Resource Profile exists. |
| |
| @param userId |
| The identifier for the requested user resource profile. |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @return bool |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getUserResourceProfile">Function: Airavata.getUserResourceProfile</h4> |
| <pre><code><a href="user_resource_profile_model.html#Struct_UserResourceProfile">user_resource_profile_model.UserResourceProfile</a></code> getUserResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Fetch the given User Resource Profile. |
| |
| @param userId |
| The identifier for the requested user resource profile. |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @return UserResourceProfile |
| User Resource Profile Object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateUserResourceProfile">Function: Airavata.updateUserResourceProfile</h4> |
| <pre><code>bool</code> updateUserResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID, |
| <code><a href="user_resource_profile_model.html#Struct_UserResourceProfile">user_resource_profile_model.UserResourceProfile</a></code> userResourceProfile) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Update a User Resource Profile. |
| |
| @param userId |
| The identifier for the requested user resource to be updated. |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @param UserResourceProfile |
| User Resource Profile Object. |
| |
| @return status |
| Returns a success/failure of the update. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteUserResourceProfile">Function: Airavata.deleteUserResourceProfile</h4> |
| <pre><code>bool</code> deleteUserResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete the given User Resource Profile. |
| |
| @param userId |
| The identifier for the requested user resource to be deleted. |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addUserComputeResourcePreference">Function: Airavata.addUserComputeResourcePreference</h4> |
| <pre><code>bool</code> addUserComputeResourcePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID, |
| <code>string</code> userComputeResourceId, |
| <code><a href="user_resource_profile_model.html#Struct_UserComputeResourcePreference">user_resource_profile_model.UserComputeResourcePreference</a></code> userComputeResourcePreference) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Add a Compute Resource Preference to a registered User profile. |
| |
| @param userId |
| The identifier for the User resource profile to be added. |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @param computeResourceId |
| Preferences related to a particular compute resource |
| |
| @param computeResourcePreference |
| The ComputeResourcePreference object to be added to the resource profile. |
| |
| @return status |
| Returns a success/failure of the addition. If a profile already exists, this operation will fail. |
| Instead an update should be used. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_addUserStoragePreference">Function: Airavata.addUserStoragePreference</h4> |
| <pre><code>bool</code> addUserStoragePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID, |
| <code>string</code> userStorageResourceId, |
| <code><a href="user_resource_profile_model.html#Struct_UserStoragePreference">user_resource_profile_model.UserStoragePreference</a></code> userStoragePreference) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Add a Storage Resource Preference to a registered user resource profile. |
| |
| @param userId |
| The identifier of the user resource profile to be added. |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @param storageResourceId |
| Preferences related to a particular compute resource |
| |
| @param computeResourcePreference |
| The ComputeResourcePreference object to be added to the resource profile. |
| |
| @return status |
| Returns a success/failure of the addition. If a profile already exists, this operation will fail. |
| Instead an update should be used. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getUserComputeResourcePreference">Function: Airavata.getUserComputeResourcePreference</h4> |
| <pre><code><a href="user_resource_profile_model.html#Struct_UserComputeResourcePreference">user_resource_profile_model.UserComputeResourcePreference</a></code> getUserComputeResourcePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID, |
| <code>string</code> userComputeResourceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch a Compute Resource Preference of a registered user resource profile. |
| |
| @param userId |
| The identifier for the user profile to be requested |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @param userComputeResourceId |
| Preferences related to a particular compute resource |
| |
| @return computeResourcePreference |
| Returns the ComputeResourcePreference object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getUserStoragePreference">Function: Airavata.getUserStoragePreference</h4> |
| <pre><code><a href="user_resource_profile_model.html#Struct_UserStoragePreference">user_resource_profile_model.UserStoragePreference</a></code> getUserStoragePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID, |
| <code>string</code> userStorageResourceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch a Storage Resource Preference of a registered user resource profile. |
| |
| @param userId |
| The identifier of the user resource profile to request to fetch the particular storage resource preference. |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @param userStorageResourceId |
| Identifier of the Stprage Preference required to be fetched. |
| |
| @return UserStoragePreference |
| Returns the StoragePreference object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllUserComputeResourcePreferences">Function: Airavata.getAllUserComputeResourcePreferences</h4> |
| <pre><code>list<<code><a href="user_resource_profile_model.html#Struct_UserComputeResourcePreference">user_resource_profile_model.UserComputeResourcePreference</a></code>></code> getAllUserComputeResourcePreferences(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch all Compute Resource Preferences of a registered gateway profile. |
| |
| @param userId |
| The identifier of the user resource profile to request to fetch the particular storage resource preference. |
| |
| @param gatewayID |
| The identifier for the gateway profile to be requested |
| |
| @return computeResourcePreference |
| Returns the ComputeResourcePreference object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllUserStoragePreferences">Function: Airavata.getAllUserStoragePreferences</h4> |
| <pre><code>list<<code><a href="user_resource_profile_model.html#Struct_UserStoragePreference">user_resource_profile_model.UserStoragePreference</a></code>></code> getAllUserStoragePreferences(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Fetch all User Storage Resource Preferences of a registered user profile. |
| |
| @param userId |
| The identifier of the user resource profile to request to fetch the particular storage resource preference. |
| |
| @param gatewayID |
| The identifier for the gateway profile to be requested |
| |
| @return StoragePreference |
| Returns the StoragePreference object. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getAllUserResourceProfiles">Function: Airavata.getAllUserResourceProfiles</h4> |
| <pre><code>list<<code><a href="user_resource_profile_model.html#Struct_UserResourceProfile">user_resource_profile_model.UserResourceProfile</a></code>></code> getAllUserResourceProfiles(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre> |
| Fetch all user resources Profiles registered |
| |
| @return UserResourceProfile |
| Returns all the UserResourcePrifle list object. |
| |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateUserComputeResourcePreference">Function: Airavata.updateUserComputeResourcePreference</h4> |
| <pre><code>bool</code> updateUserComputeResourcePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID, |
| <code>string</code> userComputeResourceId, |
| <code><a href="user_resource_profile_model.html#Struct_UserComputeResourcePreference">user_resource_profile_model.UserComputeResourcePreference</a></code> userComputeResourcePreference) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Update a Compute Resource Preference to a registered user resource profile. |
| |
| @param userId |
| The identifier for the user profile to be updated. |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @param userComputeResourceId |
| Preferences related to a particular compute resource |
| |
| @param userComputeResourcePreference |
| The ComputeResourcePreference object to be updated to the resource profile. |
| |
| @return status |
| Returns a success/failure of the updation. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_updateUserStoragePreference">Function: Airavata.updateUserStoragePreference</h4> |
| <pre><code>bool</code> updateUserStoragePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID, |
| <code>string</code> userStorageId, |
| <code><a href="user_resource_profile_model.html#Struct_UserStoragePreference">user_resource_profile_model.UserStoragePreference</a></code> userStoragePreference) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Update a Storage Resource Preference of a registered user resource profile. |
| |
| @param userId |
| The identifier of the user resource profile to be updated. |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @param userStorageId |
| The Storage resource identifier of the one that you want to update |
| |
| @param userStoragePreference |
| The storagePreference object to be updated to the resource profile. |
| |
| @return status |
| Returns a success/failure of the updation. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteUserComputeResourcePreference">Function: Airavata.deleteUserComputeResourcePreference</h4> |
| <pre><code>bool</code> deleteUserComputeResourcePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID, |
| <code>string</code> userComputeResourceId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete the Compute Resource Preference of a registered user resource profile. |
| |
| @param userId |
| The identifier for the user resource profile to be deleted. |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @param userComputeResourceId |
| Preferences related to a particular compute resource |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_deleteUserStoragePreference">Function: Airavata.deleteUserStoragePreference</h4> |
| <pre><code>bool</code> deleteUserStoragePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> userId, |
| <code>string</code> gatewayID, |
| <code>string</code> userStorageId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Delete the Storage Resource Preference of a registered user resource profile. |
| |
| @param userId |
| The identifier of the user profile to be deleted. |
| |
| @param gatewayID |
| The identifier to link a gateway for the requested user resource profile. |
| |
| @param userStorageId |
| ID of the storage preference you want to delete. |
| |
| @return status |
| Returns a success/failure of the deletion. |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getLatestQueueStatuses">Function: Airavata.getLatestQueueStatuses</h4> |
| <pre><code>list<<code><a href="status_models.html#Struct_QueueStatusModel">status_models.QueueStatusModel</a></code>></code> getLatestQueueStatuses(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_registerDataProduct">Function: Airavata.registerDataProduct</h4> |
| <pre><code>string</code> registerDataProduct(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="replica_catalog_models.html#Struct_DataProductModel">replica_catalog_models.DataProductModel</a></code> dataProductModel) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>API Methods related to replica catalog |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getDataProduct">Function: Airavata.getDataProduct</h4> |
| <pre><code><a href="replica_catalog_models.html#Struct_DataProductModel">replica_catalog_models.DataProductModel</a></code> getDataProduct(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> dataProductUri) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_registerReplicaLocation">Function: Airavata.registerReplicaLocation</h4> |
| <pre><code>string</code> registerReplicaLocation(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="replica_catalog_models.html#Struct_DataReplicaLocationModel">replica_catalog_models.DataReplicaLocationModel</a></code> replicaLocationModel) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getParentDataProduct">Function: Airavata.getParentDataProduct</h4> |
| <pre><code><a href="replica_catalog_models.html#Struct_DataProductModel">replica_catalog_models.DataProductModel</a></code> getParentDataProduct(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> productUri) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getChildDataProducts">Function: Airavata.getChildDataProducts</h4> |
| <pre><code>list<<code><a href="replica_catalog_models.html#Struct_DataProductModel">replica_catalog_models.DataProductModel</a></code>></code> getChildDataProducts(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> productUri) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_shareResourceWithUsers">Function: Airavata.shareResourceWithUsers</h4> |
| <pre><code>bool</code> shareResourceWithUsers(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceId, |
| <code>map<<code>string</code>, <code><a href="group_manager_model.html#Enum_ResourcePermissionType">group_manager_model.ResourcePermissionType</a></code>></code> userPermissionList) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>Group Manager and Data Sharing Related API methods |
| |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_shareResourceWithGroups">Function: Airavata.shareResourceWithGroups</h4> |
| <pre><code>bool</code> shareResourceWithGroups(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceId, |
| <code>map<<code>string</code>, <code><a href="group_manager_model.html#Enum_ResourcePermissionType">group_manager_model.ResourcePermissionType</a></code>></code> groupPermissionList) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_revokeSharingOfResourceFromUsers">Function: Airavata.revokeSharingOfResourceFromUsers</h4> |
| <pre><code>bool</code> revokeSharingOfResourceFromUsers(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceId, |
| <code>map<<code>string</code>, <code><a href="group_manager_model.html#Enum_ResourcePermissionType">group_manager_model.ResourcePermissionType</a></code>></code> userPermissionList) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_revokeSharingOfResourceFromGroups">Function: Airavata.revokeSharingOfResourceFromGroups</h4> |
| <pre><code>bool</code> revokeSharingOfResourceFromGroups(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceId, |
| <code>map<<code>string</code>, <code><a href="group_manager_model.html#Enum_ResourcePermissionType">group_manager_model.ResourcePermissionType</a></code>></code> groupPermissionList) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getAllAccessibleUsers">Function: Airavata.getAllAccessibleUsers</h4> |
| <pre><code>list<<code>string</code>></code> getAllAccessibleUsers(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceId, |
| <code><a href="group_manager_model.html#Enum_ResourcePermissionType">group_manager_model.ResourcePermissionType</a></code> permissionType) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getAllAccessibleGroups">Function: Airavata.getAllAccessibleGroups</h4> |
| <pre><code>list<<code>string</code>></code> getAllAccessibleGroups(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceId, |
| <code><a href="group_manager_model.html#Enum_ResourcePermissionType">group_manager_model.ResourcePermissionType</a></code> permissionType) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getAllDirectlyAccessibleUsers">Function: Airavata.getAllDirectlyAccessibleUsers</h4> |
| <pre><code>list<<code>string</code>></code> getAllDirectlyAccessibleUsers(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceId, |
| <code><a href="group_manager_model.html#Enum_ResourcePermissionType">group_manager_model.ResourcePermissionType</a></code> permissionType) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getAllDirectlyAccessibleGroups">Function: Airavata.getAllDirectlyAccessibleGroups</h4> |
| <pre><code>list<<code>string</code>></code> getAllDirectlyAccessibleGroups(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceId, |
| <code><a href="group_manager_model.html#Enum_ResourcePermissionType">group_manager_model.ResourcePermissionType</a></code> permissionType) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_userHasAccess">Function: Airavata.userHasAccess</h4> |
| <pre><code>bool</code> userHasAccess(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourceId, |
| <code><a href="group_manager_model.html#Enum_ResourcePermissionType">group_manager_model.ResourcePermissionType</a></code> permissionType) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_createGroupResourceProfile">Function: Airavata.createGroupResourceProfile</h4> |
| <pre><code>string</code> createGroupResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="group_resource_profile_model.html#Struct_GroupResourceProfile">group_resource_profile_model.GroupResourceProfile</a></code> groupResourceProfile) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_updateGroupResourceProfile">Function: Airavata.updateGroupResourceProfile</h4> |
| <pre><code>void</code> updateGroupResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="group_resource_profile_model.html#Struct_GroupResourceProfile">group_resource_profile_model.GroupResourceProfile</a></code> groupResourceProfile) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getGroupResourceProfile">Function: Airavata.getGroupResourceProfile</h4> |
| <pre><code><a href="group_resource_profile_model.html#Struct_GroupResourceProfile">group_resource_profile_model.GroupResourceProfile</a></code> getGroupResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> groupResourceProfileId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_removeGroupResourceProfile">Function: Airavata.removeGroupResourceProfile</h4> |
| <pre><code>bool</code> removeGroupResourceProfile(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> groupResourceProfileId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getGroupResourceList">Function: Airavata.getGroupResourceList</h4> |
| <pre><code>list<<code><a href="group_resource_profile_model.html#Struct_GroupResourceProfile">group_resource_profile_model.GroupResourceProfile</a></code>></code> getGroupResourceList(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_removeGroupComputePrefs">Function: Airavata.removeGroupComputePrefs</h4> |
| <pre><code>bool</code> removeGroupComputePrefs(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>string</code> groupResourceProfileId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_removeGroupComputeResourcePolicy">Function: Airavata.removeGroupComputeResourcePolicy</h4> |
| <pre><code>bool</code> removeGroupComputeResourcePolicy(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourcePolicyId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_removeGroupBatchQueueResourcePolicy">Function: Airavata.removeGroupBatchQueueResourcePolicy</h4> |
| <pre><code>bool</code> removeGroupBatchQueueResourcePolicy(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourcePolicyId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getGroupComputeResourcePreference">Function: Airavata.getGroupComputeResourcePreference</h4> |
| <pre><code><a href="group_resource_profile_model.html#Struct_GroupComputeResourcePreference">group_resource_profile_model.GroupComputeResourcePreference</a></code> getGroupComputeResourcePreference(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> computeResourceId, |
| <code>string</code> groupResourceProfileId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getGroupComputeResourcePolicy">Function: Airavata.getGroupComputeResourcePolicy</h4> |
| <pre><code><a href="group_resource_profile_model.html#Struct_ComputeResourcePolicy">group_resource_profile_model.ComputeResourcePolicy</a></code> getGroupComputeResourcePolicy(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourcePolicyId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getBatchQueueResourcePolicy">Function: Airavata.getBatchQueueResourcePolicy</h4> |
| <pre><code><a href="group_resource_profile_model.html#Struct_BatchQueueResourcePolicy">group_resource_profile_model.BatchQueueResourcePolicy</a></code> getBatchQueueResourcePolicy(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> resourcePolicyId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getGroupComputeResourcePrefList">Function: Airavata.getGroupComputeResourcePrefList</h4> |
| <pre><code>list<<code><a href="group_resource_profile_model.html#Struct_GroupComputeResourcePreference">group_resource_profile_model.GroupComputeResourcePreference</a></code>></code> getGroupComputeResourcePrefList(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> groupResourceProfileId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getGroupBatchQueueResourcePolicyList">Function: Airavata.getGroupBatchQueueResourcePolicyList</h4> |
| <pre><code>list<<code><a href="group_resource_profile_model.html#Struct_BatchQueueResourcePolicy">group_resource_profile_model.BatchQueueResourcePolicy</a></code>></code> getGroupBatchQueueResourcePolicyList(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> groupResourceProfileId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getGroupComputeResourcePolicyList">Function: Airavata.getGroupComputeResourcePolicyList</h4> |
| <pre><code>list<<code><a href="group_resource_profile_model.html#Struct_ComputeResourcePolicy">group_resource_profile_model.ComputeResourcePolicy</a></code>></code> getGroupComputeResourcePolicyList(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> groupResourceProfileId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getGatewayGroups">Function: Airavata.getGatewayGroups</h4> |
| <pre><code><a href="gateway_groups_model.html#Struct_GatewayGroups">gateway_groups_model.GatewayGroups</a></code> getGatewayGroups(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre><pre>GatewayGroups API methods |
| </pre><br/></div><div class="definition"><h4 id="Fn_Airavata_getParser">Function: Airavata.getParser</h4> |
| <pre><code><a href="parser_model.html#Struct_Parser">parser_model.Parser</a></code> getParser(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> parserId, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_saveParser">Function: Airavata.saveParser</h4> |
| <pre><code>string</code> saveParser(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="parser_model.html#Struct_Parser">parser_model.Parser</a></code> parser) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_listAllParsers">Function: Airavata.listAllParsers</h4> |
| <pre><code>list<<code><a href="parser_model.html#Struct_Parser">parser_model.Parser</a></code>></code> listAllParsers(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_removeParser">Function: Airavata.removeParser</h4> |
| <pre><code>bool</code> removeParser(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> parserId, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getParsingTemplate">Function: Airavata.getParsingTemplate</h4> |
| <pre><code><a href="parser_model.html#Struct_ParsingTemplate">parser_model.ParsingTemplate</a></code> getParsingTemplate(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> templateId, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_getParsingTemplatesForExperiment">Function: Airavata.getParsingTemplatesForExperiment</h4> |
| <pre><code>list<<code><a href="parser_model.html#Struct_ParsingTemplate">parser_model.ParsingTemplate</a></code>></code> getParsingTemplatesForExperiment(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> experimentId, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_saveParsingTemplate">Function: Airavata.saveParsingTemplate</h4> |
| <pre><code>string</code> saveParsingTemplate(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code><a href="parser_model.html#Struct_ParsingTemplate">parser_model.ParsingTemplate</a></code> parsingTemplate) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_removeParsingTemplate">Function: Airavata.removeParsingTemplate</h4> |
| <pre><code>bool</code> removeParsingTemplate(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> templateId, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div><div class="definition"><h4 id="Fn_Airavata_listAllParsingTemplates">Function: Airavata.listAllParsingTemplates</h4> |
| <pre><code>list<<code><a href="parser_model.html#Struct_ParsingTemplate">parser_model.ParsingTemplate</a></code>></code> listAllParsingTemplates(<code><a href="security_model.html#Struct_AuthzToken">security_model.AuthzToken</a></code> authzToken, |
| <code>string</code> gatewayId) |
| throws <code><a href="airavata_errors.html#Struct_InvalidRequestException">airavata_errors.InvalidRequestException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataClientException">airavata_errors.AiravataClientException</a></code>, <code><a href="airavata_errors.html#Struct_AiravataSystemException">airavata_errors.AiravataSystemException</a></code>, <code><a href="airavata_errors.html#Struct_AuthorizationException">airavata_errors.AuthorizationException</a></code> |
| </pre></div></div></body></html> |
