| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| */ |
| |
| /** |
| * 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. |
| */ |
| |
| include "airavataErrors.thrift" |
| include "airavataDataModel.thrift" |
| include "experimentModel.thrift" |
| include "workspaceModel.thrift" |
| include "computeResourceModel.thrift" |
| include "applicationDeploymentModel.thrift" |
| include "applicationInterfaceModel.thrift" |
| include "gatewayResourceProfileModel.thrift" |
| |
| namespace java org.apache.airavata.api |
| namespace php Airavata.API |
| namespace cpp apache.airavata.api |
| namespace perl ApacheAiravataAPI |
| namespace py apache.airavata.api |
| namespace js ApacheAiravataAPI |
| |
| /** |
| * 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. |
| * |
| */ |
| const string AIRAVATA_API_VERSION = "0.13.0" |
| |
| service Airavata { |
| |
| /** |
| * Apache Airavata API Service Methods. For data structures associated in the signatures, please see included thrift files |
| */ |
| |
| /** |
| * Fetch Apache Airavata API version |
| */ |
| string getAPIVersion() |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Create a Project |
| * |
| */ |
| string createProject (1: required workspaceModel.Project project) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Update a Project |
| * |
| */ |
| void updateProject (1: required string projectId, |
| 2: required workspaceModel.Project updatedProject) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase, |
| 4: airavataErrors.ProjectNotFoundException pnfe) |
| |
| /** |
| * Get a Project by ID |
| * |
| */ |
| workspaceModel.Project getProject (1: required string projectId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase, |
| 4: airavataErrors.ProjectNotFoundException pnfe) |
| |
| /** |
| * Get all Project by user |
| * |
| */ |
| list<workspaceModel.Project> getAllUserProjects (1: required string userName) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Get all Project for user by project name |
| * |
| */ |
| list<workspaceModel.Project> searchProjectsByProjectName (1: required string userName, 2: required string projectName) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Get all Project for user by project description |
| * |
| */ |
| list<workspaceModel.Project> searchProjectsByProjectDesc (1: required string userName, 2: required string description) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| |
| /** |
| * Search Experiments by experiment name |
| * |
| */ |
| list<experimentModel.ExperimentSummary> searchExperimentsByName (1: required string userName, 2: required string expName) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Search Experiments by experiment name |
| * |
| */ |
| list<experimentModel.ExperimentSummary> searchExperimentsByDesc (1: required string userName, 2: required string description) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Search Experiments by application id |
| * |
| */ |
| list<experimentModel.ExperimentSummary> searchExperimentsByApplication (1: required string userName, 2: required string applicationId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Get all Experiments within a Project |
| * |
| */ |
| list<experimentModel.Experiment> getAllExperimentsInProject(1: required string projectId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase, |
| 4: airavataErrors.ProjectNotFoundException pnfe) |
| |
| /** |
| * Get all Experiments by user |
| * |
| */ |
| list<experimentModel.Experiment> getAllUserExperiments(1: required string userName) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Create an experiment for the specified user belonging to the gateway. The gateway identity is not explicitly passed |
| * but inferred from the authentication 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 |
| * 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 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. |
| * |
| */ |
| |
| string createExperiment(1: required experimentModel.Experiment experiment) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Fetch previously created experiment metadata. |
| * |
| * @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. |
| * |
| * @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. |
| * |
| */ |
| experimentModel.Experiment getExperiment(1: required string airavataExperimentId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.ExperimentNotFoundException enf, |
| 3: airavataErrors.AiravataClientException ace, |
| 4: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| * @param airavataExperimentId |
| * The identifier for the requested experiment. This is returned during the create experiment step. |
| * |
| * @param experimentConfigurationData |
| * 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. |
| * |
| */ |
| void updateExperiment(1: required string airavataExperimentId, |
| 2: required experimentModel.Experiment experiment) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.ExperimentNotFoundException enf, |
| 3: airavataErrors.AiravataClientException ace, |
| 4: airavataErrors.AiravataSystemException ase) |
| |
| void updateExperimentConfiguration(1: required string airavataExperimentId, |
| 2: required experimentModel.UserConfigurationData userConfiguration) |
| |
| void updateResourceScheduleing(1: required string airavataExperimentId, |
| 2: required experimentModel.ComputationalResourceScheduling resourceScheduling) |
| |
| /** |
| * |
| * Validate experiment configuration. A true in general indicates, the experiment is ready to be launched. |
| * |
| * @param experimentID |
| * @return sucess/failure |
| * |
| **/ |
| bool validateExperiment(1: required string airavataExperimentId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.ExperimentNotFoundException enf, |
| 3: airavataErrors.AiravataClientException ace, |
| 4: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| * @param airavataExperimentId |
| * The identifier for the requested experiment. This is returned during the create experiment step. |
| * |
| * @param airavataCredStoreToken: |
| * A requirement to execute experiments within Airavata is to first register the targeted remote computational account |
| * credentials with Airavata Credential Store. The administrative API (related to credential store) will return a |
| * generated token associated with the registered credentials. The client has to security posses this token id and is |
| * required to pass it to Airavata Server for all execution requests. |
| * Note: At this point only the credential store token is required so the string is directly passed here. In future if |
| * if more security credentials are enables, then the structure ExecutionSecurityParameters should be used. |
| * Note: This parameter is not persisted within Airavata Registry for security reasons. |
| * |
| * @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. |
| * |
| */ |
| void launchExperiment(1: required string airavataExperimentId |
| 2: required string airavataCredStoreToken) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.ExperimentNotFoundException enf, |
| 3: airavataErrors.AiravataClientException ace, |
| 4: airavataErrors.AiravataSystemException ase, |
| 5: airavataErrors.LaunchValidationException lve) |
| |
| |
| experimentModel.ExperimentStatus getExperimentStatus(1: required string airavataExperimentId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.ExperimentNotFoundException enf, |
| 3: airavataErrors.AiravataClientException ace, |
| 4: airavataErrors.AiravataSystemException ase) |
| |
| list<experimentModel.DataObjectType> getExperimentOutputs (1: required string airavataExperimentId) |
| |
| map<string, experimentModel.JobStatus> getJobStatuses(1: required string airavataExperimentId) |
| |
| /** |
| * Clone an specified experiment with a new name. 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. |
| * |
| * @return |
| * The server-side generated airavata experiment globally unique identifier 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. |
| * |
| */ |
| string cloneExperiment(1: string existingExperimentID, |
| 2: string newExperimentName) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.ExperimentNotFoundException enf, |
| 3: airavataErrors.AiravataClientException ace, |
| 4: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Terminate a running 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. |
| * |
| */ |
| void terminateExperiment(1: string airavataExperimentId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.ExperimentNotFoundException enf, |
| 3: airavataErrors.AiravataClientException ace, |
| 4: airavataErrors.AiravataSystemException ase) |
| |
| /* |
| * API definitions for App Catalog related operations |
| * |
| */ |
| |
| /* |
| * Application Module is a specific computational application. Many applications, particularly scientific applications |
| * are really a suite of applications or encompass an ecosystem. For instance, Amber is referred to dozens of binaries. |
| * WRF is referred for an ecosystem of applications. In this context, we refer to module as a single binary. |
| * |
| * Note: A module has to be defined before a deployment can be registered. |
| * |
| */ |
| |
| /** |
| * Register a Application Module. |
| * |
| * @param applicationModule |
| * Application Module Object created from the datamodel. |
| * |
| * @return appModuleId |
| * Returns a server-side generated airavata appModule globally unique identifier. |
| * |
| */ |
| string registerApplicationModule(1: required applicationDeploymentModel.ApplicationModule applicationModule) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Fetch a Application Module. |
| * |
| * @param appModuleId |
| * The identifier for the requested application module |
| * |
| * @return applicationModule |
| * Returns a application Module Object. |
| * |
| */ |
| applicationDeploymentModel.ApplicationModule getApplicationModule(1: required string appModuleId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool updateApplicationModule(1: required string appModuleId, |
| 2: required applicationDeploymentModel.ApplicationModule applicationModule) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Delete a Application Module. |
| * |
| * @param appModuleId |
| * The identifier for the requested application module to be deleted. |
| * |
| * @return status |
| * Returns a success/failure of the deletion. |
| * |
| */ |
| bool deleteApplicationModule(1: required string appModuleId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /* |
| * Application Deployment registers a deployment of a application module on a compute resource |
| * |
| */ |
| |
| /** |
| * Register a Application Deployment. |
| * |
| * @param applicationModule |
| * Application Module Object created from the datamodel. |
| * |
| * @return appDeploymentId |
| * Returns a server-side generated airavata appDeployment globally unique identifier. |
| * |
| */ |
| string registerApplicationDeployment(1: required applicationDeploymentModel.ApplicationDeploymentDescription applicationDeployment) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Fetch a Application Deployment. |
| * |
| * @param appDeploymentId |
| * The identifier for the requested application module |
| * |
| * @return applicationDeployment |
| * Returns a application Deployment Object. |
| * |
| */ |
| applicationDeploymentModel.ApplicationDeploymentDescription getApplicationDeployment(1: required string appDeploymentId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Update a Application Deployment. |
| * |
| * @param appDeploymentId |
| * The identifier for 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. |
| * |
| */ |
| bool updateApplicationDeployment(1: required string appDeploymentId, |
| 2: required applicationDeploymentModel.ApplicationDeploymentDescription applicationDeployment) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Delete a Application deployment. |
| * |
| * @param appDeploymentId |
| * The identifier for the requested application deployment to be deleted. |
| * |
| * @return status |
| * Returns a success/failure of the deletion. |
| * |
| */ |
| bool deleteApplicationDeployment(1: required string appDeploymentId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| list<string> getAppModuleDeployedResources(1: required string appModuleId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /* |
| * Application Interface |
| * |
| */ |
| |
| /** |
| * Register a Application Interface. |
| * |
| * @param applicationModule |
| * Application Module Object created from the datamodel. |
| * |
| * @return appInterfaceId |
| * Returns a server-side generated airavata application interface globally unique identifier. |
| * |
| */ |
| string registerApplicationInterface(1: required applicationInterfaceModel.ApplicationInterfaceDescription |
| applicationInterface) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Fetch a Application Interface. |
| * |
| * @param appInterfaceId |
| * The identifier for the requested application module |
| * |
| * @return applicationInterface |
| * Returns a application Interface Object. |
| * |
| * |
| */ |
| applicationInterfaceModel.ApplicationInterfaceDescription getApplicationInterface(1: required string appInterfaceId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Update a Application Interface. |
| * |
| * @param appInterfaceId |
| * The identifier for 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. |
| * |
| * |
| */ |
| bool updateApplicationInterface(1: required string appInterfaceId, |
| 2: required applicationInterfaceModel.ApplicationInterfaceDescription applicationInterface) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Delete a Application Interface. |
| * |
| * @param appInterfaceId |
| * The identifier for the requested application interface to be deleted. |
| * |
| * @return status |
| * Returns a success/failure of the deletion. |
| * |
| * |
| */ |
| bool deleteApplicationInterface(1: required string appInterfaceId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Fetch name and id of Application Interface documents. |
| * |
| * |
| * @return map<applicationId, applicationInterfaceNames> |
| * Returns a list of application interfaces with corresponsing id's |
| * |
| */ |
| map<string, string> getAllApplicationInterfaceNames () |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Fetch all Application Interface documents. |
| * |
| * |
| * @return map<applicationId, applicationInterfaceNames> |
| * Returns a list of application interfaces documents |
| * |
| */ |
| list<applicationInterfaceModel.ApplicationInterfaceDescription> getAllApplicationInterfaces () |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Fetch the list of Application Inputs. |
| * |
| * @param appInterfaceId |
| * The identifier for the requested application interface |
| * |
| * @return list<applicationInterfaceModel.InputDataObjectType> |
| * Returns a list of application inputs. |
| * |
| */ |
| list<applicationInterfaceModel.InputDataObjectType> getApplicationInputs(1: required string appInterfaceId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Fetch the list of Application Outputs. |
| * |
| * @param appInterfaceId |
| * The identifier for the requested application interface |
| * |
| * @return list<applicationInterfaceModel.OutputDataObjectType> |
| * Returns a list of application outputs. |
| * |
| */ |
| list<applicationInterfaceModel.OutputDataObjectType> getApplicationOutputs(1: required string appInterfaceId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| map<string, string> getAvailableAppInterfaceComputeResources(1: required string appInterfaceId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /* |
| * Compute Resource |
| * |
| */ |
| |
| /** |
| * 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. |
| * |
| */ |
| string registerComputeResource(1: required computeResourceModel.ComputeResourceDescription |
| computeResourceDescription) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Fetch the given Compute Resource. |
| * |
| * @param computeResourceId |
| * The identifier for the requested compute resource |
| * |
| * @return computeResourceDescription |
| * Compute Resource Object created from the datamodel.. |
| * |
| */ |
| computeResourceModel.ComputeResourceDescription getComputeResource(1: required string computeResourceId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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.. |
| * |
| */ |
| map<string, string> getAllComputeResourceNames() |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool updateComputeResource(1: required string computeResourceId, |
| 2: required computeResourceModel.ComputeResourceDescription computeResourceDescription) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool deleteComputeResource(1: required string computeResourceId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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 a success/failure of the deletion. |
| * |
| */ |
| bool addLocalSubmissionDetails(1: required string computeResourceId, |
| 2: required i32 priorityOrder, |
| 3: required computeResourceModel.LOCALSubmission localSubmission) |
| |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool updateLocalSubmissionDetails(1: required string jobSubmissionInterfaceId, |
| 2: required computeResourceModel.LOCALSubmission localSubmission) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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 a success/failure of the deletion. |
| * |
| */ |
| bool addSSHJobSubmissionDetails(1: required string computeResourceId, |
| 2: required i32 priorityOrder, |
| 3: required computeResourceModel.SSHJobSubmission sshJobSubmission) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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 a success/failure of the deletion. |
| **/ |
| bool addCloudJobSubmissionDetails(1: required string computeResourceId, |
| 2: required i32 priorityOrder, |
| 3: required computeResourceModel.CloudJobSubmission cloudSubmission) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| /** |
| * 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 deletion. |
| * |
| */ |
| bool updateSSHJobSubmissionDetails(1: required string jobSubmissionInterfaceId, |
| 2: required computeResourceModel.SSHJobSubmission sshJobSubmission) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Update the given SSH 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 deletion. |
| * |
| */ |
| bool updateCloudJobSubmissionDetails(1: required string jobSubmissionInterfaceId, |
| 2: required computeResourceModel.CloudJobSubmission sshJobSubmission) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Add a Local data movement details to a compute resource |
| * App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. |
| * |
| * @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 localDataMovement |
| * The LOCALDataMovement object to be added to the resource. |
| * |
| * @return status |
| * Returns a success/failure of the addition. |
| * |
| */ |
| bool addLocalDataMovementDetails(1: required string computeResourceId, |
| 2: required i32 priorityOrder, |
| 3: required computeResourceModel.LOCALDataMovement localDataMovement) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Update the given Local data movement details |
| * |
| * @param jobSubmissionInterfaceId |
| * The identifier of the JobSubmission Interface to be updated. |
| * |
| * @param localDataMovement |
| * The LOCALDataMovement object to be updated. |
| * |
| * @return status |
| * Returns a success/failure of the update. |
| * |
| */ |
| bool updateLocalDataMovementDetails(1: required string jobSubmissionInterfaceId, |
| 2: required computeResourceModel.LOCALDataMovement localDataMovement) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Add a SCP data movement details to a compute resource |
| * App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. |
| * |
| * @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 scpDataMovement |
| * The SCPDataMovement object to be added to the resource. |
| * |
| * @return status |
| * Returns a success/failure of the deletion. |
| * |
| */ |
| bool addSCPDataMovementDetails(1: required string computeResourceId, |
| 2: required i32 priorityOrder, |
| 3: required computeResourceModel.SCPDataMovement scpDataMovement) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Update the given scp data movement details |
| * App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. |
| * |
| * @param jobSubmissionInterfaceId |
| * The identifier of the JobSubmission Interface to be updated. |
| * |
| * @param scpDataMovement |
| * The SCPDataMovement object to be updated. |
| * |
| * @return status |
| * Returns a success/failure of the update. |
| * |
| */ |
| bool updateSCPDataMovementDetails(1: required string jobSubmissionInterfaceId, |
| 2: required computeResourceModel.SCPDataMovement scpDataMovement) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Add a GridFTP data movement details to a compute resource |
| * App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. |
| * |
| * @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 gridFTPDataMovement |
| * The GridFTPDataMovement object to be added to the resource. |
| * |
| * @return status |
| * Returns a success/failure of the deletion. |
| * |
| */ |
| bool addGridFTPDataMovementDetails(1: required string computeResourceId, |
| 2: required i32 priorityOrder, |
| 3: required computeResourceModel.GridFTPDataMovement gridFTPDataMovement) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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 jobSubmissionInterfaceId |
| * The identifier of the JobSubmission Interface to be updated. |
| * |
| * @param gridFTPDataMovement |
| * The GridFTPDataMovement object to be updated. |
| * |
| * @return status |
| * Returns a success/failure of the updation. |
| * |
| */ |
| bool updateGridFTPDataMovementDetails(1: required string jobSubmissionInterfaceId, |
| 2: required computeResourceModel.GridFTPDataMovement gridFTPDataMovement) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool changeJobSubmissionPriority(1: required string jobSubmissionInterfaceId, |
| 2: required i32 newPriorityOrder) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool changeDataMovementPriority(1: required string dataMovementInterfaceId, |
| 2: required i32 newPriorityOrder) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool changeJobSubmissionPriorities(1: required map<string, i32> jobSubmissionPriorityMap) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool changeDataMovementPriorities(1: required map<string, i32> dataMovementPriorityMap) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool deleteJobSubmissionInterface(1: required string jobSubmissionInterfaceId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool deleteDataMovementInterface(1: required string dataMovementInterfaceId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /* |
| * Gateway Resource Profile |
| * |
| */ |
| |
| /** |
| * 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. |
| * |
| */ |
| string registerGatewayResourceProfile( |
| 1: required gatewayResourceProfileModel.GatewayResourceProfile gatewayResourceProfile) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * Fetch the given Gateway Resource Profile. |
| * |
| * @param gatewayID |
| * The identifier for the requested gateway resource |
| * |
| * @return gatewayResourceProfile |
| * Gateway Resource Profile Object. |
| * |
| */ |
| gatewayResourceProfileModel.GatewayResourceProfile getGatewayResourceProfile(1: required string gatewayID) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool updateGatewayResourceProfile(1: required string gatewayID, |
| 2: required gatewayResourceProfileModel.GatewayResourceProfile gatewayResourceProfile) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool deleteGatewayResourceProfile(1: required string gatewayID) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool addGatewayComputeResourcePreference(1: required string gatewayID, |
| 2: required string computeResourceId, |
| 3: required gatewayResourceProfileModel.ComputeResourcePreference computeResourcePreference) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| gatewayResourceProfileModel.ComputeResourcePreference getGatewayComputeResourcePreference(1: required string gatewayID, |
| 2: required string computeResourceId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| list<gatewayResourceProfileModel.ComputeResourcePreference> |
| getAllGatewayComputeResourcePreferences(1: required string gatewayID) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool updateGatewayComputeResourcePreference(1: required string gatewayID, |
| 2: required string computeResourceId, |
| 3: required gatewayResourceProfileModel.ComputeResourcePreference computeResourcePreference) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| /** |
| * 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. |
| * |
| */ |
| bool deleteGatewayComputeResourcePreference(1: required string gatewayID, |
| 2: required string computeResourceId) |
| throws (1: airavataErrors.InvalidRequestException ire, |
| 2: airavataErrors.AiravataClientException ace, |
| 3: airavataErrors.AiravataSystemException ase) |
| |
| //End of API |
| } |
| |
