You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by ch...@apache.org on 2016/02/08 17:43:04 UTC
[04/10] airavata git commit: update generated code and fixing
compilation issues
http://git-wip-us.apache.org/repos/asf/airavata/blob/4c790770/airavata-api/airavata-client-sdks/airavata-python-sdk/src/main/resources/lib/apache/airavata/api/Airavata.py
----------------------------------------------------------------------
diff --git a/airavata-api/airavata-client-sdks/airavata-python-sdk/src/main/resources/lib/apache/airavata/api/Airavata.py b/airavata-api/airavata-client-sdks/airavata-python-sdk/src/main/resources/lib/apache/airavata/api/Airavata.py
index de97d8f..cb51ff6 100644
--- a/airavata-api/airavata-client-sdks/airavata-python-sdk/src/main/resources/lib/apache/airavata/api/Airavata.py
+++ b/airavata-api/airavata-client-sdks/airavata-python-sdk/src/main/resources/lib/apache/airavata/api/Airavata.py
@@ -182,6 +182,7 @@ class Iface:
def getAllUserSSHPubKeys(self, authzToken, userName):
"""
+
Get a Public Key by Providing the Token
@param CredStoreToken
@@ -202,6 +203,7 @@ class Iface:
def getAllGatewaySSHPubKeys(self, authzToken, gatewayId):
"""
+
Get all Public Keys of the Gateway
@param CredStoreToken
@@ -222,6 +224,7 @@ class Iface:
def deleteSSHPubKey(self, authzToken, airavataCredStoreToken, gatewayId):
"""
+
Delete a Gateway
@param gatewayId
@@ -241,6 +244,7 @@ class Iface:
def createProject(self, authzToken, gatewayId, project):
"""
+
Creates a Project with basic metadata.
A Project is a container of experiments.
@@ -248,7 +252,7 @@ class Iface:
The identifier for the requested gateway.
@param Project
- The Project Object described in the workspace_model
+ The Project Object described in the workspace_model.
@@ -261,6 +265,7 @@ class Iface:
def updateProject(self, authzToken, projectId, updatedProject):
"""
+
Update an Existing Project
@param projectId
@@ -280,14 +285,15 @@ class Iface:
def getProject(self, authzToken, projectId):
"""
+
Get a Project by ID
- This method is to obtain a project by providing a projectId
+ This method is to obtain a project by providing a projectId.
@param projectId
- projectId of the project you require
+ projectId of the project you require.
@return project
- project data model will be returned
+ project data model will be returned.
@@ -299,15 +305,18 @@ class Iface:
def deleteProject(self, authzToken, projectId):
"""
+
Delete a Project
- This method is used to delete an existing Project
+ This method is used to delete an existing Project.
@param projectId
- projectId of the project you want to delete
+ 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.
+
Parameters:
@@ -318,20 +327,21 @@ class Iface:
def getUserProjects(self, authzToken, gatewayId, userName, limit, offset):
"""
- Get all Project by user with pagination. Results will be ordered based
- on creation time DESC
+
+ 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
+ The identifier of the user.
@param limit
- The amount results to be fetched
+ The amount results to be fetched.
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
@@ -346,19 +356,25 @@ class Iface:
def searchProjectsByProjectName(self, authzToken, gatewayId, userName, projectName, limit, offset):
"""
- Get all Project for user by project name with pagination.Results will be ordered based
- on creation time DESC
+
+ Search User Projects by Project Name
+ Get all Project for user by project name with pagination.Results will be ordered based on creation time DESC.
@param gatewayId
- The identifier for the requested gateway.
+ The unique identifier for the requested gateway.
+
@param userName
- The identifier of the user
+ The identifier of the user.
+
@param projectName
- The name of the project on which the results to be fetched
+ The name of the project on which the results to be fetched.
+
@param limit
- The amount results to be fetched
+ The amount results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -373,19 +389,25 @@ class Iface:
def searchProjectsByProjectDesc(self, authzToken, gatewayId, userName, description, limit, offset):
"""
- Search and get all Projects for user by project description with pagination. Results
- will be ordered based on creation time DESC
+
+ Search User Projects by Project Description
+ Search and get all Projects for user by project description with pagination. Results will be ordered based on creation time DESC.
@param gatewayId
- The identifier for the requested gateway.
+ The unique identifier of the gateway making the request.
+
@param userName
- The identifier of the user
+ The identifier of the user.
+
@param description
- The description to be matched
+ The description to be matched.
+
@param limit
- The amount results to be fetched
+ The amount results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -400,19 +422,25 @@ class Iface:
def searchExperimentsByName(self, authzToken, gatewayId, userName, expName, limit, offset):
"""
- Search Experiments by experiment name with pagination. Results will be sorted
- based on creation time DESC
+
+ Search User Experiments by Name
+ Search user Experiments using experiment name with pagination. Results will be sorted based on creation time DESC.
@param gatewayId
- Identifier of the requested gateway
+ Unique identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the user who created the experiments.
+
@param expName
- Experiment name to be matched
+ Experiment name to be matched.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -427,19 +455,25 @@ class Iface:
def searchExperimentsByDesc(self, authzToken, gatewayId, userName, description, limit, offset):
"""
- Search Experiments by experiment name with pagination. Results will be sorted
- based on creation time DESC
+
+ Search By Experiment Description
+ Search Experiments by experiment description with pagination. Results will be sorted based on creation time DESC.
@param gatewayId
- Identifier of the requested gateway
+ Unique identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the requested user.
+
@param description
- Experiment description to be matched
+ Experiment description to be matched.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -454,19 +488,25 @@ class Iface:
def searchExperimentsByApplication(self, authzToken, gatewayId, userName, applicationId, limit, offset):
"""
- Search Experiments by application id with pagination. Results will be sorted
- based on creation time DESC
+
+ Search Experiment By the Application
+ Search Experiments of a particular application id with pagination. Results will be sorted based on creation time DESC
@param gatewayId
- Identifier of the requested gateway
+ Unique identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the requested user.
+
@param applicationId
- Application id to be matched
+ Application id to be matched.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -481,19 +521,25 @@ class Iface:
def searchExperimentsByStatus(self, authzToken, gatewayId, userName, experimentState, limit, offset):
"""
- Search Experiments by experiment status with pagination. Results will be sorted
- based on creation time DESC
+
+ Search User Experiments by Status
+ Search all the Experiments of the given user by experiment status with pagination. Results will be sorted based on creation time DESC
@param gatewayId
- Identifier of the requested gateway
+ Unique identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the user making the request.
+
@param experimentState
- Experiement state to be matched
+ Experiement state to be matched.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -508,21 +554,31 @@ class Iface:
def searchExperimentsByCreationTime(self, authzToken, gatewayId, userName, fromTime, toTime, limit, offset):
"""
- Search Experiments by experiment creation time with pagination. Results will be sorted
- based on creation time DESC
+
+ Search User Experiments by the Creation Time
+ This will search all the experiments of the given user by experiment creation time with pagination. Results will be sorted based on creation time DESC.
@param gatewayId
- Identifier of the requested gateway
+ Unique identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the requested user.
+
@param fromTime
- Start time of the experiments creation time
+ Start time of the experiments creation time.
+
@param toTime
- End time of the experiement creation time
+ End time of the experiement creation time.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ 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.
+
Parameters:
@@ -538,19 +594,27 @@ class Iface:
def searchExperiments(self, authzToken, gatewayId, userName, filters, limit, offset):
"""
- Search Experiments by using multiple filter criteria with pagination. Results will be sorted
- based on creation time DESC
+ 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
+ Identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the user requesting the search function.
+
@param filters
- map of multiple filter criteria.
+ Map of multiple filter criteria. Currenlt search filters includes Experiment Name, Description, Application, etc....
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ 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.
+
Parameters:
@@ -565,13 +629,19 @@ class Iface:
def getExperimentStatistics(self, authzToken, gatewayId, fromTime, toTime):
"""
- Get Experiment Statisitics for the given gateway for a specific time period
+
+ 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
- Identifier of the requested gateway
+ Unique identifier of the gateway making the request to fetch statistics.
+
@param fromTime
- Starting date time
+ Starting date time.
+
@param toTime
- Ending data time
+ Ending data time.
+
Parameters:
@@ -584,15 +654,19 @@ class Iface:
def getExperimentsInProject(self, authzToken, projectId, limit, offset):
"""
- Get Experiments within project with pagination. Results will be sorted
- based on creation time DESC
+
+ Get All Experiments of the Project
+ Get Experiments within project with pagination. Results will be sorted based on creation time DESC.
@param projectId
- Identifier of the project
+ Uniqie identifier of the project.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -605,17 +679,22 @@ class Iface:
def getUserExperiments(self, authzToken, gatewayId, userName, limit, offset):
"""
- Get experiments by user with pagination. Results will be sorted
- based on creation time DESC
+
+ 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
+ Identifier of the requesting gateway.
+
@param userName
- Username of the requested user
+ Username of the requested end user.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -629,12 +708,17 @@ class Iface:
def createExperiment(self, authzToken, gatewayId, experiment):
"""
+ *
+ * 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 basicExperimentMetadata
+ * @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.
@@ -673,8 +757,8 @@ class Iface:
def deleteExperiment(self, authzToken, experimentId):
"""
- Delete an Experiment
+ Delete an Experiment
If the experiment is not already launched experiment can be deleted.
@param authzToken
@@ -683,7 +767,7 @@ class Iface:
Experiment ID of the experimnet you want to delete.
@return boolean
- Identifier for the success or failure of the deletion operation
+ Identifier for the success or failure of the deletion operation.
@@ -695,12 +779,14 @@ class Iface:
def getExperiment(self, authzToken, airavataExperimentId):
"""
+ *
+ * Get Experiment
* Fetch previously created experiment metadata.
*
* @param airavataExperimentId
- * The identifier for the requested experiment. This is returned during the create experiment step.
+ * The unique identifier of the requested experiment. This ID is returned during the create experiment step.
*
- * @return experimentMetada
+ * @return ExperimentModel
* This method will return the previously stored experiment metadata.
*
* @throws org.apache.airavata.model.error.InvalidRequestException
@@ -736,14 +822,17 @@ class Iface:
def getDetailedExperimentTree(self, authzToken, airavataExperimentId):
"""
+
+ 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 experimentMetada
- This method will return the previously stored experiment metadata.
+ @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.
@@ -777,14 +866,15 @@ class Iface:
def updateExperiment(self, authzToken, airavataExperimentId, experiment):
"""
- Configure a previously 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.
+
+ 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 experimentConfigurationData
+ @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.
@@ -843,13 +933,14 @@ class Iface:
def validateExperiment(self, authzToken, airavataExperimentId):
"""
*
- * Validate experiment configuration. A true in general indicates, the experiment is ready to be launched.
- *
- * @param experimentId
+ * 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
+ * Identifier for the success or failure of the validation operation.
*
*
@@ -861,8 +952,12 @@ class Iface:
def launchExperiment(self, authzToken, airavataExperimentId, gatewayId):
"""
- Launch a previously created and 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.
+
+ 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.
@@ -903,17 +998,18 @@ class Iface:
def getExperimentStatus(self, authzToken, airavataExperimentId):
"""
+
Get Experiment Status
- Obtain the status os an experiment by providing the Experiment Id
+ Obtain the status of an experiment by providing the Experiment Id
@param authzToken
- @param experiementId
- Experiment ID of the experimnet you require the status
+ @param airavataExperimentId
+ Experiment ID of the experimnet you require the status.
@return ExperimentStatus
- ExperimentStatus model with current status will be returned.
+ ExperimentStatus model with the current status will be returned.
@@ -925,16 +1021,17 @@ class Iface:
def getExperimentOutputs(self, authzToken, airavataExperimentId):
"""
+
Get Experiment Outputs
- This method to be used when need to obtain outputs of a certain Experiment
+ This method to be used when need to obtain final outputs of a certain Experiment
@param authzToken
- @param experiementId
- Experiment ID of the experimnet you need the outputs
+ @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
+ List of experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment.
@@ -946,16 +1043,17 @@ class Iface:
def getIntermediateOutputs(self, authzToken, airavataExperimentId):
"""
+
Get Intermediate Experiment Outputs
This method to be used when need to obtain intermediate outputs of a certain Experiment
@param authzToken
- @param experiementId
- Experiment ID of the experimnet you need the intermediate outputs
+ @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
+ List of intermediate experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment.
@@ -967,13 +1065,14 @@ class Iface:
def getJobStatuses(self, authzToken, airavataExperimentId):
"""
- Get Job Status for an Experiment
+
+ 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 intermediate outputs
+ 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
@@ -988,16 +1087,17 @@ class Iface:
def getJobDetails(self, authzToken, airavataExperimentId):
"""
- Get Job Details for all the jobs within an Experiment
+
+ 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
+ Experiment ID of the experimnet you need job details.
@return list of JobDetails
- Job details
+ Job details.
@@ -1009,7 +1109,9 @@ class Iface:
def cloneExperiment(self, authzToken, existingExperimentID, newExperimentName):
"""
- Clone an specified experiment with a new name. A copy of the experiment configuration is made and is persisted with new metadata.
+
+ 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
@@ -1021,7 +1123,7 @@ class Iface:
should be shared public by default.
@return
- The server-side generated.airavata.registry.core.experiment.globally unique identifier for the newly cloned experiment.
+ 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.
@@ -1056,12 +1158,16 @@ class Iface:
def terminateExperiment(self, authzToken, airavataExperimentId, gatewayId):
"""
- Terminate a running experiment.
+
+ Terminate a running Experiment.
+
+ @gatewayId
+ ID of the gateway which will terminate the running Experiment.
@param airavataExperimentId
- The identifier for the requested experiment. This is returned during the create experiment step.
+ The identifier of the experiment required termination. This ID is returned during the create experiment step.
- @return
+ @return status
This method call does not have a return value.
@throws org.apache.airavata.model.error.InvalidRequestException
@@ -1097,13 +1203,17 @@ class Iface:
def registerApplicationModule(self, authzToken, gatewayId, applicationModule):
"""
+
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 a server-side generated airavata appModule globally unique identifier.
+ Returns the server-side generated airavata appModule globally unique identifier.
Parameters:
@@ -1115,13 +1225,14 @@ class Iface:
def getApplicationModule(self, authzToken, appModuleId):
"""
+
Fetch a Application Module.
@param appModuleId
- The identifier for the requested application module
+ The unique identifier of the application module required
@return applicationModule
- Returns a application Module Object.
+ Returns an Application Module Object.
Parameters:
@@ -1132,6 +1243,7 @@ class Iface:
def updateApplicationModule(self, authzToken, appModuleId, applicationModule):
"""
+
Update a Application Module.
@param appModuleId
@@ -1153,6 +1265,16 @@ class Iface:
def getAllAppModules(self, authzToken, gatewayId):
"""
+
+ 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.
+
+
Parameters:
- authzToken
- gatewayId
@@ -1161,10 +1283,11 @@ class Iface:
def deleteApplicationModule(self, authzToken, appModuleId):
"""
- Delete a Application Module.
+
+ Delete an Application Module.
@param appModuleId
- The identifier for the requested application module to be deleted.
+ The identifier of the Application Module to be deleted.
@return status
Returns a success/failure of the deletion.
@@ -1178,9 +1301,13 @@ class Iface:
def registerApplicationDeployment(self, authzToken, gatewayId, applicationDeployment):
"""
- Register a Application Deployment.
- @param applicationModule
+ 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
@@ -1196,6 +1323,7 @@ class Iface:
def getApplicationDeployment(self, authzToken, appDeploymentId):
"""
+
Fetch a Application Deployment.
@param appDeploymentId
@@ -1213,10 +1341,11 @@ class Iface:
def updateApplicationDeployment(self, authzToken, appDeploymentId, applicationDeployment):
"""
- Update a Application Deployment.
+
+ Update an Application Deployment.
@param appDeploymentId
- The identifier for the requested application deployment to be updated.
+ The identifier of the requested application deployment to be updated.
@param appDeployment
Application Deployment Object created from the datamodel.
@@ -1234,10 +1363,11 @@ class Iface:
def deleteApplicationDeployment(self, authzToken, appDeploymentId):
"""
- Delete a Application deployment.
+
+ Delete an Application Deployment.
@param appDeploymentId
- The identifier for the requested application deployment to be deleted.
+ The unique identifier of application deployment to be deleted.
@return status
Returns a success/failure of the deletion.
@@ -1251,10 +1381,14 @@ class Iface:
def getAllApplicationDeployments(self, authzToken, gatewayId):
"""
+
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.
+ Returns the list of all application Deployment Objects.
Parameters:
@@ -1282,9 +1416,10 @@ class Iface:
def registerApplicationInterface(self, authzToken, gatewayId, applicationInterface):
"""
+
Register a Application Interface.
- @param applicationModule
+ @param applicationInterface
Application Module Object created from the datamodel.
@return appInterfaceId
@@ -1300,6 +1435,22 @@ class Iface:
def cloneApplicationInterface(self, authzToken, existingAppInterfaceID, newApplicationName, gatewayId):
"""
+
+ 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.
+
+
Parameters:
- authzToken
- existingAppInterfaceID
@@ -1310,14 +1461,14 @@ class Iface:
def getApplicationInterface(self, authzToken, appInterfaceId):
"""
- Fetch a Application Interface.
+
+ Fetch an Application Interface.
@param appInterfaceId
- The identifier for the requested application module
+ The identifier for the requested application interface.
@return applicationInterface
- Returns a application Interface Object.
-
+ Returns an application Interface Object.
Parameters:
@@ -1328,10 +1479,11 @@ class Iface:
def updateApplicationInterface(self, authzToken, appInterfaceId, applicationInterface):
"""
+
Update a Application Interface.
@param appInterfaceId
- The identifier for the requested application deployment to be updated.
+ The identifier of the requested application deployment to be updated.
@param appInterface
Application Interface Object created from the datamodel.
@@ -1340,7 +1492,6 @@ class Iface:
Returns a success/failure of the update.
-
Parameters:
- authzToken
- appInterfaceId
@@ -1350,7 +1501,8 @@ class Iface:
def deleteApplicationInterface(self, authzToken, appInterfaceId):
"""
- Delete a Application Interface.
+
+ Delete an Application Interface.
@param appInterfaceId
The identifier for the requested application interface to be deleted.
@@ -1359,7 +1511,6 @@ class Iface:
Returns a success/failure of the deletion.
-
Parameters:
- authzToken
- appInterfaceId
@@ -1368,11 +1519,12 @@ class Iface:
def getAllApplicationInterfaceNames(self, authzToken, gatewayId):
"""
- Fetch name and id of Application Interface documents.
+
+ Fetch name and ID of Application Interface documents.
@return map<applicationId, applicationInterfaceNames>
- Returns a list of application interfaces with corresponsing id's
+ Returns a list of application interfaces with corresponsing ID's
Parameters:
@@ -1383,11 +1535,12 @@ class Iface:
def getAllApplicationInterfaces(self, authzToken, gatewayId):
"""
+
Fetch all Application Interface documents.
@return map<applicationId, applicationInterfaceNames>
- Returns a list of application interfaces documents
+ Returns a list of application interfaces documents (Application Interface ID, name, description, Inputs and Outputs objects).
Parameters:
@@ -1398,10 +1551,11 @@ class Iface:
def getApplicationInputs(self, authzToken, appInterfaceId):
"""
+
Fetch the list of Application Inputs.
@param appInterfaceId
- The identifier for the requested application interface
+ The identifier of the application interface which need inputs to be fetched.
@return list<application_interface_model.InputDataObjectType>
Returns a list of application inputs.
@@ -1415,10 +1569,11 @@ class Iface:
def getApplicationOutputs(self, authzToken, appInterfaceId):
"""
- Fetch the list of Application Outputs.
+
+ Fetch list of Application Outputs.
@param appInterfaceId
- The identifier for the requested application interface
+ The identifier of the application interface which need outputs to be fetched.
@return list<application_interface_model.OutputDataObjectType>
Returns a list of application outputs.
@@ -1432,14 +1587,15 @@ class Iface:
def getAvailableAppInterfaceComputeResources(self, authzToken, appInterfaceId):
"""
+
Fetch a list of all deployed Compute Hosts for a given application interfaces.
@param appInterfaceId
- The identifier for the requested application interface
+ 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.
+ Deployments of each modules listed within the interfaces will be listed.
Parameters:
@@ -1484,6 +1640,7 @@ class Iface:
def getAllComputeResourceNames(self, authzToken):
"""
+
Fetch all registered Compute Resources.
@return A map of registered compute resource id's and thier corresponding hostnames.
@@ -1582,7 +1739,7 @@ class Iface:
def updateStorageResource(self, authzToken, storageResourceId, storageResourceDescription):
"""
- Update a Compute Resource.
+ Update a Storage Resource.
@param storageResourceId
The identifier for the requested compute resource to be updated.
@@ -1606,7 +1763,7 @@ class Iface:
Delete a Storage Resource.
@param storageResourceId
- The identifier for the requested compute resource to be deleted.
+ The identifier of the requested compute resource to be deleted.
@return status
Returns a success/failure of the deletion.
@@ -1747,6 +1904,7 @@ class Iface:
def addUNICOREJobSubmissionDetails(self, authzToken, computeResourceId, priorityOrder, unicoreJobSubmission):
"""
+
Add a UNICORE Job Submission details to a compute resource
App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
@@ -1773,10 +1931,13 @@ class Iface:
def getUnicoreJobSubmission(self, authzToken, jobSubmissionId):
"""
+ *
* This method returns UnicoreJobSubmission object
+ *
* @param jobSubmissionInterfaceId
* The identifier of the JobSubmission Interface to be retrieved.
* @return UnicoreJobSubmission instance
+ *
*
Parameters:
@@ -1787,6 +1948,7 @@ class Iface:
def addCloudJobSubmissionDetails(self, authzToken, computeResourceId, priorityOrder, cloudSubmission):
"""
+ *
* Add a Cloud Job Submission details to a compute resource
* App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
*
@@ -1801,6 +1963,7 @@ class Iface:
*
* @return status
* Returns the unique job submission id.
+ *
*
Parameters:
@@ -1813,6 +1976,7 @@ class Iface:
def getCloudJobSubmission(self, authzToken, jobSubmissionId):
"""
+ *
* This method returns cloudJobSubmission object
* @param jobSubmissionInterfaceI
* The identifier of the JobSubmission Interface to be retrieved.
@@ -1827,6 +1991,7 @@ class Iface:
def updateSSHJobSubmissionDetails(self, authzToken, jobSubmissionInterfaceId, sshJobSubmission):
"""
+
Update the given SSH Job Submission details
@param jobSubmissionInterfaceId
@@ -1848,6 +2013,7 @@ class Iface:
def updateCloudJobSubmissionDetails(self, authzToken, jobSubmissionInterfaceId, sshJobSubmission):
"""
+
Update the cloud Job Submission details
@param jobSubmissionInterfaceId
@@ -1869,6 +2035,7 @@ class Iface:
def updateUnicoreJobSubmissionDetails(self, authzToken, jobSubmissionInterfaceId, unicoreJobSubmission):
"""
+
Update the UNIOCRE Job Submission details
@param jobSubmissionInterfaceId
@@ -1891,6 +2058,7 @@ class Iface:
def addLocalDataMovementDetails(self, authzToken, resourceId, dataMoveType, priorityOrder, localDataMovement):
"""
+
Add a Local data movement details to a compute resource
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -1922,6 +2090,7 @@ class Iface:
def updateLocalDataMovementDetails(self, authzToken, dataMovementInterfaceId, localDataMovement):
"""
+
Update the given Local data movement details
@param dataMovementInterfaceId
@@ -1944,7 +2113,8 @@ class Iface:
def getLocalDataMovement(self, authzToken, dataMovementId):
"""
- This method returns local datamovement object
+
+ This method returns local datamovement object.
@param dataMovementId
The identifier of the datamovement Interface to be retrieved.
@@ -1961,6 +2131,7 @@ class Iface:
def addSCPDataMovementDetails(self, authzToken, resourceId, dataMoveType, priorityOrder, scpDataMovement):
"""
+
Add a SCP data movement details to a compute resource
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -1988,6 +2159,7 @@ class Iface:
def updateSCPDataMovementDetails(self, authzToken, dataMovementInterfaceId, scpDataMovement):
"""
+
Update the given scp data movement details
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -2027,6 +2199,7 @@ class Iface:
def addUnicoreDataMovementDetails(self, authzToken, resourceId, dataMoveType, priorityOrder, unicoreDataMovement):
"""
+
Add a UNICORE data movement details to a compute resource
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -2054,6 +2227,7 @@ class Iface:
def updateUnicoreDataMovementDetails(self, authzToken, dataMovementInterfaceId, unicoreDataMovement):
"""
+
Update a selected UNICORE data movement details
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -2077,6 +2251,7 @@ class Iface:
def getUnicoreDataMovement(self, authzToken, dataMovementId):
"""
+
This method returns UNICORE datamovement object
@param dataMovementId
@@ -2094,6 +2269,7 @@ class Iface:
def addGridFTPDataMovementDetails(self, authzToken, resourceId, dataMoveType, priorityOrder, gridFTPDataMovement):
"""
+
Add a GridFTP data movement details to a compute resource
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -2359,7 +2535,7 @@ class Iface:
Fetch the given Gateway Resource Profile.
@param gatewayID
- The identifier for the requested gateway resource
+ The identifier for the requested gateway resource.
@return gatewayResourceProfile
Gateway Resource Profile Object.
@@ -2437,6 +2613,22 @@ class Iface:
def addGatewayStoragePreference(self, authzToken, gatewayID, storageResourceId, storagePreference):
"""
+ 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.
+
+
Parameters:
- authzToken
- gatewayID
@@ -2447,6 +2639,7 @@ class Iface:
def getGatewayComputeResourcePreference(self, authzToken, gatewayID, computeResourceId):
"""
+
Fetch a Compute Resource Preference of a registered gateway profile.
@param gatewayID
@@ -2468,6 +2661,19 @@ class Iface:
def getGatewayStoragePreference(self, authzToken, gatewayID, storageResourceId):
"""
+
+ 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.
+
+
Parameters:
- authzToken
- gatewayID
@@ -2477,6 +2683,7 @@ class Iface:
def getAllGatewayComputeResourcePreferences(self, authzToken, gatewayID):
"""
+
Fetch all Compute Resource Preferences of a registered gateway profile.
@param gatewayID
@@ -2494,6 +2701,15 @@ class Iface:
def getAllGatewayStoragePreferences(self, authzToken, gatewayID):
"""
+ 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.
+
+
Parameters:
- authzToken
- gatewayID
@@ -2502,7 +2718,12 @@ class Iface:
def getAllGatewayResourceProfiles(self, authzToken):
"""
- Fetch all gateway profiles registered
+
+ Fetch all Gateway Profiles registered
+
+ @return GatewayResourceProfile
+ Returns all the GatewayResourcePrifle list object.
+
Parameters:
@@ -2537,6 +2758,21 @@ class Iface:
def updateGatewayStoragePreference(self, authzToken, gatewayID, storageId, storagePreference):
"""
+ 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.
+
+
Parameters:
- authzToken
- gatewayID
@@ -2568,6 +2804,18 @@ class Iface:
def deleteGatewayStoragePreference(self, authzToken, gatewayID, storageId):
"""
+ 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.
+
+
Parameters:
- authzToken
- gatewayID
@@ -2577,6 +2825,18 @@ class Iface:
def getAllWorkflows(self, authzToken, gatewayId):
"""
+ 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.
+
+
Parameters:
- authzToken
- gatewayId
@@ -2585,6 +2845,10 @@ class Iface:
def getWorkflow(self, authzToken, workflowTemplateId):
"""
+
+ API Methods Related for Work-Flow Submission Features.
+
+
Parameters:
- authzToken
- workflowTemplateId
@@ -2635,7 +2899,9 @@ class Iface:
def registerDataResource(self, authzToken, dataResourceModel):
"""
- * Data Manager Related API Methods
+ *
+ * Data Manager Related API Methods.
+ *
*
Parameters:
@@ -3152,6 +3418,7 @@ class Client(Iface):
def getAllUserSSHPubKeys(self, authzToken, userName):
"""
+
Get a Public Key by Providing the Token
@param CredStoreToken
@@ -3203,6 +3470,7 @@ class Client(Iface):
def getAllGatewaySSHPubKeys(self, authzToken, gatewayId):
"""
+
Get all Public Keys of the Gateway
@param CredStoreToken
@@ -3254,6 +3522,7 @@ class Client(Iface):
def deleteSSHPubKey(self, authzToken, airavataCredStoreToken, gatewayId):
"""
+
Delete a Gateway
@param gatewayId
@@ -3305,6 +3574,7 @@ class Client(Iface):
def createProject(self, authzToken, gatewayId, project):
"""
+
Creates a Project with basic metadata.
A Project is a container of experiments.
@@ -3312,7 +3582,7 @@ class Client(Iface):
The identifier for the requested gateway.
@param Project
- The Project Object described in the workspace_model
+ The Project Object described in the workspace_model.
@@ -3359,6 +3629,7 @@ class Client(Iface):
def updateProject(self, authzToken, projectId, updatedProject):
"""
+
Update an Existing Project
@param projectId
@@ -3412,14 +3683,15 @@ class Client(Iface):
def getProject(self, authzToken, projectId):
"""
+
Get a Project by ID
- This method is to obtain a project by providing a projectId
+ This method is to obtain a project by providing a projectId.
@param projectId
- projectId of the project you require
+ projectId of the project you require.
@return project
- project data model will be returned
+ project data model will be returned.
@@ -3466,15 +3738,18 @@ class Client(Iface):
def deleteProject(self, authzToken, projectId):
"""
+
Delete a Project
- This method is used to delete an existing Project
+ This method is used to delete an existing Project.
@param projectId
- projectId of the project you want to delete
+ 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.
+
Parameters:
@@ -3520,20 +3795,21 @@ class Client(Iface):
def getUserProjects(self, authzToken, gatewayId, userName, limit, offset):
"""
- Get all Project by user with pagination. Results will be ordered based
- on creation time DESC
+
+ 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
+ The identifier of the user.
@param limit
- The amount results to be fetched
+ The amount results to be fetched.
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
@@ -3584,19 +3860,25 @@ class Client(Iface):
def searchProjectsByProjectName(self, authzToken, gatewayId, userName, projectName, limit, offset):
"""
- Get all Project for user by project name with pagination.Results will be ordered based
- on creation time DESC
+
+ Search User Projects by Project Name
+ Get all Project for user by project name with pagination.Results will be ordered based on creation time DESC.
@param gatewayId
- The identifier for the requested gateway.
+ The unique identifier for the requested gateway.
+
@param userName
- The identifier of the user
+ The identifier of the user.
+
@param projectName
- The name of the project on which the results to be fetched
+ The name of the project on which the results to be fetched.
+
@param limit
- The amount results to be fetched
+ The amount results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -3648,19 +3930,25 @@ class Client(Iface):
def searchProjectsByProjectDesc(self, authzToken, gatewayId, userName, description, limit, offset):
"""
- Search and get all Projects for user by project description with pagination. Results
- will be ordered based on creation time DESC
+
+ Search User Projects by Project Description
+ Search and get all Projects for user by project description with pagination. Results will be ordered based on creation time DESC.
@param gatewayId
- The identifier for the requested gateway.
+ The unique identifier of the gateway making the request.
+
@param userName
- The identifier of the user
+ The identifier of the user.
+
@param description
- The description to be matched
+ The description to be matched.
+
@param limit
- The amount results to be fetched
+ The amount results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -3712,19 +4000,25 @@ class Client(Iface):
def searchExperimentsByName(self, authzToken, gatewayId, userName, expName, limit, offset):
"""
- Search Experiments by experiment name with pagination. Results will be sorted
- based on creation time DESC
+
+ Search User Experiments by Name
+ Search user Experiments using experiment name with pagination. Results will be sorted based on creation time DESC.
@param gatewayId
- Identifier of the requested gateway
+ Unique identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the user who created the experiments.
+
@param expName
- Experiment name to be matched
+ Experiment name to be matched.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -3776,19 +4070,25 @@ class Client(Iface):
def searchExperimentsByDesc(self, authzToken, gatewayId, userName, description, limit, offset):
"""
- Search Experiments by experiment name with pagination. Results will be sorted
- based on creation time DESC
+
+ Search By Experiment Description
+ Search Experiments by experiment description with pagination. Results will be sorted based on creation time DESC.
@param gatewayId
- Identifier of the requested gateway
+ Unique identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the requested user.
+
@param description
- Experiment description to be matched
+ Experiment description to be matched.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -3840,19 +4140,25 @@ class Client(Iface):
def searchExperimentsByApplication(self, authzToken, gatewayId, userName, applicationId, limit, offset):
"""
- Search Experiments by application id with pagination. Results will be sorted
- based on creation time DESC
+
+ Search Experiment By the Application
+ Search Experiments of a particular application id with pagination. Results will be sorted based on creation time DESC
@param gatewayId
- Identifier of the requested gateway
+ Unique identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the requested user.
+
@param applicationId
- Application id to be matched
+ Application id to be matched.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -3904,19 +4210,25 @@ class Client(Iface):
def searchExperimentsByStatus(self, authzToken, gatewayId, userName, experimentState, limit, offset):
"""
- Search Experiments by experiment status with pagination. Results will be sorted
- based on creation time DESC
+
+ Search User Experiments by Status
+ Search all the Experiments of the given user by experiment status with pagination. Results will be sorted based on creation time DESC
@param gatewayId
- Identifier of the requested gateway
+ Unique identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the user making the request.
+
@param experimentState
- Experiement state to be matched
+ Experiement state to be matched.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -3968,21 +4280,31 @@ class Client(Iface):
def searchExperimentsByCreationTime(self, authzToken, gatewayId, userName, fromTime, toTime, limit, offset):
"""
- Search Experiments by experiment creation time with pagination. Results will be sorted
- based on creation time DESC
+
+ Search User Experiments by the Creation Time
+ This will search all the experiments of the given user by experiment creation time with pagination. Results will be sorted based on creation time DESC.
@param gatewayId
- Identifier of the requested gateway
+ Unique identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the requested user.
+
@param fromTime
- Start time of the experiments creation time
+ Start time of the experiments creation time.
+
@param toTime
- End time of the experiement creation time
+ End time of the experiement creation time.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ 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.
+
Parameters:
@@ -4036,19 +4358,27 @@ class Client(Iface):
def searchExperiments(self, authzToken, gatewayId, userName, filters, limit, offset):
"""
- Search Experiments by using multiple filter criteria with pagination. Results will be sorted
- based on creation time DESC
+ 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
+ Identifier of the requested gateway.
+
@param userName
- Username of the requested user
+ Username of the user requesting the search function.
+
@param filters
- map of multiple filter criteria.
+ Map of multiple filter criteria. Currenlt search filters includes Experiment Name, Description, Application, etc....
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ 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.
+
Parameters:
@@ -4100,13 +4430,19 @@ class Client(Iface):
def getExperimentStatistics(self, authzToken, gatewayId, fromTime, toTime):
"""
- Get Experiment Statisitics for the given gateway for a specific time period
+
+ 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
- Identifier of the requested gateway
+ Unique identifier of the gateway making the request to fetch statistics.
+
@param fromTime
- Starting date time
+ Starting date time.
+
@param toTime
- Ending data time
+ Ending data time.
+
Parameters:
@@ -4154,15 +4490,19 @@ class Client(Iface):
def getExperimentsInProject(self, authzToken, projectId, limit, offset):
"""
- Get Experiments within project with pagination. Results will be sorted
- based on creation time DESC
+
+ Get All Experiments of the Project
+ Get Experiments within project with pagination. Results will be sorted based on creation time DESC.
@param projectId
- Identifier of the project
+ Uniqie identifier of the project.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -4212,17 +4552,22 @@ class Client(Iface):
def getUserExperiments(self, authzToken, gatewayId, userName, limit, offset):
"""
- Get experiments by user with pagination. Results will be sorted
- based on creation time DESC
+
+ 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
+ Identifier of the requesting gateway.
+
@param userName
- Username of the requested user
+ Username of the requested end user.
+
@param limit
- Amount of results to be fetched
+ Amount of results to be fetched.
+
@param offset
- The starting point of the results to be fetched
+ The starting point of the results to be fetched.
+
Parameters:
@@ -4272,12 +4617,17 @@ class Client(Iface):
def createExperiment(self, authzToken, gatewayId, experiment):
"""
+ *
+ * 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 basicExperimentMetadata
+ * @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.
@@ -4350,8 +4700,8 @@ class Client(Iface):
def deleteExperiment(self, authzToken, experimentId):
"""
- Delete an Experiment
+ Delete an Experiment
If the experiment is not already launched experiment can be deleted.
@param authzToken
@@ -4360,7 +4710,7 @@ class Client(Iface):
Experiment ID of the experimnet you want to delete.
@return boolean
- Identifier for the success or failure of the deletion operation
+ Identifier for the success or failure of the deletion operation.
@@ -4405,12 +4755,14 @@ class Client(Iface):
def getExperiment(self, authzToken, airavataExperimentId):
"""
+ *
+ * Get Experiment
* Fetch previously created experiment metadata.
*
* @param airavataExperimentId
- * The identifier for the requested experiment. This is returned during the create experiment step.
+ * The unique identifier of the requested experiment. This ID is returned during the create experiment step.
*
- * @return experimentMetada
+ * @return ExperimentModel
* This method will return the previously stored experiment metadata.
*
* @throws org.apache.airavata.model.error.InvalidRequestException
@@ -4481,14 +4833,17 @@ class Client(Iface):
def getDetailedExperimentTree(self, authzToken, airavataExperimentId):
"""
+
+ 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 experimentMetada
- This method will return the previously stored experiment metadata.
+ @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.
@@ -4557,14 +4912,15 @@ class Client(Iface):
def updateExperiment(self, authzToken, airavataExperimentId, experiment):
"""
- Configure a previously 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.
+
+ 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 experimentConfigurationData
+ @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.
@@ -4709,13 +5065,14 @@ class Client(Iface):
def validateExperiment(self, authzToken, airavataExperimentId):
"""
*
- * Validate experiment configuration. A true in general indicates, the experiment is ready to be launched.
- *
- * @param experimentId
+ * 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
+ * Identifier for the success or failure of the validation operation.
*
*
@@ -4762,8 +5119,12 @@ class Client(Iface):
def launchExperiment(self, authzToken, airavataExperimentId, gatewayId):
"""
- Launch a previously created and 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.
+
+ 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.
@@ -4838,17 +5199,18 @@ class Client(Iface):
def getExperimentStatus(self, authzToken, airavataExperimentId):
"""
+
Get Experiment Status
- Obtain the status os an experiment by providing the Experiment Id
+ Obtain the status of an experiment by providing the Experiment Id
@param authzToken
- @param experiementId
- Experiment ID of the experimnet you require the status
+ @param airavataExperimentId
+ Experiment ID of the experimnet you require the status.
@return ExperimentStatus
- ExperimentStatus model with current status will be returned.
+ ExperimentStatus model with the current status will be returned.
@@ -4895,16 +5257,17 @@ class Client(Iface):
def getExperimentOutputs(self, authzToken, airavataExperimentId):
"""
+
Get Experiment Outputs
- This method to be used when need to obtain outputs of a certain Experiment
+ This method to be used when need to obtain final outputs of a certain Experiment
@param authzToken
- @param experiementId
- Experiment ID of the experimnet you need the outputs
+ @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
+ List of experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment.
@@ -4951,16 +5314,17 @@ class Client(Iface):
def getIntermediateOutputs(self, authzToken, airavataExperimentId):
"""
+
Get Intermediate Experiment Outputs
This method to be used when need to obtain intermediate outputs of a certain Experiment
@param authzToken
- @param experiementId
- Experiment ID of the experimnet you need the intermediate outputs
+ @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
+ List of intermediate experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment.
@@ -5007,13 +5371,14 @@ class Client(Iface):
def getJobStatuses(self, authzToken, airavataExperimentId):
"""
- Get Job Status for an Experiment
+
+ 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 intermediate outputs
+ 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
@@ -5063,16 +5428,17 @@ class Client(Iface):
def getJobDetails(self, authzToken, airavataExperimentId):
"""
- Get Job Details for all the jobs within an Experiment
+
+ 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
+ Experiment ID of the experimnet you need job details.
@return list of JobDetails
- Job details
+ Job details.
@@ -5119,7 +5485,9 @@ class Client(Iface):
def cloneExperiment(self, authzToken, existingExperimentID, newExperimentName):
"""
- Clone an specified experiment with a new name. A copy of the experiment configuration is made and is persisted with new metadata.
+
+ 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
@@ -5131,7 +5499,7 @@ class Client(Iface):
should be shared public by default.
@return
- The server-side generated.airavata.registry.core.experiment.globally unique identifier for the newly cloned experiment.
+ 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.
@@ -5202,12 +5570,16 @@ class Client(Iface):
def terminateExperiment(self, authzToken, airavataExperimentId, gatewayId):
"""
- Terminate a running experiment.
+
+ Terminate a running Experiment.
+
+ @gatewayId
+ ID of the gateway which will terminate the running Experiment.
@param airavataExperimentId
- The identifier for the requested experiment. This is returned during the create experiment step.
+ The identifier of the experiment required termination. This ID is returned during the create experiment step.
- @return
+ @return status
This method call does not have a return value.
@throws org.apache.airavata.model.error.InvalidRequestException
@@ -5277,13 +5649,17 @@ class Client(Iface):
def registerApplicationModule(self, authzToken, gatewayId, applicationModule):
"""
+
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 a server-side generated airavata appModule globally unique identifier.
+ Returns the server-side generated airavata appModule globally unique identifier.
Parameters:
@@ -5329,13 +5705,14 @@ class Client(Iface):
def getApplicationModule(self, authzToken, appModuleId):
"""
+
Fetch a Application Module.
@param appModuleId
- The identifier for the requested application module
+ The unique identifier of the application module required
@return applicationModule
- Returns a application Module Object.
+ Returns an Application Module Object.
Parameters:
@@ -5379,6 +5756,7 @@ class Client(Iface):
def updateApplicationModule(self, authzToken, appModuleId, applicationModule):
"""
+
Update a Application Module.
@param appModuleId
@@ -5434,6 +5812,16 @@ class Client(Iface):
def getAllAppModules(self, authzToken, gatewayId):
"""
+
+ 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.
+
+
Parameters:
- authzToken
- gatewayId
@@ -5475,10 +5863,11 @@ class Client(Iface):
def deleteApplicationModule(self, authzToken, appModuleId):
"""
- Delete a Application Module.
+
+ Delete an Application Module.
@param appModuleId
- The identifier for the requested application module to be deleted.
+ The identifier of the Application Module to be deleted.
@return status
Returns a success/failure of the deletion.
@@ -5525,9 +5914,13 @@ class Client(Iface):
def registerApplicationDeployment(self, authzToken, gatewayId, applicationDeployment):
"""
- Register a Application Deployment.
- @param applicationModule
+ 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
@@ -5577,6 +5970,7 @@ class Client(Iface):
def getApplicationDeployment(self, authzToken, appDeploymentId):
"""
+
Fetch a Application Deployment.
@param appDeploymentId
@@ -5627,10 +6021,11 @@ class Client(Iface):
def updateApplicationDeployment(self, authzToken, appDeploymentId, applicationDeployment):
"""
- Update a Application Deployment.
+
+ Update an Application Deployment.
@param appDeploymentId
- The identifier for the requested application deployment to be updated.
+ The identifier of the requested application deployment to be updated.
@param appDeployment
Application Deployment Object created from the datamodel.
@@ -5682,10 +6077,11 @@ class Client(Iface):
def deleteApplicationDeployment(self, authzToken, appDeploymentId):
"""
- Delete a Application deployment.
+
+ Delete an Application Deployment.
@param appDeploymentId
- The identifier for the requested application deployment to be deleted.
+ The unique identifier of application deployment to be deleted.
@return status
Returns a success/failure of the deletion.
@@ -5732,10 +6128,14 @@ class Client(Iface):
def getAllApplicationDeployments(self, authzToken, gatewayId):
"""
+
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.
+ Returns the list of all application Deployment Objects.
Parameters:
@@ -5829,9 +6229,10 @@ class Client(Iface):
def registerApplicationInterface(self, authzToken, gatewayId, applicationInterface):
"""
+
Register a Application Interface.
- @param applicationModule
+ @param applicationInterface
Application Module Object created from the datamodel.
@return appInterfaceId
@@ -5881,6 +6282,22 @@ class Client(Iface):
def cloneApplicationInterface(self, authzToken, existingAppInterfaceID, newApplicationName, gatewayId):
"""
+
+ 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.
+
+
Parameters:
- authzToken
- existingAppInterfaceID
@@ -5926,14 +6343,14 @@ class Client(Iface):
def getApplicationInterface(self, authzToken, appInterfaceId):
"""
- Fetch a Application Interface.
+
+ Fetch an Application Interface.
@param appInterfaceId
- The identifier for the requested application module
+ The identifier for the requested application interface.
@return applicationInterface
- Returns a application Interface Object.
-
+ Returns an application Interface Object.
Parameters:
@@ -5977,10 +6394,11 @@ class Client(Iface):
def updateApplicationInterface(self, authzToken, appInterfaceId, applicationInterface):
"""
+
Update a Application Interface.
@param appInterfaceId
- The identifier for the requested application deployment to be updated.
+ The identifier of the requested application deployment to be updated.
@param appInterface
Application Interface Object created from the datamodel.
@@ -5989,7 +6407,6 @@ class Client(Iface):
Returns a success/failure of the update.
-
Parameters:
- authzToken
- appInterfaceId
@@ -6033,7 +6450,8 @@ class Client(Iface):
def deleteApplicationInterface(self, authzToken, appInterfaceId):
"""
- Delete a Application Interface.
+
+ Delete an Application Interface.
@param appInterfaceId
The identifier for the requested application interface to be deleted.
@@ -6042,7 +6460,6 @@ class Client(Iface):
Returns a success/failure of the deletion.
-
Parameters:
- authzToken
- appInterfaceId
@@ -6084,11 +6501,12 @@ class Client(Iface):
def getAllApplicationInterfaceNames(self, authzToken, gatewayId):
"""
- Fetch name and id of Application Interface documents.
+
+ Fetch name and ID of Application Interface documents.
@return map<applicationId, applicationInterfaceNames>
- Returns a list of application interfaces with corresponsing id's
+ Returns a list of application interfaces with corresponsing ID's
Parameters:
@@ -6132,11 +6550,12 @@ class Client(Iface):
def getAllApplicationInterfaces(self, authzToken, gatewayId):
"""
+
Fetch all Application Interface documents.
@return map<applicationId, applicationInterfaceNames>
- Returns a list of application interfaces documents
+ Returns a list of application interfaces documents (Application Interface ID, name, description, Inputs and Outputs objects).
Parameters:
@@ -6180,10 +6599,11 @@ class Client(Iface):
def getApplicationInputs(self, authzToken, appInterfaceId):
"""
+
Fetch the list of Application Inputs.
@param appInterfaceId
- The identifier for the requested application interface
+ The identifier of the application interface which need inputs to be fetched.
@return list<application_interface_model.InputDataObjectType>
Returns a list of application inputs.
@@ -6230,10 +6650,11 @@ class Client(Iface):
def getApplicationOutputs(self, authzToken, appInterfaceId):
"""
- Fetch the list of Application Outputs.
+
+ Fetch list of Application Outputs.
@param appInterfaceId
- The identifier for the requested application interface
+ The identifier of the application interface which need outputs to be fetched.
@return list<application_interface_model.OutputDataObjectType>
Returns a list of application outputs.
@@ -6280,14 +6701,15 @@ class Client(Iface):
def getAvailableAppInterfaceComputeResources(self, authzToken, appInterfaceId):
"""
+
Fetch a list of all deployed Compute Hosts for a given application interfaces.
@param appInterfaceId
- The identifier for the requested application interface
+ 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.
+ Deployments of each modules listed within the interfaces will be listed.
Parameters:
@@ -6431,6 +6853,7 @@ class Client(Iface):
def getAllComputeResourceNames(self, authzToken):
"""
+
Fetch all registered Compute Resources.
@return A map of registered compute resource id's and thier corresponding hostnames.
@@ -6726,7 +7149,7 @@ class Client(Iface):
def updateStorageResource(self, authzToken, storageResourceId, storageResourceDescription):
"""
- Update a Compute Resource.
+ Update a Storage Resource.
@param storageResourceId
The identifier for the requested compute resource to be updated.
@@ -6784,7 +7207,7 @@ class Client(Iface):
Delete a Storage Resource.
@param storageResourceId
- The identifier for the requested compute resource to be deleted.
+ The identifier of the requested compute resource to be deleted.
@return status
Returns a success/failure of the deletion.
@@ -7163,6 +7586,7 @@ class Client(Iface):
def addUNICOREJobSubmissionDetails(self, authzToken, computeResourceId, priorityOrder, unicoreJobSubmission):
"""
+
Add a UNICORE Job Submission details to a compute resource
App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
@@ -7224,10 +7648,13 @@ class Client(Iface):
def getUnicoreJobSubmission(self, authzToken, jobSubmissionId):
"""
+ *
* This method returns UnicoreJobSubmission object
+ *
* @param jobSubmissionInterfaceId
* The identifier of the JobSubmission Interface to be retrieved.
* @return UnicoreJobSubmission instance
+ *
*
Parameters:
@@ -7271,6 +7698,7 @@ class Client(Iface):
def addCloudJobSubmissionDetails(self, authzToken, computeResourceId, priorityOrder, cloudSubmission):
"""
+ *
* Add a Cloud Job Submission details to a compute resource
* App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
*
@@ -7285,6 +7713,7 @@ class Client(Iface):
*
* @return status
* Returns the unique job submission id.
+ *
*
Parameters:
@@ -7332,6 +7761,7 @@ class Client(Iface):
def getCloudJobSubmission(self, authzToken, jobSubmissionId):
"""
+ *
* This method returns cloudJobSubmission object
* @param jobSubmissionInterfaceI
* The identifier of the JobSubmission Interface to be retrieved.
@@ -7379,6 +7809,7 @@ class Client(Iface):
def updateSSHJobSubmissionDetails(self, authzToken, jobSubmissionInterfaceId, sshJobSubmission):
"""
+
Update the given SSH Job Submission details
@param jobSubmissionInterfaceId
@@ -7434,6 +7865,7 @@ class Client(Iface):
def updateCloudJobSubmissionDetails(self, authzToken, jobSubmissionInterfaceId, sshJobSubmission):
"""
+
Update the cloud Job Submission details
@param jobSubmissionInterfaceId
@@ -7489,6 +7921,7 @@ class Client(Iface):
def updateUnicoreJobSubmissionDetails(self, authzToken, jobSubmissionInterfaceId, unicoreJobSubmission):
"""
+
Update the UNIOCRE Job Submission details
@param jobSubmissionInterfaceId
@@ -7545,6 +7978,7 @@ class Client(Iface):
def addLocalDataMovementDetails(self, authzToken, resourceId, dataMoveType, priorityOrder, localDataMovement):
"""
+
Add a Local data movement details to a compute resource
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -7612,6 +8046,7 @@ class Client(Iface):
def updateLocalDataMovementDetails(self, authzToken, dataMovementInterfaceId, localDataMovement):
"""
+
Update the given Local data movement details
@param dataMovementInterfaceId
@@ -7668,7 +8103,8 @@ class Client(Iface):
def getLocalDataMovement(self, authzToken, dataMovementId):
"""
- This method returns local datamovement object
+
+ This method returns local datamovement object.
@param dataMovementId
The identifier of the datamovement Interface to be retrieved.
@@ -7718,6 +8154,7 @@ class Client(Iface):
def addSCPDataMovementDetails(self, authzToken, resourceId, dataMoveType, priorityOrder, scpDataMovement):
"""
+
Add a SCP data movement details to a compute resource
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -7781,6 +8218,7 @@ class Client(Iface):
def updateSCPDataMovementDetails(self, authzToken, dataMovementInterfaceId, scpDataMovement):
"""
+
Update the given scp data movement details
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -7887,6 +8325,7 @@ class Client(Iface):
def addUnicoreDataMovementDetails(self, authzToken, resourceId, dataMoveType, priorityOrder, unicoreDataMovement):
"""
+
Add a UNICORE data movement details to a compute resource
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -7950,6 +8389,7 @@ class Client(Iface):
def updateUnicoreDataMovementDetails(self, authzToken, dataMovementInterfaceId, unicoreDataMovement):
"""
+
Update a selected UNICORE data movement details
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -8007,6 +8447,7 @@ class Client(Iface):
def getUnicoreDataMovement(self, authzToken, dataMovementId):
"""
+
This method returns UNICORE datamovement object
@param dataMovementId
@@ -8057,6 +8498,7 @@ class Client(Iface):
def addGridFTPDataMovementDetails(self, authzToken, resourceId, dataMoveType, priorityOrder, gridFTPDataMovement):
"""
+
Add a GridFTP data movement details to a compute resource
App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
@@ -8827,7 +9269,7 @@ class Client(Iface):
Fetch the given Gateway Resource Profile.
@param gatewayID
- The identifier for the requested gateway resource
+ The identifier for the requested gateway resource.
@return gatewayResourceProfile
Gateway Resource Profile Object.
@@ -9040,6 +9482,22 @@ class Client(Iface):
def addGatewayStoragePreference(self, authzToken, gatewayID, storageResourceId, storagePreference):
"""
+ 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.
+
+
Parameters:
- authzToken
- gatewayID
@@ -9085,6 +9543,7 @@ class Client(Iface):
def getGatewayComputeResourcePreference(self, authzToken, gatewayID, computeResourceId):
"""
+
Fetch a Compute Resource Preference of a registered gateway profile.
@param gatewayID
@@ -9140,6 +9599,19 @@ class Client(Iface):
def getGatewayStoragePreference(self, authzToken, gatewayID, storageResourceId):
"""
+
+ 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.
+
+ @pa
<TRUNCATED>