http://git-wip-us.apache.org/repos/asf/airavata/blob/36da4ee4/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/Airavata_server.skeleton.cpp ---------------------------------------------------------------------- diff --git a/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/Airavata_server.skeleton.cpp b/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/Airavata_server.skeleton.cpp index aabc232..4be84d3 100644 --- a/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/Airavata_server.skeleton.cpp +++ b/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/Airavata_server.skeleton.cpp @@ -78,6 +78,8 @@ class AiravataHandler : virtual public AiravataIf { * @return gateway * Modified gateway obejct. * + * @exception AiravataClientException + * * * * @param authzToken @@ -138,6 +140,23 @@ class AiravataHandler : virtual public AiravataIf { printf("getAllGateways\n"); } + /** + * 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. + * + * + * + * @param authzToken + * @param gatewayId + */ bool isGatewayExist(const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& gatewayId) { // Your implementation goes here printf("isGatewayExist\n"); @@ -232,6 +251,21 @@ class AiravataHandler : virtual public AiravataIf { printf("getAllGatewaySSHPubKeys\n"); } + /** + * 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. + * + * + * + * @param authzToken + * @param airavataCredStoreToken + * @param gatewayId + */ bool deleteSSHPubKey(const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& airavataCredStoreToken, const std::string& gatewayId) { // Your implementation goes here printf("deleteSSHPubKey\n"); @@ -248,6 +282,7 @@ class AiravataHandler : virtual public AiravataIf { * The Project Object described in the workspace_model * * + * * @param authzToken * @param gatewayId * @param project @@ -258,7 +293,14 @@ class AiravataHandler : virtual public AiravataIf { } /** - * Update a Project + * Update an Existing Project + * + * @param projectId + * The projectId of the project needed an update. + * + * @return void + * Currently this does not return any value. + * * * * @param authzToken @@ -272,6 +314,14 @@ class AiravataHandler : virtual public AiravataIf { /** * Get a Project by ID + * This method is to obtain a project by providing a projectId + * + * @param projectId + * projectId of the project you require + * + * @return project + * project data model will be returned + * * * * @param authzToken @@ -282,24 +332,43 @@ class AiravataHandler : virtual public AiravataIf { printf("getProject\n"); } + /** + * 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. + * + * + * + * @param authzToken + * @param projectId + */ bool deleteProject(const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& projectId) { // Your implementation goes here printf("deleteProject\n"); } /** - * * 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 fetched - * * + * 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 fetched + * + * * * @param authzToken * @param gatewayId @@ -327,6 +396,7 @@ class AiravataHandler : virtual public AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param authzToken * @param gatewayId * @param userName @@ -354,6 +424,7 @@ class AiravataHandler : virtual public AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param authzToken * @param gatewayId * @param userName @@ -381,6 +452,7 @@ class AiravataHandler : virtual public AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param authzToken * @param gatewayId * @param userName @@ -408,6 +480,7 @@ class AiravataHandler : virtual public AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param authzToken * @param gatewayId * @param userName @@ -435,6 +508,7 @@ class AiravataHandler : virtual public AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param authzToken * @param gatewayId * @param userName @@ -462,6 +536,7 @@ class AiravataHandler : virtual public AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param authzToken * @param gatewayId * @param userName @@ -491,6 +566,7 @@ class AiravataHandler : virtual public AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param authzToken * @param gatewayId * @param userName @@ -519,6 +595,7 @@ class AiravataHandler : virtual public AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param authzToken * @param gatewayId * @param userName @@ -562,6 +639,7 @@ class AiravataHandler : virtual public AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param authzToken * @param projectId * @param limit @@ -585,6 +663,7 @@ class AiravataHandler : virtual public AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param authzToken * @param gatewayId * @param userName @@ -597,39 +676,40 @@ class AiravataHandler : virtual public AiravataIf { } /** - * 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. - * + * * 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. + * * + * * * * @param authzToken * @param gatewayId @@ -641,12 +721,18 @@ class AiravataHandler : virtual public AiravataIf { } /** + * Delete an Experiment + * * If the experiment is not already launched experiment can be deleted. * * @param authzToken + * * @param experiementId + * Experiment ID of the experimnet you want to delete. + * + * @return boolean + * Identifier for the success or failure of the deletion operation * - * @return boolean identifier for the success or failure of the deletion operation * * * @param authzToken @@ -658,37 +744,38 @@ class AiravataHandler : virtual public AiravataIf { } /** - * 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. - * + * * 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. + * * + * * * * @param authzToken * @param airavataExperimentId @@ -802,8 +889,11 @@ class AiravataHandler : virtual public AiravataIf { * * * * Validate experiment configuration. A true in general indicates, the experiment is ready to be launched. * * - * * @param experimentID - * * @return sucess/failure + * * @param experimentId + * * + * * + * * @return boolean + * * Identifier for the success or failure of the validation operation * * * * * @@ -858,26 +948,112 @@ class AiravataHandler : virtual public AiravataIf { printf("launchExperiment\n"); } + /** + * 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. + * + * + * + * @param authzToken + * @param airavataExperimentId + */ void getExperimentStatus( ::apache::airavata::model::status::ExperimentStatus& _return, const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& airavataExperimentId) { // Your implementation goes here printf("getExperimentStatus\n"); } + /** + * 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 experiment + * + * + * + * @param authzToken + * @param airavataExperimentId + */ void getExperimentOutputs(std::vector< ::apache::airavata::model::application::io::OutputDataObjectType> & _return, const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& airavataExperimentId) { // Your implementation goes here printf("getExperimentOutputs\n"); } + /** + * 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 experiment + * + * + * + * @param authzToken + * @param airavataExperimentId + */ void getIntermediateOutputs(std::vector< ::apache::airavata::model::application::io::OutputDataObjectType> & _return, const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& airavataExperimentId) { // Your implementation goes here printf("getIntermediateOutputs\n"); } + /** + * 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 map + * + * + * + * @param authzToken + * @param airavataExperimentId + */ void getJobStatuses(std::map<std::string, ::apache::airavata::model::status::JobStatus> & _return, const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& airavataExperimentId) { // Your implementation goes here printf("getJobStatuses\n"); } + /** + * Get Job Details for all the jobs within an Experiment + * This method to be used when need to get the job details for one or many jobs of an Experiment. + * + * @param authzToken + * + * @param experiementId + * Experiment ID of the experimnet you need job details + * + * @return list of JobDetails + * Job details + * + * + * + * @param authzToken + * @param airavataExperimentId + */ void getJobDetails(std::vector< ::apache::airavata::model::job::JobModel> & _return, const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& airavataExperimentId) { // Your implementation goes here printf("getJobDetails\n"); @@ -1739,7 +1915,7 @@ class AiravataHandler : virtual public AiravataIf { * The SSHJobSubmission object to be updated. * * @return status - * Returns a success/failure of the deletion. + * Returns a success/failure of the update. * * * @param authzToken @@ -1761,7 +1937,7 @@ class AiravataHandler : virtual public AiravataIf { * The CloudJobSubmission object to be updated. * * @return status - * Returns a success/failure of the deletion. + * Returns a success/failure of the update. * * * @param authzToken @@ -1773,6 +1949,24 @@ class AiravataHandler : virtual public AiravataIf { printf("updateCloudJobSubmissionDetails\n"); } + /** + * 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. + * + * + * + * @param authzToken + * @param jobSubmissionInterfaceId + * @param unicoreJobSubmission + */ bool updateUnicoreJobSubmissionDetails(const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& jobSubmissionInterfaceId, const ::apache::airavata::model::appcatalog::computeresource::UnicoreJobSubmission& unicoreJobSubmission) { // Your implementation goes here printf("updateUnicoreJobSubmissionDetails\n"); @@ -1782,9 +1976,12 @@ class AiravataHandler : virtual public AiravataIf { * 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 + * @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. * @@ -1795,6 +1992,7 @@ class AiravataHandler : virtual public AiravataIf { * Returns the unique job submission id. * * + * * @param authzToken * @param resourceId * @param dataMoveType @@ -1819,6 +2017,7 @@ class AiravataHandler : virtual public AiravataIf { * Returns a success/failure of the update. * * + * * @param authzToken * @param dataMovementInterfaceId * @param localDataMovement @@ -1829,11 +2028,14 @@ class AiravataHandler : virtual public AiravataIf { } /** - * * This method returns local datamovement object - * * @param dataMovementId - * * The identifier of the datamovement Interface to be retrieved. - * * @return LOCALDataMovement instance - * * + * This method returns local datamovement object + * + * @param dataMovementId + * The identifier of the datamovement Interface to be retrieved. + * + * @return LOCALDataMovement instance + * + * * * @param authzToken * @param dataMovementId @@ -1847,7 +2049,7 @@ class AiravataHandler : virtual public AiravataIf { * 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 + * @param resourceId * The identifier of the compute resource to which JobSubmission protocol to be added * * @param priorityOrder @@ -1895,11 +2097,14 @@ class AiravataHandler : virtual public AiravataIf { } /** - * * This method returns SCP datamovement object - * * @param dataMovementId - * * The identifier of the datamovement Interface to be retrieved. - * * @return SCPDataMovement instance - * * + * This method returns SCP datamovement object + * + * @param dataMovementId + * The identifier of the datamovement Interface to be retrieved. + * + * @return SCPDataMovement instance + * + * * * @param authzToken * @param dataMovementId @@ -1909,16 +2114,71 @@ class AiravataHandler : virtual public AiravataIf { printf("getSCPDataMovement\n"); } + /** + * 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. + * + * + * @param authzToken + * @param resourceId + * @param dataMoveType + * @param priorityOrder + * @param unicoreDataMovement + */ void addUnicoreDataMovementDetails(std::string& _return, const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& resourceId, const ::apache::airavata::model::data::movement::DMType::type dataMoveType, const int32_t priorityOrder, const ::apache::airavata::model::data::movement::UnicoreDataMovement& unicoreDataMovement) { // Your implementation goes here printf("addUnicoreDataMovementDetails\n"); } + /** + * 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. + * + * + * + * @param authzToken + * @param dataMovementInterfaceId + * @param unicoreDataMovement + */ bool updateUnicoreDataMovementDetails(const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& dataMovementInterfaceId, const ::apache::airavata::model::data::movement::UnicoreDataMovement& unicoreDataMovement) { // Your implementation goes here printf("updateUnicoreDataMovementDetails\n"); } + /** + * This method returns UNICORE datamovement object + * + * @param dataMovementId + * The identifier of the datamovement Interface to be retrieved. + * + * @return UnicoreDataMovement instance + * + * + * + * @param authzToken + * @param dataMovementId + */ void getUnicoreDataMovement( ::apache::airavata::model::data::movement::UnicoreDataMovement& _return, const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& dataMovementId) { // Your implementation goes here printf("getUnicoreDataMovement\n"); @@ -1928,8 +2188,11 @@ class AiravataHandler : virtual public AiravataIf { * 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 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. @@ -1938,7 +2201,8 @@ class AiravataHandler : virtual public AiravataIf { * The GridFTPDataMovement object to be added to the resource. * * @return status - * Returns the unique job submission id. + * Returns the unique data movement id. + * * * * @param authzToken @@ -1962,8 +2226,9 @@ class AiravataHandler : virtual public AiravataIf { * @param gridFTPDataMovement * The GridFTPDataMovement object to be updated. * - * @return status - * Returns a success/failure of the updation. + * @return boolean + * Returns a success/failure of the update. + * * * * @param authzToken @@ -1976,11 +2241,14 @@ class AiravataHandler : virtual public AiravataIf { } /** - * * This method returns GridFTP datamovement object - * * @param dataMovementId - * * The identifier of the datamovement Interface to be retrieved. - * * @return GridFTPDataMovement instance - * * + * This method returns GridFTP datamovement object + * + * @param dataMovementId + * The identifier of the datamovement Interface to be retrieved. + * + * @return GridFTPDataMovement instance + * + * * * @param authzToken * @param dataMovementId @@ -2003,6 +2271,7 @@ class AiravataHandler : virtual public AiravataIf { * Returns a success/failure of the change. * * + * * @param authzToken * @param jobSubmissionInterfaceId * @param newPriorityOrder @@ -2025,6 +2294,7 @@ class AiravataHandler : virtual public AiravataIf { * Returns a success/failure of the change. * * + * * @param authzToken * @param dataMovementInterfaceId * @param newPriorityOrder @@ -2062,6 +2332,7 @@ class AiravataHandler : virtual public AiravataIf { * Returns a success/failure of the changes. * * + * * @param authzToken * @param dataMovementPriorityMap */ @@ -2080,6 +2351,7 @@ class AiravataHandler : virtual public AiravataIf { * Returns a success/failure of the deletion. * * + * * @param authzToken * @param computeResourceId * @param jobSubmissionInterfaceId @@ -2099,6 +2371,7 @@ class AiravataHandler : virtual public AiravataIf { * Returns a success/failure of the deletion. * * + * * @param authzToken * @param computeResourceId * @param dataMovementInterfaceId @@ -2128,6 +2401,24 @@ class AiravataHandler : virtual public AiravataIf { printf("deleteResourceJobManager\n"); } + /** + * 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. + * + * + * + * @param authzToken + * @param computeResourceId + * @param queueName + */ bool deleteBatchQueue(const ::apache::airavata::model::security::AuthzToken& authzToken, const std::string& computeResourceId, const std::string& queueName) { // Your implementation goes here printf("deleteBatchQueue\n");
http://git-wip-us.apache.org/repos/asf/airavata/blob/36da4ee4/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/replica_catalog_models_types.cpp ---------------------------------------------------------------------- diff --git a/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/replica_catalog_models_types.cpp b/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/replica_catalog_models_types.cpp index 0be562e..5f634dc 100644 --- a/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/replica_catalog_models_types.cpp +++ b/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/replica_catalog_models_types.cpp @@ -517,6 +517,11 @@ void DataReplicaLocationModel::__set_lastModifiedTime(const int64_t val) { __isset.lastModifiedTime = true; } +void DataReplicaLocationModel::__set_validUntilTime(const int64_t val) { + this->validUntilTime = val; +__isset.validUntilTime = true; +} + void DataReplicaLocationModel::__set_replicaLocationCategory(const ReplicaLocationCategory::type val) { this->replicaLocationCategory = val; __isset.replicaLocationCategory = true; @@ -532,29 +537,9 @@ void DataReplicaLocationModel::__set_storageResourceId(const std::string& val) { __isset.storageResourceId = true; } -void DataReplicaLocationModel::__set_storageResourceHostName(const std::string& val) { - this->storageResourceHostName = val; -__isset.storageResourceHostName = true; -} - -void DataReplicaLocationModel::__set_dataMovementProtocol(const ::apache::airavata::model::data::movement::DataMovementProtocol::type val) { - this->dataMovementProtocol = val; -__isset.dataMovementProtocol = true; -} - -void DataReplicaLocationModel::__set_hostPort(const int64_t val) { - this->hostPort = val; -__isset.hostPort = true; -} - -void DataReplicaLocationModel::__set_filePath(const std::string& val) { - this->filePath = val; -__isset.filePath = true; -} - -void DataReplicaLocationModel::__set_replicaUrl(const std::string& val) { - this->replicaUrl = val; -__isset.replicaUrl = true; +void DataReplicaLocationModel::__set_fileAbsolutePath(const std::string& val) { + this->fileAbsolutePath = val; +__isset.fileAbsolutePath = true; } void DataReplicaLocationModel::__set_replicaMetadata(const std::map<std::string, std::string> & val) { @@ -632,6 +617,14 @@ uint32_t DataReplicaLocationModel::read(::apache::thrift::protocol::TProtocol* i } break; case 7: + if (ftype == ::apache::thrift::protocol::T_I64) { + xfer += iprot->readI64(this->validUntilTime); + this->__isset.validUntilTime = true; + } else { + xfer += iprot->skip(ftype); + } + break; + case 8: if (ftype == ::apache::thrift::protocol::T_I32) { int32_t ecast23; xfer += iprot->readI32(ecast23); @@ -641,7 +634,7 @@ uint32_t DataReplicaLocationModel::read(::apache::thrift::protocol::TProtocol* i xfer += iprot->skip(ftype); } break; - case 8: + case 9: if (ftype == ::apache::thrift::protocol::T_I32) { int32_t ecast24; xfer += iprot->readI32(ecast24); @@ -651,7 +644,7 @@ uint32_t DataReplicaLocationModel::read(::apache::thrift::protocol::TProtocol* i xfer += iprot->skip(ftype); } break; - case 9: + case 10: if (ftype == ::apache::thrift::protocol::T_STRING) { xfer += iprot->readString(this->storageResourceId); this->__isset.storageResourceId = true; @@ -659,63 +652,29 @@ uint32_t DataReplicaLocationModel::read(::apache::thrift::protocol::TProtocol* i xfer += iprot->skip(ftype); } break; - case 10: - if (ftype == ::apache::thrift::protocol::T_STRING) { - xfer += iprot->readString(this->storageResourceHostName); - this->__isset.storageResourceHostName = true; - } else { - xfer += iprot->skip(ftype); - } - break; case 11: - if (ftype == ::apache::thrift::protocol::T_I32) { - int32_t ecast25; - xfer += iprot->readI32(ecast25); - this->dataMovementProtocol = ( ::apache::airavata::model::data::movement::DataMovementProtocol::type)ecast25; - this->__isset.dataMovementProtocol = true; - } else { - xfer += iprot->skip(ftype); - } - break; - case 12: - if (ftype == ::apache::thrift::protocol::T_I64) { - xfer += iprot->readI64(this->hostPort); - this->__isset.hostPort = true; - } else { - xfer += iprot->skip(ftype); - } - break; - case 13: if (ftype == ::apache::thrift::protocol::T_STRING) { - xfer += iprot->readString(this->filePath); - this->__isset.filePath = true; + xfer += iprot->readString(this->fileAbsolutePath); + this->__isset.fileAbsolutePath = true; } else { xfer += iprot->skip(ftype); } break; - case 14: - if (ftype == ::apache::thrift::protocol::T_STRING) { - xfer += iprot->readString(this->replicaUrl); - this->__isset.replicaUrl = true; - } else { - xfer += iprot->skip(ftype); - } - break; - case 15: + case 12: if (ftype == ::apache::thrift::protocol::T_MAP) { { this->replicaMetadata.clear(); - uint32_t _size26; - ::apache::thrift::protocol::TType _ktype27; - ::apache::thrift::protocol::TType _vtype28; - xfer += iprot->readMapBegin(_ktype27, _vtype28, _size26); - uint32_t _i30; - for (_i30 = 0; _i30 < _size26; ++_i30) + uint32_t _size25; + ::apache::thrift::protocol::TType _ktype26; + ::apache::thrift::protocol::TType _vtype27; + xfer += iprot->readMapBegin(_ktype26, _vtype27, _size25); + uint32_t _i29; + for (_i29 = 0; _i29 < _size25; ++_i29) { - std::string _key31; - xfer += iprot->readString(_key31); - std::string& _val32 = this->replicaMetadata[_key31]; - xfer += iprot->readString(_val32); + std::string _key30; + xfer += iprot->readString(_key30); + std::string& _val31 = this->replicaMetadata[_key30]; + xfer += iprot->readString(_val31); } xfer += iprot->readMapEnd(); } @@ -771,55 +730,40 @@ uint32_t DataReplicaLocationModel::write(::apache::thrift::protocol::TProtocol* xfer += oprot->writeI64(this->lastModifiedTime); xfer += oprot->writeFieldEnd(); } + if (this->__isset.validUntilTime) { + xfer += oprot->writeFieldBegin("validUntilTime", ::apache::thrift::protocol::T_I64, 7); + xfer += oprot->writeI64(this->validUntilTime); + xfer += oprot->writeFieldEnd(); + } if (this->__isset.replicaLocationCategory) { - xfer += oprot->writeFieldBegin("replicaLocationCategory", ::apache::thrift::protocol::T_I32, 7); + xfer += oprot->writeFieldBegin("replicaLocationCategory", ::apache::thrift::protocol::T_I32, 8); xfer += oprot->writeI32((int32_t)this->replicaLocationCategory); xfer += oprot->writeFieldEnd(); } if (this->__isset.replicaPersistentType) { - xfer += oprot->writeFieldBegin("replicaPersistentType", ::apache::thrift::protocol::T_I32, 8); + xfer += oprot->writeFieldBegin("replicaPersistentType", ::apache::thrift::protocol::T_I32, 9); xfer += oprot->writeI32((int32_t)this->replicaPersistentType); xfer += oprot->writeFieldEnd(); } if (this->__isset.storageResourceId) { - xfer += oprot->writeFieldBegin("storageResourceId", ::apache::thrift::protocol::T_STRING, 9); + xfer += oprot->writeFieldBegin("storageResourceId", ::apache::thrift::protocol::T_STRING, 10); xfer += oprot->writeString(this->storageResourceId); xfer += oprot->writeFieldEnd(); } - if (this->__isset.storageResourceHostName) { - xfer += oprot->writeFieldBegin("storageResourceHostName", ::apache::thrift::protocol::T_STRING, 10); - xfer += oprot->writeString(this->storageResourceHostName); - xfer += oprot->writeFieldEnd(); - } - if (this->__isset.dataMovementProtocol) { - xfer += oprot->writeFieldBegin("dataMovementProtocol", ::apache::thrift::protocol::T_I32, 11); - xfer += oprot->writeI32((int32_t)this->dataMovementProtocol); - xfer += oprot->writeFieldEnd(); - } - if (this->__isset.hostPort) { - xfer += oprot->writeFieldBegin("hostPort", ::apache::thrift::protocol::T_I64, 12); - xfer += oprot->writeI64(this->hostPort); - xfer += oprot->writeFieldEnd(); - } - if (this->__isset.filePath) { - xfer += oprot->writeFieldBegin("filePath", ::apache::thrift::protocol::T_STRING, 13); - xfer += oprot->writeString(this->filePath); - xfer += oprot->writeFieldEnd(); - } - if (this->__isset.replicaUrl) { - xfer += oprot->writeFieldBegin("replicaUrl", ::apache::thrift::protocol::T_STRING, 14); - xfer += oprot->writeString(this->replicaUrl); + if (this->__isset.fileAbsolutePath) { + xfer += oprot->writeFieldBegin("fileAbsolutePath", ::apache::thrift::protocol::T_STRING, 11); + xfer += oprot->writeString(this->fileAbsolutePath); xfer += oprot->writeFieldEnd(); } if (this->__isset.replicaMetadata) { - xfer += oprot->writeFieldBegin("replicaMetadata", ::apache::thrift::protocol::T_MAP, 15); + xfer += oprot->writeFieldBegin("replicaMetadata", ::apache::thrift::protocol::T_MAP, 12); { xfer += oprot->writeMapBegin(::apache::thrift::protocol::T_STRING, ::apache::thrift::protocol::T_STRING, static_cast<uint32_t>(this->replicaMetadata.size())); - std::map<std::string, std::string> ::const_iterator _iter33; - for (_iter33 = this->replicaMetadata.begin(); _iter33 != this->replicaMetadata.end(); ++_iter33) + std::map<std::string, std::string> ::const_iterator _iter32; + for (_iter32 = this->replicaMetadata.begin(); _iter32 != this->replicaMetadata.end(); ++_iter32) { - xfer += oprot->writeString(_iter33->first); - xfer += oprot->writeString(_iter33->second); + xfer += oprot->writeString(_iter32->first); + xfer += oprot->writeString(_iter32->second); } xfer += oprot->writeMapEnd(); } @@ -838,53 +782,44 @@ void swap(DataReplicaLocationModel &a, DataReplicaLocationModel &b) { swap(a.replicaDescription, b.replicaDescription); swap(a.creationTime, b.creationTime); swap(a.lastModifiedTime, b.lastModifiedTime); + swap(a.validUntilTime, b.validUntilTime); swap(a.replicaLocationCategory, b.replicaLocationCategory); swap(a.replicaPersistentType, b.replicaPersistentType); swap(a.storageResourceId, b.storageResourceId); - swap(a.storageResourceHostName, b.storageResourceHostName); - swap(a.dataMovementProtocol, b.dataMovementProtocol); - swap(a.hostPort, b.hostPort); - swap(a.filePath, b.filePath); - swap(a.replicaUrl, b.replicaUrl); + swap(a.fileAbsolutePath, b.fileAbsolutePath); swap(a.replicaMetadata, b.replicaMetadata); swap(a.__isset, b.__isset); } -DataReplicaLocationModel::DataReplicaLocationModel(const DataReplicaLocationModel& other34) { +DataReplicaLocationModel::DataReplicaLocationModel(const DataReplicaLocationModel& other33) { + replicaId = other33.replicaId; + resourceId = other33.resourceId; + replicaName = other33.replicaName; + replicaDescription = other33.replicaDescription; + creationTime = other33.creationTime; + lastModifiedTime = other33.lastModifiedTime; + validUntilTime = other33.validUntilTime; + replicaLocationCategory = other33.replicaLocationCategory; + replicaPersistentType = other33.replicaPersistentType; + storageResourceId = other33.storageResourceId; + fileAbsolutePath = other33.fileAbsolutePath; + replicaMetadata = other33.replicaMetadata; + __isset = other33.__isset; +} +DataReplicaLocationModel& DataReplicaLocationModel::operator=(const DataReplicaLocationModel& other34) { replicaId = other34.replicaId; resourceId = other34.resourceId; replicaName = other34.replicaName; replicaDescription = other34.replicaDescription; creationTime = other34.creationTime; lastModifiedTime = other34.lastModifiedTime; + validUntilTime = other34.validUntilTime; replicaLocationCategory = other34.replicaLocationCategory; replicaPersistentType = other34.replicaPersistentType; storageResourceId = other34.storageResourceId; - storageResourceHostName = other34.storageResourceHostName; - dataMovementProtocol = other34.dataMovementProtocol; - hostPort = other34.hostPort; - filePath = other34.filePath; - replicaUrl = other34.replicaUrl; + fileAbsolutePath = other34.fileAbsolutePath; replicaMetadata = other34.replicaMetadata; __isset = other34.__isset; -} -DataReplicaLocationModel& DataReplicaLocationModel::operator=(const DataReplicaLocationModel& other35) { - replicaId = other35.replicaId; - resourceId = other35.resourceId; - replicaName = other35.replicaName; - replicaDescription = other35.replicaDescription; - creationTime = other35.creationTime; - lastModifiedTime = other35.lastModifiedTime; - replicaLocationCategory = other35.replicaLocationCategory; - replicaPersistentType = other35.replicaPersistentType; - storageResourceId = other35.storageResourceId; - storageResourceHostName = other35.storageResourceHostName; - dataMovementProtocol = other35.dataMovementProtocol; - hostPort = other35.hostPort; - filePath = other35.filePath; - replicaUrl = other35.replicaUrl; - replicaMetadata = other35.replicaMetadata; - __isset = other35.__isset; return *this; } void DataReplicaLocationModel::printTo(std::ostream& out) const { @@ -896,14 +831,11 @@ void DataReplicaLocationModel::printTo(std::ostream& out) const { out << ", " << "replicaDescription="; (__isset.replicaDescription ? (out << to_string(replicaDescription)) : (out << "<null>")); out << ", " << "creationTime="; (__isset.creationTime ? (out << to_string(creationTime)) : (out << "<null>")); out << ", " << "lastModifiedTime="; (__isset.lastModifiedTime ? (out << to_string(lastModifiedTime)) : (out << "<null>")); + out << ", " << "validUntilTime="; (__isset.validUntilTime ? (out << to_string(validUntilTime)) : (out << "<null>")); out << ", " << "replicaLocationCategory="; (__isset.replicaLocationCategory ? (out << to_string(replicaLocationCategory)) : (out << "<null>")); out << ", " << "replicaPersistentType="; (__isset.replicaPersistentType ? (out << to_string(replicaPersistentType)) : (out << "<null>")); out << ", " << "storageResourceId="; (__isset.storageResourceId ? (out << to_string(storageResourceId)) : (out << "<null>")); - out << ", " << "storageResourceHostName="; (__isset.storageResourceHostName ? (out << to_string(storageResourceHostName)) : (out << "<null>")); - out << ", " << "dataMovementProtocol="; (__isset.dataMovementProtocol ? (out << to_string(dataMovementProtocol)) : (out << "<null>")); - out << ", " << "hostPort="; (__isset.hostPort ? (out << to_string(hostPort)) : (out << "<null>")); - out << ", " << "filePath="; (__isset.filePath ? (out << to_string(filePath)) : (out << "<null>")); - out << ", " << "replicaUrl="; (__isset.replicaUrl ? (out << to_string(replicaUrl)) : (out << "<null>")); + out << ", " << "fileAbsolutePath="; (__isset.fileAbsolutePath ? (out << to_string(fileAbsolutePath)) : (out << "<null>")); out << ", " << "replicaMetadata="; (__isset.replicaMetadata ? (out << to_string(replicaMetadata)) : (out << "<null>")); out << ")"; } http://git-wip-us.apache.org/repos/asf/airavata/blob/36da4ee4/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/replica_catalog_models_types.h ---------------------------------------------------------------------- diff --git a/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/replica_catalog_models_types.h b/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/replica_catalog_models_types.h index d77a187..7816d82 100644 --- a/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/replica_catalog_models_types.h +++ b/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/replica_catalog_models_types.h @@ -215,21 +215,18 @@ inline std::ostream& operator<<(std::ostream& out, const DataResourceModel& obj) } typedef struct _DataReplicaLocationModel__isset { - _DataReplicaLocationModel__isset() : replicaId(false), resourceId(false), replicaName(false), replicaDescription(false), creationTime(false), lastModifiedTime(false), replicaLocationCategory(false), replicaPersistentType(false), storageResourceId(false), storageResourceHostName(false), dataMovementProtocol(false), hostPort(false), filePath(false), replicaUrl(false), replicaMetadata(false) {} + _DataReplicaLocationModel__isset() : replicaId(false), resourceId(false), replicaName(false), replicaDescription(false), creationTime(false), lastModifiedTime(false), validUntilTime(false), replicaLocationCategory(false), replicaPersistentType(false), storageResourceId(false), fileAbsolutePath(false), replicaMetadata(false) {} bool replicaId :1; bool resourceId :1; bool replicaName :1; bool replicaDescription :1; bool creationTime :1; bool lastModifiedTime :1; + bool validUntilTime :1; bool replicaLocationCategory :1; bool replicaPersistentType :1; bool storageResourceId :1; - bool storageResourceHostName :1; - bool dataMovementProtocol :1; - bool hostPort :1; - bool filePath :1; - bool replicaUrl :1; + bool fileAbsolutePath :1; bool replicaMetadata :1; } _DataReplicaLocationModel__isset; @@ -238,7 +235,7 @@ class DataReplicaLocationModel { DataReplicaLocationModel(const DataReplicaLocationModel&); DataReplicaLocationModel& operator=(const DataReplicaLocationModel&); - DataReplicaLocationModel() : replicaId(), resourceId(), replicaName(), replicaDescription(), creationTime(0), lastModifiedTime(0), replicaLocationCategory((ReplicaLocationCategory::type)0), replicaPersistentType((ReplicaPersistentType::type)0), storageResourceId(), storageResourceHostName(), dataMovementProtocol(( ::apache::airavata::model::data::movement::DataMovementProtocol::type)0), hostPort(0), filePath(), replicaUrl() { + DataReplicaLocationModel() : replicaId(), resourceId(), replicaName(), replicaDescription(), creationTime(0), lastModifiedTime(0), validUntilTime(0), replicaLocationCategory((ReplicaLocationCategory::type)0), replicaPersistentType((ReplicaPersistentType::type)0), storageResourceId(), fileAbsolutePath() { } virtual ~DataReplicaLocationModel() throw(); @@ -248,14 +245,11 @@ class DataReplicaLocationModel { std::string replicaDescription; int64_t creationTime; int64_t lastModifiedTime; + int64_t validUntilTime; ReplicaLocationCategory::type replicaLocationCategory; ReplicaPersistentType::type replicaPersistentType; std::string storageResourceId; - std::string storageResourceHostName; - ::apache::airavata::model::data::movement::DataMovementProtocol::type dataMovementProtocol; - int64_t hostPort; - std::string filePath; - std::string replicaUrl; + std::string fileAbsolutePath; std::map<std::string, std::string> replicaMetadata; _DataReplicaLocationModel__isset __isset; @@ -272,21 +266,15 @@ class DataReplicaLocationModel { void __set_lastModifiedTime(const int64_t val); + void __set_validUntilTime(const int64_t val); + void __set_replicaLocationCategory(const ReplicaLocationCategory::type val); void __set_replicaPersistentType(const ReplicaPersistentType::type val); void __set_storageResourceId(const std::string& val); - void __set_storageResourceHostName(const std::string& val); - - void __set_dataMovementProtocol(const ::apache::airavata::model::data::movement::DataMovementProtocol::type val); - - void __set_hostPort(const int64_t val); - - void __set_filePath(const std::string& val); - - void __set_replicaUrl(const std::string& val); + void __set_fileAbsolutePath(const std::string& val); void __set_replicaMetadata(const std::map<std::string, std::string> & val); @@ -316,6 +304,10 @@ class DataReplicaLocationModel { return false; else if (__isset.lastModifiedTime && !(lastModifiedTime == rhs.lastModifiedTime)) return false; + if (__isset.validUntilTime != rhs.__isset.validUntilTime) + return false; + else if (__isset.validUntilTime && !(validUntilTime == rhs.validUntilTime)) + return false; if (__isset.replicaLocationCategory != rhs.__isset.replicaLocationCategory) return false; else if (__isset.replicaLocationCategory && !(replicaLocationCategory == rhs.replicaLocationCategory)) @@ -328,25 +320,9 @@ class DataReplicaLocationModel { return false; else if (__isset.storageResourceId && !(storageResourceId == rhs.storageResourceId)) return false; - if (__isset.storageResourceHostName != rhs.__isset.storageResourceHostName) - return false; - else if (__isset.storageResourceHostName && !(storageResourceHostName == rhs.storageResourceHostName)) - return false; - if (__isset.dataMovementProtocol != rhs.__isset.dataMovementProtocol) - return false; - else if (__isset.dataMovementProtocol && !(dataMovementProtocol == rhs.dataMovementProtocol)) - return false; - if (__isset.hostPort != rhs.__isset.hostPort) - return false; - else if (__isset.hostPort && !(hostPort == rhs.hostPort)) - return false; - if (__isset.filePath != rhs.__isset.filePath) - return false; - else if (__isset.filePath && !(filePath == rhs.filePath)) - return false; - if (__isset.replicaUrl != rhs.__isset.replicaUrl) + if (__isset.fileAbsolutePath != rhs.__isset.fileAbsolutePath) return false; - else if (__isset.replicaUrl && !(replicaUrl == rhs.replicaUrl)) + else if (__isset.fileAbsolutePath && !(fileAbsolutePath == rhs.fileAbsolutePath)) return false; if (__isset.replicaMetadata != rhs.__isset.replicaMetadata) return false; http://git-wip-us.apache.org/repos/asf/airavata/blob/36da4ee4/airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/lib/Airavata/API/Airavata.php ---------------------------------------------------------------------- diff --git a/airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/lib/Airavata/API/Airavata.php b/airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/lib/Airavata/API/Airavata.php index 3036307..bcdeb0b 100644 --- a/airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/lib/Airavata/API/Airavata.php +++ b/airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/lib/Airavata/API/Airavata.php @@ -58,6 +58,8 @@ interface AiravataIf { * @return gateway * Modified gateway obejct. * + * @exception AiravataClientException + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -122,6 +124,19 @@ interface AiravataIf { */ public function getAllGateways(\Airavata\Model\Security\AuthzToken $authzToken); /** + * 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. + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @return bool @@ -221,6 +236,16 @@ interface AiravataIf { */ public function getAllGatewaySSHPubKeys(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId); /** + * 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. + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $airavataCredStoreToken * @param string $gatewayId @@ -241,6 +266,7 @@ interface AiravataIf { * The Project Object described in the workspace_model * * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @param \Airavata\Model\Workspace\Project $project @@ -252,7 +278,14 @@ interface AiravataIf { */ public function createProject(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\Workspace\Project $project); /** - * Update a Project + * Update an Existing Project + * + * @param projectId + * The projectId of the project needed an update. + * + * @return void + * Currently this does not return any value. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -267,6 +300,14 @@ interface AiravataIf { public function updateProject(\Airavata\Model\Security\AuthzToken $authzToken, $projectId, \Airavata\Model\Workspace\Project $updatedProject); /** * Get a Project by ID + * This method is to obtain a project by providing a projectId + * + * @param projectId + * projectId of the project you require + * + * @return project + * project data model will be returned + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -280,6 +321,17 @@ interface AiravataIf { */ public function getProject(\Airavata\Model\Security\AuthzToken $authzToken, $projectId); /** + * 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. + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $projectId * @return bool @@ -291,18 +343,22 @@ interface AiravataIf { */ public function deleteProject(\Airavata\Model\Security\AuthzToken $authzToken, $projectId); /** - * * 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 fetched - * * + * 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 fetched + * + * * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId @@ -331,6 +387,7 @@ interface AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @param string $userName @@ -359,6 +416,7 @@ interface AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @param string $userName @@ -387,6 +445,7 @@ interface AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @param string $userName @@ -415,6 +474,7 @@ interface AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @param string $userName @@ -443,6 +503,7 @@ interface AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @param string $userName @@ -471,6 +532,7 @@ interface AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @param string $userName @@ -501,6 +563,7 @@ interface AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @param string $userName @@ -530,6 +593,7 @@ interface AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @param string $userName @@ -575,6 +639,7 @@ interface AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $projectId * @param int $limit @@ -600,6 +665,7 @@ interface AiravataIf { * @param offset * The starting point of the results to be fetched * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @param string $userName @@ -613,39 +679,40 @@ interface AiravataIf { */ public function getUserExperiments(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $userName, $limit, $offset); /** - * 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. - * + * * 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. + * * + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId @@ -658,12 +725,18 @@ interface AiravataIf { */ public function createExperiment(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\Experiment\ExperimentModel $experiment); /** + * Delete an Experiment + * * If the experiment is not already launched experiment can be deleted. * * @param authzToken + * * @param experiementId + * Experiment ID of the experimnet you want to delete. + * + * @return boolean + * Identifier for the success or failure of the deletion operation * - * @return boolean identifier for the success or failure of the deletion operation * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -676,37 +749,38 @@ interface AiravataIf { */ public function deleteExperiment(\Airavata\Model\Security\AuthzToken $authzToken, $experimentId); /** - * 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. - * + * * 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. + * * + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $airavataExperimentId @@ -857,8 +931,11 @@ interface AiravataIf { * * * * Validate experiment configuration. A true in general indicates, the experiment is ready to be launched. * * - * * @param experimentID - * * @return sucess/failure + * * @param experimentId + * * + * * + * * @return boolean + * * Identifier for the success or failure of the validation operation * * * * * @@ -917,6 +994,20 @@ interface AiravataIf { */ public function launchExperiment(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId, $gatewayId); /** + * 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. + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $airavataExperimentId * @return \Airavata\Model\Status\ExperimentStatus Status: A generic status object. @@ -939,6 +1030,19 @@ interface AiravataIf { */ public function getExperimentStatus(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId); /** + * 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 experiment + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $airavataExperimentId * @return \Airavata\Model\Application\Io\OutputDataObjectType[] @@ -950,6 +1054,19 @@ interface AiravataIf { */ public function getExperimentOutputs(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId); /** + * Get Intermediate Experiment Outputs + * This method to be used when need to obtain intermediate outputs of a certain Experiment + * + * @param authzToken + * + * @param experiementId + * Experiment ID of the experimnet you need the intermediate outputs + * + * @return list + * List of intermediate experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $airavataExperimentId * @return \Airavata\Model\Application\Io\OutputDataObjectType[] @@ -961,6 +1078,19 @@ interface AiravataIf { */ public function getIntermediateOutputs(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId); /** + * 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 map + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $airavataExperimentId * @return array @@ -972,6 +1102,19 @@ interface AiravataIf { */ public function getJobStatuses(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId); /** + * Get Job Details for all the jobs within an Experiment + * This method to be used when need to get the job details for one or many jobs of an Experiment. + * + * @param authzToken + * + * @param experiementId + * Experiment ID of the experimnet you need job details + * + * @return list of JobDetails + * Job details + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $airavataExperimentId * @return \Airavata\Model\Job\JobModel[] @@ -2005,7 +2148,7 @@ interface AiravataIf { * The SSHJobSubmission object to be updated. * * @return status - * Returns a success/failure of the deletion. + * Returns a success/failure of the update. * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -2028,7 +2171,7 @@ interface AiravataIf { * The CloudJobSubmission object to be updated. * * @return status - * Returns a success/failure of the deletion. + * Returns a success/failure of the update. * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -2042,6 +2185,19 @@ interface AiravataIf { */ public function updateCloudJobSubmissionDetails(\Airavata\Model\Security\AuthzToken $authzToken, $jobSubmissionInterfaceId, \Airavata\Model\AppCatalog\ComputeResource\CloudJobSubmission $sshJobSubmission); /** + * 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. + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $jobSubmissionInterfaceId * @param \Airavata\Model\AppCatalog\ComputeResource\UnicoreJobSubmission $unicoreJobSubmission @@ -2056,9 +2212,12 @@ interface AiravataIf { * 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 + * @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. * @@ -2069,6 +2228,7 @@ interface AiravataIf { * Returns the unique job submission id. * * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $resourceId * @param int $dataMoveType @@ -2094,6 +2254,7 @@ interface AiravataIf { * Returns a success/failure of the update. * * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $dataMovementInterfaceId * @param \Airavata\Model\Data\Movement\LOCALDataMovement $localDataMovement @@ -2105,11 +2266,14 @@ interface AiravataIf { */ public function updateLocalDataMovementDetails(\Airavata\Model\Security\AuthzToken $authzToken, $dataMovementInterfaceId, \Airavata\Model\Data\Movement\LOCALDataMovement $localDataMovement); /** - * * This method returns local datamovement object - * * @param dataMovementId - * * The identifier of the datamovement Interface to be retrieved. - * * @return LOCALDataMovement instance - * * + * This method returns local datamovement object + * + * @param dataMovementId + * The identifier of the datamovement Interface to be retrieved. + * + * @return LOCALDataMovement instance + * + * * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $dataMovementId @@ -2131,7 +2295,7 @@ interface AiravataIf { * 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 + * @param resourceId * The identifier of the compute resource to which JobSubmission protocol to be added * * @param priorityOrder @@ -2181,11 +2345,14 @@ interface AiravataIf { */ public function updateSCPDataMovementDetails(\Airavata\Model\Security\AuthzToken $authzToken, $dataMovementInterfaceId, \Airavata\Model\Data\Movement\SCPDataMovement $scpDataMovement); /** - * * This method returns SCP datamovement object - * * @param dataMovementId - * * The identifier of the datamovement Interface to be retrieved. - * * @return SCPDataMovement instance - * * + * This method returns SCP datamovement object + * + * @param dataMovementId + * The identifier of the datamovement Interface to be retrieved. + * + * @return SCPDataMovement instance + * + * * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $dataMovementId @@ -2204,6 +2371,22 @@ interface AiravataIf { */ public function getSCPDataMovement(\Airavata\Model\Security\AuthzToken $authzToken, $dataMovementId); /** + * 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. + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $resourceId * @param int $dataMoveType @@ -2217,6 +2400,20 @@ interface AiravataIf { */ public function addUnicoreDataMovementDetails(\Airavata\Model\Security\AuthzToken $authzToken, $resourceId, $dataMoveType, $priorityOrder, \Airavata\Model\Data\Movement\UnicoreDataMovement $unicoreDataMovement); /** + * 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. + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $dataMovementInterfaceId * @param \Airavata\Model\Data\Movement\UnicoreDataMovement $unicoreDataMovement @@ -2228,6 +2425,15 @@ interface AiravataIf { */ public function updateUnicoreDataMovementDetails(\Airavata\Model\Security\AuthzToken $authzToken, $dataMovementInterfaceId, \Airavata\Model\Data\Movement\UnicoreDataMovement $unicoreDataMovement); /** + * This method returns UNICORE datamovement object + * + * @param dataMovementId + * The identifier of the datamovement Interface to be retrieved. + * + * @return UnicoreDataMovement instance + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $dataMovementId * @return \Airavata\Model\Data\Movement\UnicoreDataMovement Data Movement through UnicoreStorage @@ -2245,8 +2451,11 @@ interface AiravataIf { * 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 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. @@ -2255,7 +2464,8 @@ interface AiravataIf { * The GridFTPDataMovement object to be added to the resource. * * @return status - * Returns the unique job submission id. + * Returns the unique data movement id. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -2280,8 +2490,9 @@ interface AiravataIf { * @param gridFTPDataMovement * The GridFTPDataMovement object to be updated. * - * @return status - * Returns a success/failure of the updation. + * @return boolean + * Returns a success/failure of the update. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -2295,11 +2506,14 @@ interface AiravataIf { */ public function updateGridFTPDataMovementDetails(\Airavata\Model\Security\AuthzToken $authzToken, $dataMovementInterfaceId, \Airavata\Model\Data\Movement\GridFTPDataMovement $gridFTPDataMovement); /** - * * This method returns GridFTP datamovement object - * * @param dataMovementId - * * The identifier of the datamovement Interface to be retrieved. - * * @return GridFTPDataMovement instance - * * + * This method returns GridFTP datamovement object + * + * @param dataMovementId + * The identifier of the datamovement Interface to be retrieved. + * + * @return GridFTPDataMovement instance + * + * * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $dataMovementId @@ -2330,6 +2544,7 @@ interface AiravataIf { * Returns a success/failure of the change. * * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $jobSubmissionInterfaceId * @param int $newPriorityOrder @@ -2353,6 +2568,7 @@ interface AiravataIf { * Returns a success/failure of the change. * * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $dataMovementInterfaceId * @param int $newPriorityOrder @@ -2392,6 +2608,7 @@ interface AiravataIf { * Returns a success/failure of the changes. * * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param array $dataMovementPriorityMap * @return bool @@ -2411,6 +2628,7 @@ interface AiravataIf { * Returns a success/failure of the deletion. * * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $computeResourceId * @param string $jobSubmissionInterfaceId @@ -2431,6 +2649,7 @@ interface AiravataIf { * Returns a success/failure of the deletion. * * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $computeResourceId * @param string $dataMovementInterfaceId @@ -2498,6 +2717,19 @@ interface AiravataIf { */ public function deleteResourceJobManager(\Airavata\Model\Security\AuthzToken $authzToken, $resourceJobManagerId); /** + * 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. + * + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $computeResourceId * @param string $queueName
