Repository: airavata Updated Branches: refs/heads/master ee1d26ca7 -> 50cdfceef
Adding descriptions to thirft API methods Project: http://git-wip-us.apache.org/repos/asf/airavata/repo Commit: http://git-wip-us.apache.org/repos/asf/airavata/commit/8eb545e5 Tree: http://git-wip-us.apache.org/repos/asf/airavata/tree/8eb545e5 Diff: http://git-wip-us.apache.org/repos/asf/airavata/diff/8eb545e5 Branch: refs/heads/master Commit: 8eb545e534905772c7bf632b188d66248ddf9033 Parents: ee1d26c Author: Eroma Abeysinghe <[email protected]> Authored: Tue Dec 15 16:09:03 2015 -0500 Committer: Eroma Abeysinghe <[email protected]> Committed: Tue Dec 15 16:09:03 2015 -0500 ---------------------------------------------------------------------- .../airavata-apis/airavata_api.thrift | 41 ++++++++++++++++---- 1 file changed, 34 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/airavata/blob/8eb545e5/thrift-interface-descriptions/airavata-apis/airavata_api.thrift ---------------------------------------------------------------------- diff --git a/thrift-interface-descriptions/airavata-apis/airavata_api.thrift b/thrift-interface-descriptions/airavata-apis/airavata_api.thrift index 9d3ed57..0a87fd5 100644 --- a/thrift-interface-descriptions/airavata-apis/airavata_api.thrift +++ b/thrift-interface-descriptions/airavata-apis/airavata_api.thrift @@ -71,16 +71,16 @@ service Airavata { * Apache Airavata API Service Methods. For data structures associated in the signatures, please see included thrift files */ - /** + /** * Fetch Apache Airavata API version - */ + **/ string getAPIVersion(1: required security_model.AuthzToken authzToken) throws (1: airavata_errors.InvalidRequestException ire, 2: airavata_errors.AiravataClientException ace, 3: airavata_errors.AiravataSystemException ase, 4: airavata_errors.AuthorizationException ae) - /** + /** * Register a Gateway with Airavata. * * @param gateway @@ -89,7 +89,7 @@ service Airavata { * @return gatewayId * Th unique identifier of the newly registered gateway. * - */ + **/ string addGateway(1: required security_model.AuthzToken authzToken, 2: required workspace_model.Gateway gateway) throws (1: airavata_errors.InvalidRequestException ire, @@ -97,16 +97,16 @@ service Airavata { 3: airavata_errors.AiravataSystemException ase, 4: airavata_errors.AuthorizationException ae) - /** + /** * Update previously registered Gateway metadata. * * @param gatewayId * The gateway Id of the Gateway which require an update. * - * @param gateway + * @return gateway * Modified gateway obejct. * - */ + **/ void updateGateway(1: required security_model.AuthzToken authzToken, 2: required string gatewayId, 3: required workspace_model.Gateway updatedGateway) throws (1: airavata_errors.InvalidRequestException ire, @@ -114,18 +114,44 @@ service Airavata { 3: airavata_errors.AiravataSystemException ase, 4: airavata_errors.AuthorizationException ae) + /** + * Get Gateway details by providing gatewayId + * + * @param gatewayId + * The gateway Id of the Gateway. + * + * @return gateway + * Gateway obejct. + * + **/ + workspace_model.Gateway getGateway(1: required security_model.AuthzToken authzToken, 2: required string gatewayId) throws (1: airavata_errors.InvalidRequestException ire, 2: airavata_errors.AiravataClientException ace, 3: airavata_errors.AiravataSystemException ase, 4: airavata_errors.AuthorizationException ae) + /** + * 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(1: required security_model.AuthzToken authzToken, 2: required string gatewayId) throws (1: airavata_errors.InvalidRequestException ire, 2: airavata_errors.AiravataClientException ace, 3: airavata_errors.AiravataSystemException ase, 4: airavata_errors.AuthorizationException ae) + /** + * Get All the Gateways Connected to Airavata. + **/ + list<workspace_model.Gateway> getAllGateways(1: required security_model.AuthzToken authzToken) throws (1: airavata_errors.InvalidRequestException ire, 2: airavata_errors.AiravataClientException ace, @@ -1065,6 +1091,7 @@ service Airavata { * Returns a application Deployment Object. * */ + application_deployment_model.ApplicationDeploymentDescription getApplicationDeployment(1: required security_model.AuthzToken authzToken, 2: required string appDeploymentId) throws (1: airavata_errors.InvalidRequestException ire,
