Constant | Type | Value |
---|---|---|
AIRAVATA_API_VERSION | string | "0.16.0" |
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. |
Fetch Apache Airavata API versionstring
getAPIVersion(security_model.AuthzToken
authzToken) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Register a Gateway with Airavata. @param gateway The gateway data model. @return gatewayId Th unique identifier of the newly registered gateway.string
addGateway(security_model.AuthzToken
authzToken,workspace_model.Gateway
gateway) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Update previously registered Gateway metadata. @param gatewayId The gateway Id of the Gateway which require an update. @return gateway Modified gateway obejct. @exception AiravataClientExceptionvoid
updateGateway(security_model.AuthzToken
authzToken,string
gatewayId,workspace_model.Gateway
updatedGateway) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Get Gateway details by providing gatewayId @param gatewayId The gateway Id of the Gateway. @return gateway Gateway obejct.workspace_model.Gateway
getGateway(security_model.AuthzToken
authzToken,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Delete a Gateway @param gatewayId The gateway Id of the Gateway to be deleted. @return boolean Boolean identifier for the success or failure of the deletion operation.bool
deleteGateway(security_model.AuthzToken
authzToken,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Get All the Gateways Connected to Airavata.list<
getAllGateways(workspace_model.Gateway
>security_model.AuthzToken
authzToken) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Check for the Existance of a Gateway within Airavata @param gatewayId Provide the gatewayId of the gateway you want to check the existancy @return boolean Boolean idetifier for the existance or non-existane of the gatewayId @return gatewayId return the gatewayId of the existing gateway.bool
isGatewayExist(security_model.AuthzToken
authzToken,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Generate and Register SSH Key Pair with Airavata Credential Store. @param gatewayId The identifier for the requested Gateway. @param userName The User for which the credential should be registered. For community accounts, this user is the name of the community user name. For computational resources, this user name need not be the same user name on resoruces. @return airavataCredStoreToken An SSH Key pair is generated and stored in the credential store and associated with users or community account belonging to a Gateway.string
generateAndRegisterSSHKeys(security_model.AuthzToken
authzToken,string
gatewayId,string
userName) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
Get a Public Key by Providing the Token @param CredStoreToken Credential Store Token which you want to find the Public Key for. @param gatewayId This is the unique identifier of your gateway where the token and public key was generated from. @return publicKeystring
getSSHPubKey(security_model.AuthzToken
authzToken,string
airavataCredStoreToken,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
Get a Public Key by Providing the Token @param CredStoreToken Credential Store Token which you want to find the Public Key for. @param gatewayId This is the unique identifier of your gateway where the token and public key was generated from. @return SSHpubKeymap<
getAllUserSSHPubKeys(string
,string
>security_model.AuthzToken
authzToken,string
userName) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
Get all Public Keys of the Gateway @param CredStoreToken Credential Store Token which you want to find the Public Key for. @param gatewayId This is the unique identifier of your gateway where the token and public key was generated from. @return publicKeymap<
getAllGatewaySSHPubKeys(string
,string
>security_model.AuthzToken
authzToken,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
Delete a Gateway @param gatewayId The gateway Id of the Gateway to be deleted. @return boolean Boolean identifier for the success or failure of the deletion operation.bool
deleteSSHPubKey(security_model.AuthzToken
authzToken,string
airavataCredStoreToken,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
Creates a Project with basic metadata. A Project is a container of experiments. @param gatewayId The identifier for the requested gateway. @param Project The Project Object described in the workspace_modelstring
createProject(security_model.AuthzToken
authzToken,string
gatewayId,workspace_model.Project
project) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Update an Existing Project @param projectId The projectId of the project needed an update. @return void Currently this does not return any value.void
updateProject(security_model.AuthzToken
authzToken,string
projectId,workspace_model.Project
updatedProject) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.ProjectNotFoundException
,airavata_errors.AuthorizationException
Get a Project by ID This method is to obtain a project by providing a projectId @param projectId projectId of the project you require @return project project data model will be returnedworkspace_model.Project
getProject(security_model.AuthzToken
authzToken,string
projectId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.ProjectNotFoundException
,airavata_errors.AuthorizationException
Delete a Project This method is used to delete an existing Project @param projectId projectId of the project you want to delete @return boolean Boolean identifier for the success or failure of the deletion operation.bool
deleteProject(security_model.AuthzToken
authzToken,string
projectId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.ProjectNotFoundException
,airavata_errors.AuthorizationException
Get all Project by user with pagination. Results will be ordered based on creation time DESC @param gatewayId The identifier for the requested gateway. @param userName The identifier of the user @param limit The amount results to be fetched @param offset The starting point of the results to be fetchedlist<
getUserProjects(workspace_model.Project
>security_model.AuthzToken
authzToken,string
gatewayId,string
userName,i32
limit,i32
offset) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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. @param userName The identifier of the user @param projectName The name of the project on which the results to be fetched @param limit The amount results to be fetched @param offset The starting point of the results to be fetchedlist<
searchProjectsByProjectName(workspace_model.Project
>security_model.AuthzToken
authzToken,string
gatewayId,string
userName,string
projectName,i32
limit,i32
offset) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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. @param userName The identifier of the user @param description The description to be matched @param limit The amount results to be fetched @param offset The starting point of the results to be fetchedlist<
searchProjectsByProjectDesc(workspace_model.Project
>security_model.AuthzToken
authzToken,string
gatewayId,string
userName,string
description,i32
limit,i32
offset) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Search Experiments by experiment name with pagination. Results will be sorted based on creation time DESC @param gatewayId Identifier of the requested gateway @param userName Username of the requested user @param expName Experiment name to be matched @param limit Amount of results to be fetched @param offset The starting point of the results to be fetchedlist<
searchExperimentsByName(experiment_model.ExperimentSummaryModel
>security_model.AuthzToken
authzToken,string
gatewayId,string
userName,string
expName,i32
limit,i32
offset) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Search Experiments by experiment name with pagination. Results will be sorted based on creation time DESC @param gatewayId Identifier of the requested gateway @param userName Username of the requested user @param description Experiment description to be matched @param limit Amount of results to be fetched @param offset The starting point of the results to be fetchedlist<
searchExperimentsByDesc(experiment_model.ExperimentSummaryModel
>security_model.AuthzToken
authzToken,string
gatewayId,string
userName,string
description,i32
limit,i32
offset) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Search Experiments by application id with pagination. Results will be sorted based on creation time DESC @param gatewayId Identifier of the requested gateway @param userName Username of the requested user @param applicationId Application id to be matched @param limit Amount of results to be fetched @param offset The starting point of the results to be fetchedlist<
searchExperimentsByApplication(experiment_model.ExperimentSummaryModel
>security_model.AuthzToken
authzToken,string
gatewayId,string
userName,string
applicationId,i32
limit,i32
offset) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Search Experiments by experiment status with pagination. Results will be sorted based on creation time DESC @param gatewayId Identifier of the requested gateway @param userName Username of the requested user @param experimentState Experiement state to be matched @param limit Amount of results to be fetched @param offset The starting point of the results to be fetchedlist<
searchExperimentsByStatus(experiment_model.ExperimentSummaryModel
>security_model.AuthzToken
authzToken,string
gatewayId,string
userName,status_models.ExperimentState
experimentState,i32
limit,i32
offset) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Search Experiments by experiment creation time with pagination. Results will be sorted based on creation time DESC @param gatewayId Identifier of the requested gateway @param userName Username of the requested user @param fromTime Start time of the experiments creation time @param toTime End time of the experiement creation time @param limit Amount of results to be fetched @param offset The starting point of the results to be fetchedlist<
searchExperimentsByCreationTime(experiment_model.ExperimentSummaryModel
>security_model.AuthzToken
authzToken,string
gatewayId,string
userName,i64
fromTime,i64
toTime,i32
limit,i32
offset) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Search Experiments by using multiple filter criteria with pagination. Results will be sorted based on creation time DESC @param gatewayId Identifier of the requested gateway @param userName Username of the requested user @param filters map of multiple filter criteria. @param limit Amount of results to be fetched @param offset The starting point of the results to be fetchedlist<
searchExperiments(experiment_model.ExperimentSummaryModel
>security_model.AuthzToken
authzToken,string
gatewayId,string
userName,map<
filters,experiment_model.ExperimentSearchFields
,string
>i32
limit,i32
offset) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Get Experiment Statisitics for the given gateway for a specific time period @param gatewayId Identifier of the requested gateway @param fromTime Starting date time @param toTime Ending data timeexperiment_model.ExperimentStatistics
getExperimentStatistics(security_model.AuthzToken
authzToken,string
gatewayId,i64
fromTime,i64
toTime) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Get Experiments within project with pagination. Results will be sorted based on creation time DESC @param projectId Identifier of the project @param limit Amount of results to be fetched @param offset The starting point of the results to be fetchedlist<
getExperimentsInProject(experiment_model.ExperimentModel
>security_model.AuthzToken
authzToken,string
projectId,i32
limit,i32
offset) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.ProjectNotFoundException
,airavata_errors.AuthorizationException
Get experiments by user with pagination. Results will be sorted based on creation time DESC @param gatewayId Identifier of the requesting gateway @param userName Username of the requested user @param limit Amount of results to be fetched @param offset The starting point of the results to be fetchedlist<
getUserExperiments(experiment_model.ExperimentModel
>security_model.AuthzToken
authzToken,string
gatewayId,string
userName,i32
limit,i32
offset) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
* 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 * The create experiment will require the basic experiment metadata like the name and description, intended user, * the gateway identifer and if the experiment should be shared public by defualt. During the creation of an experiment * the ExperimentMetadata is a required field. * * @return * The server-side generated.airavata.registry.core.experiment.globally unique identifier. * * @throws org.apache.airavata.model.error.InvalidRequestException * For any incorrect forming of the request itself. * * @throws org.apache.airavata.model.error.AiravataClientException * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: * * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative * step, then Airavata Registry will not have a provenance area setup. The client has to follow * gateway registration steps and retry this request. * * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. * For now this is a place holder. * * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake * is implemented, the authorization will be more substantial. * * @throws org.apache.airavata.model.error.AiravataSystemException * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client * rather an Airavata Administrator will be notified to take corrective action. * *string
createExperiment(security_model.AuthzToken
authzToken,string
gatewayId,experiment_model.ExperimentModel
experiment) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Delete an Experiment If the experiment is not already launched experiment can be deleted. @param authzToken @param experiementId Experiment ID of the experimnet you want to delete. @return boolean Identifier for the success or failure of the deletion operationbool
deleteExperiment(security_model.AuthzToken
authzToken,string
experimentId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
* 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. * *experiment_model.ExperimentModel
getExperiment(security_model.AuthzToken
authzToken,string
airavataExperimentId) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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. @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.experiment_model.ExperimentModel
getDetailedExperimentTree(security_model.AuthzToken
authzToken,string
airavataExperimentId) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
airavataExperimentId,experiment_model.ExperimentModel
experiment) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
void
updateExperimentConfiguration(security_model.AuthzToken
authzToken,string
airavataExperimentId,experiment_model.UserConfigurationDataModel
userConfiguration) throwsairavata_errors.AuthorizationException
void
updateResourceScheduleing(security_model.AuthzToken
authzToken,string
airavataExperimentId,scheduling_model.ComputationalResourceSchedulingModel
resourceScheduling) throwsairavata_errors.AuthorizationException
* * Validate experiment configuration. A true in general indicates, the experiment is ready to be launched. * * @param experimentId * * * @return boolean * Identifier for the success or failure of the validation operation * *bool
validateExperiment(security_model.AuthzToken
authzToken,string
airavataExperimentId) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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. @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(security_model.AuthzToken
authzToken,string
airavataExperimentId,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Get Experiment Status Obtain the status os an experiment by providing the Experiment Id @param authzToken @param experiementId Experiment ID of the experimnet you require the status @return ExperimentStatus ExperimentStatus model with current status will be returned.status_models.ExperimentStatus
getExperimentStatus(security_model.AuthzToken
authzToken,string
airavataExperimentId) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Get Experiment Outputs This method to be used when need to obtain outputs of a certain Experiment @param authzToken @param experiementId 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 experimentlist<
getExperimentOutputs(application_io_models.OutputDataObjectType
>security_model.AuthzToken
authzToken,string
airavataExperimentId) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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 @return list List of intermediate experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experimentlist<
getIntermediateOutputs(application_io_models.OutputDataObjectType
>security_model.AuthzToken
authzToken,string
airavataExperimentId) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Get Job Status 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 @return JobStatus Job status (string) for all all the existing jobs for the experiment will be returned in the form of a mapmap<
getJobStatuses(string
,status_models.JobStatus
>security_model.AuthzToken
authzToken,string
airavataExperimentId) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Get Job Details for all the jobs within an Experiment This method to be used when need to get the job details for one or many jobs of an Experiment. @param authzToken @param experiementId Experiment ID of the experimnet you need job details @return list of JobDetails Job detailslist<
getJobDetails(job_model.JobModel
>security_model.AuthzToken
authzToken,string
airavataExperimentId) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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.registry.core.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(security_model.AuthzToken
authzToken,string
existingExperimentID,string
newExperimentName) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
airavataExperimentId,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.ExperimentNotFoundException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
gatewayId,application_deployment_model.ApplicationModule
applicationModule) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch a Application Module. @param appModuleId The identifier for the requested application module @return applicationModule Returns a application Module Object.application_deployment_model.ApplicationModule
getApplicationModule(security_model.AuthzToken
authzToken,string
appModuleId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
appModuleId,application_deployment_model.ApplicationModule
applicationModule) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
list<
getAllAppModules(application_deployment_model.ApplicationModule
>security_model.AuthzToken
authzToken,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
appModuleId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
gatewayId,application_deployment_model.ApplicationDeploymentDescription
applicationDeployment) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch a Application Deployment. @param appDeploymentId The identifier for the requested application module @return applicationDeployment Returns a application Deployment Object.application_deployment_model.ApplicationDeploymentDescription
getApplicationDeployment(security_model.AuthzToken
authzToken,string
appDeploymentId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
appDeploymentId,application_deployment_model.ApplicationDeploymentDescription
applicationDeployment) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
appDeploymentId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch all Application Deployment Descriptions. @return list<applicationDeployment. Returns the list of all application Deployment Objects. >list<
getAllApplicationDeployments(application_deployment_model.ApplicationDeploymentDescription
>security_model.AuthzToken
authzToken,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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<
getAppModuleDeployedResources(string
>security_model.AuthzToken
authzToken,string
appModuleId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
gatewayId,application_interface_model.ApplicationInterfaceDescription
applicationInterface) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch a Application Interface. @param appInterfaceId The identifier for the requested application module @return applicationInterface Returns a application Interface Object.application_interface_model.ApplicationInterfaceDescription
getApplicationInterface(security_model.AuthzToken
authzToken,string
appInterfaceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
appInterfaceId,application_interface_model.ApplicationInterfaceDescription
applicationInterface) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
appInterfaceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch name and id of Application Interface documents. @return map<applicationId, applicationInterfaceNames> Returns a list of application interfaces with corresponsing id'smap<
getAllApplicationInterfaceNames(string
,string
>security_model.AuthzToken
authzToken,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch all Application Interface documents. @return map<applicationId, applicationInterfaceNames> Returns a list of application interfaces documentslist<
getAllApplicationInterfaces(application_interface_model.ApplicationInterfaceDescription
>security_model.AuthzToken
authzToken,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch the list of Application Inputs. @param appInterfaceId The identifier for the requested application interface @return list<application_interface_model.InputDataObjectType> Returns a list of application inputs.list<
getApplicationInputs(application_io_models.InputDataObjectType
>security_model.AuthzToken
authzToken,string
appInterfaceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch the list of Application Outputs. @param appInterfaceId The identifier for the requested application interface @return list<application_interface_model.OutputDataObjectType> Returns a list of application outputs.list<
getApplicationOutputs(application_io_models.OutputDataObjectType
>security_model.AuthzToken
authzToken,string
appInterfaceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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<
getAvailableAppInterfaceComputeResources(string
,string
>security_model.AuthzToken
authzToken,string
appInterfaceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,compute_resource_model.ComputeResourceDescription
computeResourceDescription) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch the given Compute Resource. @param computeResourceId The identifier for the requested compute resource @return computeResourceDescription Compute Resource Object created from the datamodel..compute_resource_model.ComputeResourceDescription
getComputeResource(security_model.AuthzToken
authzToken,string
computeResourceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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<
getAllComputeResourceNames(string
,string
>security_model.AuthzToken
authzToken) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
computeResourceId,compute_resource_model.ComputeResourceDescription
computeResourceDescription) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
computeResourceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Register a Storage Resource. @param storageResourceDescription Storge Resource Object created from the datamodel. @return storageResourceId Returns a server-side generated airavata storage resource globally unique identifier.string
registerStorageResource(security_model.AuthzToken
authzToken,storage_resource_model.StorageResourceDescription
storageResourceDescription) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch the given Storage Resource. @param storageResourceId The identifier for the requested storage resource @return storageResourceDescription Storage Resource Object created from the datamodel..storage_resource_model.StorageResourceDescription
getStorageResource(security_model.AuthzToken
authzToken,string
storageResourceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch all registered Storage Resources. @return A map of registered compute resource id's and thier corresponding hostnames. Compute Resource Object created from the datamodel..map<
getAllStorageResourceNames(string
,string
>security_model.AuthzToken
authzToken) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Update a Compute Resource. @param storageResourceId The identifier for the requested compute resource to be updated. @param storageResourceDescription Storage Resource Object created from the datamodel. @return status Returns a success/failure of the update.bool
updateStorageResource(security_model.AuthzToken
authzToken,string
storageResourceId,storage_resource_model.StorageResourceDescription
storageResourceDescription) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Delete a Storage Resource. @param storageResourceId The identifier for the requested compute resource to be deleted. @return status Returns a success/failure of the deletion.bool
deleteStorageResource(security_model.AuthzToken
authzToken,string
storageResourceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Add a Local Job Submission details to a compute resource App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. @param computeResourceId The identifier of the compute resource to which JobSubmission protocol to be added @param priorityOrder Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. @param localSubmission The LOCALSubmission object to be added to the resource. @return status Returns the unique job submission id.string
addLocalSubmissionDetails(security_model.AuthzToken
authzToken,string
computeResourceId,i32
priorityOrder,compute_resource_model.LOCALSubmission
localSubmission) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
jobSubmissionInterfaceId,compute_resource_model.LOCALSubmission
localSubmission) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
This method returns localJobSubmission object @param jobSubmissionInterfaceId The identifier of the JobSubmission Interface to be retrieved. @return LOCALSubmission instancecompute_resource_model.LOCALSubmission
getLocalJobSubmission(security_model.AuthzToken
authzToken,string
jobSubmissionId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Add a SSH Job Submission details to a compute resource App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. @param computeResourceId The identifier of the compute resource to which JobSubmission protocol to be added @param priorityOrder Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. @param sshJobSubmission The SSHJobSubmission object to be added to the resource. @return status Returns the unique job submission id.string
addSSHJobSubmissionDetails(security_model.AuthzToken
authzToken,string
computeResourceId,i32
priorityOrder,compute_resource_model.SSHJobSubmission
sshJobSubmission) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Add a SSH_FORK Job Submission details to a compute resource App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. @param computeResourceId The identifier of the compute resource to which JobSubmission protocol to be added @param priorityOrder Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. @param sshJobSubmission The SSHJobSubmission object to be added to the resource. @return status Returns the unique job submission id.string
addSSHForkJobSubmissionDetails(security_model.AuthzToken
authzToken,string
computeResourceId,i32
priorityOrder,compute_resource_model.SSHJobSubmission
sshJobSubmission) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
This method returns SSHJobSubmission object @param jobSubmissionInterfaceId The identifier of the JobSubmission Interface to be retrieved. @return SSHJobSubmission instancecompute_resource_model.SSHJobSubmission
getSSHJobSubmission(security_model.AuthzToken
authzToken,string
jobSubmissionId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Add a UNICORE Job Submission details to a compute resource App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. @param computeResourceId The identifier of the compute resource to which JobSubmission protocol to be added @param priorityOrder Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. @param unicoreJobSubmission The UnicoreJobSubmission object to be added to the resource. @return status Returns the unique job submission id.string
addUNICOREJobSubmissionDetails(security_model.AuthzToken
authzToken,string
computeResourceId,i32
priorityOrder,compute_resource_model.UnicoreJobSubmission
unicoreJobSubmission) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
* This method returns UnicoreJobSubmission object * @param jobSubmissionInterfaceId * The identifier of the JobSubmission Interface to be retrieved. * @return UnicoreJobSubmission instance *compute_resource_model.UnicoreJobSubmission
getUnicoreJobSubmission(security_model.AuthzToken
authzToken,string
jobSubmissionId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
* Add a Cloud Job Submission details to a compute resource * App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. * * @param computeResourceId * The identifier of the compute resource to which JobSubmission protocol to be added * * @param priorityOrder * Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. * * @param sshJobSubmission * The SSHJobSubmission object to be added to the resource. * * @return status * Returns the unique job submission id. *string
addCloudJobSubmissionDetails(security_model.AuthzToken
authzToken,string
computeResourceId,i32
priorityOrder,compute_resource_model.CloudJobSubmission
cloudSubmission) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
* This method returns cloudJobSubmission object * @param jobSubmissionInterfaceI * The identifier of the JobSubmission Interface to be retrieved. * @return CloudJobSubmission instance *compute_resource_model.CloudJobSubmission
getCloudJobSubmission(security_model.AuthzToken
authzToken,string
jobSubmissionId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Update the given SSH Job Submission details @param jobSubmissionInterfaceId The identifier of the JobSubmission Interface to be updated. @param sshJobSubmission The SSHJobSubmission object to be updated. @return status Returns a success/failure of the update.bool
updateSSHJobSubmissionDetails(security_model.AuthzToken
authzToken,string
jobSubmissionInterfaceId,compute_resource_model.SSHJobSubmission
sshJobSubmission) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Update the cloud Job Submission details @param jobSubmissionInterfaceId The identifier of the JobSubmission Interface to be updated. @param cloudJobSubmission The CloudJobSubmission object to be updated. @return status Returns a success/failure of the update.bool
updateCloudJobSubmissionDetails(security_model.AuthzToken
authzToken,string
jobSubmissionInterfaceId,compute_resource_model.CloudJobSubmission
sshJobSubmission) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Update the UNIOCRE Job Submission details @param jobSubmissionInterfaceId The identifier of the JobSubmission Interface to be updated. @param UnicoreJobSubmission The UnicoreJobSubmission object to be updated. @return status Returns a success/failure of the update.bool
updateUnicoreJobSubmissionDetails(security_model.AuthzToken
authzToken,string
jobSubmissionInterfaceId,compute_resource_model.UnicoreJobSubmission
unicoreJobSubmission) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Add a Local data movement details to a compute resource App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. @param resourceId The identifier of the compute resource to which JobSubmission protocol to be added @param DMType DMType object to be added to the resource. @param priorityOrder Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. @param localDataMovement The LOCALDataMovement object to be added to the resource. @return status Returns the unique job submission id.string
addLocalDataMovementDetails(security_model.AuthzToken
authzToken,string
resourceId,data_movement_models.DMType
dataMoveType,i32
priorityOrder,data_movement_models.LOCALDataMovement
localDataMovement) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Update the given Local data movement details @param dataMovementInterfaceId The identifier of the data movement Interface to be updated. @param localDataMovement The LOCALDataMovement object to be updated. @return status Returns a success/failure of the update.bool
updateLocalDataMovementDetails(security_model.AuthzToken
authzToken,string
dataMovementInterfaceId,data_movement_models.LOCALDataMovement
localDataMovement) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
This method returns local datamovement object @param dataMovementId The identifier of the datamovement Interface to be retrieved. @return LOCALDataMovement instancedata_movement_models.LOCALDataMovement
getLocalDataMovement(security_model.AuthzToken
authzToken,string
dataMovementId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Add a SCP data movement details to a compute resource App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. @param resourceId The identifier of the compute resource to which JobSubmission protocol to be added @param priorityOrder Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. @param scpDataMovement The SCPDataMovement object to be added to the resource. @return status Returns the unique job submission id.string
addSCPDataMovementDetails(security_model.AuthzToken
authzToken,string
resourceId,data_movement_models.DMType
dataMoveType,i32
priorityOrder,data_movement_models.SCPDataMovement
scpDataMovement) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Update the given scp data movement details App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. @param dataMovementInterfaceId The identifier of the data movement Interface to be updated. @param scpDataMovement The SCPDataMovement object to be updated. @return status Returns a success/failure of the update.bool
updateSCPDataMovementDetails(security_model.AuthzToken
authzToken,string
dataMovementInterfaceId,data_movement_models.SCPDataMovement
scpDataMovement) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
This method returns SCP datamovement object @param dataMovementId The identifier of the datamovement Interface to be retrieved. @return SCPDataMovement instancedata_movement_models.SCPDataMovement
getSCPDataMovement(security_model.AuthzToken
authzToken,string
dataMovementId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Add a UNICORE data movement details to a compute resource App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. @param resourceId The identifier of the compute resource to which data movement protocol to be added @param priorityOrder Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. @param UnicoreDataMovement The UnicoreDataMovement object to be added to the resource. @return status Returns the unique data movement id.string
addUnicoreDataMovementDetails(security_model.AuthzToken
authzToken,string
resourceId,data_movement_models.DMType
dataMoveType,i32
priorityOrder,data_movement_models.UnicoreDataMovement
unicoreDataMovement) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Update a selected UNICORE data movement details App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. @param dataMovementInterfaceId The identifier of the data movement Interface to be updated. @param UnicoreDataMovement The UnicoreDataMovement object to be updated. @return status Returns a success/failure of the update.bool
updateUnicoreDataMovementDetails(security_model.AuthzToken
authzToken,string
dataMovementInterfaceId,data_movement_models.UnicoreDataMovement
unicoreDataMovement) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
This method returns UNICORE datamovement object @param dataMovementId The identifier of the datamovement Interface to be retrieved. @return UnicoreDataMovement instancedata_movement_models.UnicoreDataMovement
getUnicoreDataMovement(security_model.AuthzToken
authzToken,string
dataMovementId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Add a GridFTP data movement details to a compute resource App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. @param resourceId The identifier of the compute resource to which dataMovement protocol to be added @param DMType The DMType object to be added to the resource. @param priorityOrder Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero. @param gridFTPDataMovement The GridFTPDataMovement object to be added to the resource. @return status Returns the unique data movement id.string
addGridFTPDataMovementDetails(security_model.AuthzToken
authzToken,string
resourceId,data_movement_models.DMType
dataMoveType,i32
priorityOrder,data_movement_models.GridFTPDataMovement
gridFTPDataMovement) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Update the given GridFTP data movement details to a compute resource App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. @param dataMovementInterfaceId The identifier of the data movement Interface to be updated. @param gridFTPDataMovement The GridFTPDataMovement object to be updated. @return boolean Returns a success/failure of the update.bool
updateGridFTPDataMovementDetails(security_model.AuthzToken
authzToken,string
dataMovementInterfaceId,data_movement_models.GridFTPDataMovement
gridFTPDataMovement) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
This method returns GridFTP datamovement object @param dataMovementId The identifier of the datamovement Interface to be retrieved. @return GridFTPDataMovement instancedata_movement_models.GridFTPDataMovement
getGridFTPDataMovement(security_model.AuthzToken
authzToken,string
dataMovementId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
jobSubmissionInterfaceId,i32
newPriorityOrder) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
dataMovementInterfaceId,i32
newPriorityOrder) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,map<
jobSubmissionPriorityMap) throwsstring
,i32
>airavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,map<
dataMovementPriorityMap) throwsstring
,i32
>airavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
computeResourceId,string
jobSubmissionInterfaceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
computeResourceId,string
dataMovementInterfaceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
string
registerResourceJobManager(security_model.AuthzToken
authzToken,compute_resource_model.ResourceJobManager
resourceJobManager) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
bool
updateResourceJobManager(security_model.AuthzToken
authzToken,string
resourceJobManagerId,compute_resource_model.ResourceJobManager
updatedResourceJobManager) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
compute_resource_model.ResourceJobManager
getResourceJobManager(security_model.AuthzToken
authzToken,string
resourceJobManagerId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
bool
deleteResourceJobManager(security_model.AuthzToken
authzToken,string
resourceJobManagerId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Delete a Compute Resource Queue @param computeResourceId The identifier of the compute resource which has the queue to be deleted @param queueName Name of the queue need to be deleted. Name is the uniqueue identifier for the queue within a compute resource @return status Returns a success/failure of the deletion.bool
deleteBatchQueue(security_model.AuthzToken
authzToken,string
computeResourceId,string
queueName) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,gateway_resource_profile_model.GatewayResourceProfile
gatewayResourceProfile) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch the given Gateway Resource Profile. @param gatewayID The identifier for the requested gateway resource @return gatewayResourceProfile Gateway Resource Profile Object.gateway_resource_profile_model.GatewayResourceProfile
getGatewayResourceProfile(security_model.AuthzToken
authzToken,string
gatewayID) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
gatewayID,gateway_resource_profile_model.GatewayResourceProfile
gatewayResourceProfile) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
gatewayID) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
gatewayID,string
computeResourceId,gateway_resource_profile_model.ComputeResourcePreference
computeResourcePreference) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
bool
addGatewayStoragePreference(security_model.AuthzToken
authzToken,string
gatewayID,string
storageResourceId,gateway_resource_profile_model.StoragePreference
storagePreference) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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.gateway_resource_profile_model.ComputeResourcePreference
getGatewayComputeResourcePreference(security_model.AuthzToken
authzToken,string
gatewayID,string
computeResourceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
gateway_resource_profile_model.StoragePreference
getGatewayStoragePreference(security_model.AuthzToken
authzToken,string
gatewayID,string
storageResourceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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<
getAllGatewayComputeResourcePreferences(gateway_resource_profile_model.ComputeResourcePreference
>security_model.AuthzToken
authzToken,string
gatewayID) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
list<
getAllGatewayStoragePreferences(gateway_resource_profile_model.StoragePreference
>security_model.AuthzToken
authzToken,string
gatewayID) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
Fetch all gateway profiles registeredlist<
getAllGatewayResourceProfiles(gateway_resource_profile_model.GatewayResourceProfile
>security_model.AuthzToken
authzToken) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
gatewayID,string
computeResourceId,gateway_resource_profile_model.ComputeResourcePreference
computeResourcePreference) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
bool
updateGatewayStoragePreference(security_model.AuthzToken
authzToken,string
gatewayID,string
storageId,gateway_resource_profile_model.StoragePreference
storagePreference) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
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(security_model.AuthzToken
authzToken,string
gatewayID,string
computeResourceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
bool
deleteGatewayStoragePreference(security_model.AuthzToken
authzToken,string
gatewayID,string
storageId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
list<
getAllWorkflows(string
>security_model.AuthzToken
authzToken,string
gatewayId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
workflow_data_model.Workflow
getWorkflow(security_model.AuthzToken
authzToken,string
workflowTemplateId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
void
deleteWorkflow(security_model.AuthzToken
authzToken,string
workflowTemplateId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
string
registerWorkflow(security_model.AuthzToken
authzToken,string
gatewayId,workflow_data_model.Workflow
workflow) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
void
updateWorkflow(security_model.AuthzToken
authzToken,string
workflowTemplateId,workflow_data_model.Workflow
workflow) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
string
getWorkflowTemplateId(security_model.AuthzToken
authzToken,string
workflowName) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
bool
isWorkflowExistWithName(security_model.AuthzToken
authzToken,string
workflowName) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
* Data Manager Related API Methods *string
registerDataResource(security_model.AuthzToken
authzToken,replica_catalog_models.DataResourceModel
dataResourceModel) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
void
updateDataResource(security_model.AuthzToken
authzToken,replica_catalog_models.DataResourceModel
dataResourceModel) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
void
removeDataResource(security_model.AuthzToken
authzToken,string
resourceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
replica_catalog_models.DataResourceModel
getDataResource(security_model.AuthzToken
authzToken,string
resourceId) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
string
copyDataResource(security_model.AuthzToken
authzToken,string
resourceId,string
destStorageResourceId,string
destinationParentPath) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException
string
copyDataReplica(security_model.AuthzToken
authzToken,string
resourceId,string
replicaId,string
destStorageResourceId,string
destinationParentPath) throwsairavata_errors.InvalidRequestException
,airavata_errors.AiravataClientException
,airavata_errors.AiravataSystemException
,airavata_errors.AuthorizationException