http://git-wip-us.apache.org/repos/asf/airavata/blob/4c790770/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/workflow_data_model_types.h ---------------------------------------------------------------------- diff --git a/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/workflow_data_model_types.h b/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/workflow_data_model_types.h index 9ef1ada..831bc02 100644 --- a/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/workflow_data_model_types.h +++ b/airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/lib/airavata/workflow_data_model_types.h @@ -38,33 +38,74 @@ -class Workflow; +struct WorkflowState { + enum type { + CREATED = 0, + STARTED = 1, + EXECUTING = 2, + COMPLETED = 3, + FAILED = 4, + CANCELLING = 5, + CANCELED = 6 + }; +}; + +extern const std::map<int, const char*> _WorkflowState_VALUES_TO_NAMES; + +struct ComponentState { + enum type { + CREATED = 0, + WAITING = 1, + READY = 2, + RUNNING = 3, + COMPLETED = 4, + FAILED = 5, + CANCELED = 6 + }; +}; + +extern const std::map<int, const char*> _ComponentState_VALUES_TO_NAMES; + +class WorkflowModel; + +class ComponentStatus; -typedef struct _Workflow__isset { - _Workflow__isset() : graph(false), image(false), workflowInputs(false), workflowOutputs(false) {} - bool graph :1; +class WorkflowStatus; + +class EdgeModel; + +class PortModel; + +class NodeModel; + +typedef struct _WorkflowModel__isset { + _WorkflowModel__isset() : image(false), workflowInputs(false), workflowOutputs(false), creationTime(false) {} bool image :1; bool workflowInputs :1; bool workflowOutputs :1; -} _Workflow__isset; + bool creationTime :1; +} _WorkflowModel__isset; -class Workflow { +class WorkflowModel { public: - Workflow(const Workflow&); - Workflow& operator=(const Workflow&); - Workflow() : templateId("DO_NOT_SET_AT_CLIENTS"), name(), graph(), image() { + WorkflowModel(const WorkflowModel&); + WorkflowModel& operator=(const WorkflowModel&); + WorkflowModel() : templateId("DO_NOT_SET_AT_CLIENTS"), name(), graph(), gatewayId(), createdUser(), image(), creationTime(0) { } - virtual ~Workflow() throw(); + virtual ~WorkflowModel() throw(); std::string templateId; std::string name; std::string graph; + std::string gatewayId; + std::string createdUser; std::string image; std::vector< ::apache::airavata::model::application::io::InputDataObjectType> workflowInputs; std::vector< ::apache::airavata::model::application::io::OutputDataObjectType> workflowOutputs; + int64_t creationTime; - _Workflow__isset __isset; + _WorkflowModel__isset __isset; void __set_templateId(const std::string& val); @@ -72,21 +113,29 @@ class Workflow { void __set_graph(const std::string& val); + void __set_gatewayId(const std::string& val); + + void __set_createdUser(const std::string& val); + void __set_image(const std::string& val); void __set_workflowInputs(const std::vector< ::apache::airavata::model::application::io::InputDataObjectType> & val); void __set_workflowOutputs(const std::vector< ::apache::airavata::model::application::io::OutputDataObjectType> & val); - bool operator == (const Workflow & rhs) const + void __set_creationTime(const int64_t val); + + bool operator == (const WorkflowModel & rhs) const { if (!(templateId == rhs.templateId)) return false; if (!(name == rhs.name)) return false; - if (__isset.graph != rhs.__isset.graph) + if (!(graph == rhs.graph)) return false; - else if (__isset.graph && !(graph == rhs.graph)) + if (!(gatewayId == rhs.gatewayId)) + return false; + if (!(createdUser == rhs.createdUser)) return false; if (__isset.image != rhs.__isset.image) return false; @@ -100,13 +149,372 @@ class Workflow { return false; else if (__isset.workflowOutputs && !(workflowOutputs == rhs.workflowOutputs)) return false; + if (__isset.creationTime != rhs.__isset.creationTime) + return false; + else if (__isset.creationTime && !(creationTime == rhs.creationTime)) + return false; + return true; + } + bool operator != (const WorkflowModel &rhs) const { + return !(*this == rhs); + } + + bool operator < (const WorkflowModel & ) const; + + uint32_t read(::apache::thrift::protocol::TProtocol* iprot); + uint32_t write(::apache::thrift::protocol::TProtocol* oprot) const; + + virtual void printTo(std::ostream& out) const; +}; + +void swap(WorkflowModel &a, WorkflowModel &b); + +inline std::ostream& operator<<(std::ostream& out, const WorkflowModel& obj) +{ + obj.printTo(out); + return out; +} + +typedef struct _ComponentStatus__isset { + _ComponentStatus__isset() : reason(false), timeofStateChange(false) {} + bool reason :1; + bool timeofStateChange :1; +} _ComponentStatus__isset; + +class ComponentStatus { + public: + + ComponentStatus(const ComponentStatus&); + ComponentStatus& operator=(const ComponentStatus&); + ComponentStatus() : state((ComponentState::type)0), reason(), timeofStateChange(0) { + state = (ComponentState::type)0; + + } + + virtual ~ComponentStatus() throw(); + ComponentState::type state; + std::string reason; + int64_t timeofStateChange; + + _ComponentStatus__isset __isset; + + void __set_state(const ComponentState::type val); + + void __set_reason(const std::string& val); + + void __set_timeofStateChange(const int64_t val); + + bool operator == (const ComponentStatus & rhs) const + { + if (!(state == rhs.state)) + return false; + if (__isset.reason != rhs.__isset.reason) + return false; + else if (__isset.reason && !(reason == rhs.reason)) + return false; + if (__isset.timeofStateChange != rhs.__isset.timeofStateChange) + return false; + else if (__isset.timeofStateChange && !(timeofStateChange == rhs.timeofStateChange)) + return false; + return true; + } + bool operator != (const ComponentStatus &rhs) const { + return !(*this == rhs); + } + + bool operator < (const ComponentStatus & ) const; + + uint32_t read(::apache::thrift::protocol::TProtocol* iprot); + uint32_t write(::apache::thrift::protocol::TProtocol* oprot) const; + + virtual void printTo(std::ostream& out) const; +}; + +void swap(ComponentStatus &a, ComponentStatus &b); + +inline std::ostream& operator<<(std::ostream& out, const ComponentStatus& obj) +{ + obj.printTo(out); + return out; +} + +typedef struct _WorkflowStatus__isset { + _WorkflowStatus__isset() : timeOfStateChange(false), reason(false) {} + bool timeOfStateChange :1; + bool reason :1; +} _WorkflowStatus__isset; + +class WorkflowStatus { + public: + + WorkflowStatus(const WorkflowStatus&); + WorkflowStatus& operator=(const WorkflowStatus&); + WorkflowStatus() : state((WorkflowState::type)0), timeOfStateChange(0), reason() { + } + + virtual ~WorkflowStatus() throw(); + WorkflowState::type state; + int64_t timeOfStateChange; + std::string reason; + + _WorkflowStatus__isset __isset; + + void __set_state(const WorkflowState::type val); + + void __set_timeOfStateChange(const int64_t val); + + void __set_reason(const std::string& val); + + bool operator == (const WorkflowStatus & rhs) const + { + if (!(state == rhs.state)) + return false; + if (__isset.timeOfStateChange != rhs.__isset.timeOfStateChange) + return false; + else if (__isset.timeOfStateChange && !(timeOfStateChange == rhs.timeOfStateChange)) + return false; + if (__isset.reason != rhs.__isset.reason) + return false; + else if (__isset.reason && !(reason == rhs.reason)) + return false; + return true; + } + bool operator != (const WorkflowStatus &rhs) const { + return !(*this == rhs); + } + + bool operator < (const WorkflowStatus & ) const; + + uint32_t read(::apache::thrift::protocol::TProtocol* iprot); + uint32_t write(::apache::thrift::protocol::TProtocol* oprot) const; + + virtual void printTo(std::ostream& out) const; +}; + +void swap(WorkflowStatus &a, WorkflowStatus &b); + +inline std::ostream& operator<<(std::ostream& out, const WorkflowStatus& obj) +{ + obj.printTo(out); + return out; +} + +typedef struct _EdgeModel__isset { + _EdgeModel__isset() : name(false), status(false), description(false) {} + bool name :1; + bool status :1; + bool description :1; +} _EdgeModel__isset; + +class EdgeModel { + public: + + EdgeModel(const EdgeModel&); + EdgeModel& operator=(const EdgeModel&); + EdgeModel() : edgeId("DO_NOT_SET_AT_CLIENTS"), name(), description() { + } + + virtual ~EdgeModel() throw(); + std::string edgeId; + std::string name; + ComponentStatus status; + std::string description; + + _EdgeModel__isset __isset; + + void __set_edgeId(const std::string& val); + + void __set_name(const std::string& val); + + void __set_status(const ComponentStatus& val); + + void __set_description(const std::string& val); + + bool operator == (const EdgeModel & rhs) const + { + if (!(edgeId == rhs.edgeId)) + return false; + if (__isset.name != rhs.__isset.name) + return false; + else if (__isset.name && !(name == rhs.name)) + return false; + if (__isset.status != rhs.__isset.status) + return false; + else if (__isset.status && !(status == rhs.status)) + return false; + if (__isset.description != rhs.__isset.description) + return false; + else if (__isset.description && !(description == rhs.description)) + return false; + return true; + } + bool operator != (const EdgeModel &rhs) const { + return !(*this == rhs); + } + + bool operator < (const EdgeModel & ) const; + + uint32_t read(::apache::thrift::protocol::TProtocol* iprot); + uint32_t write(::apache::thrift::protocol::TProtocol* oprot) const; + + virtual void printTo(std::ostream& out) const; +}; + +void swap(EdgeModel &a, EdgeModel &b); + +inline std::ostream& operator<<(std::ostream& out, const EdgeModel& obj) +{ + obj.printTo(out); + return out; +} + +typedef struct _PortModel__isset { + _PortModel__isset() : name(false), status(false), value(false), description(false) {} + bool name :1; + bool status :1; + bool value :1; + bool description :1; +} _PortModel__isset; + +class PortModel { + public: + + PortModel(const PortModel&); + PortModel& operator=(const PortModel&); + PortModel() : portId("DO_NOT_SET_AT_CLIENTS"), name(), value(), description() { + } + + virtual ~PortModel() throw(); + std::string portId; + std::string name; + ComponentStatus status; + std::string value; + std::string description; + + _PortModel__isset __isset; + + void __set_portId(const std::string& val); + + void __set_name(const std::string& val); + + void __set_status(const ComponentStatus& val); + + void __set_value(const std::string& val); + + void __set_description(const std::string& val); + + bool operator == (const PortModel & rhs) const + { + if (!(portId == rhs.portId)) + return false; + if (__isset.name != rhs.__isset.name) + return false; + else if (__isset.name && !(name == rhs.name)) + return false; + if (__isset.status != rhs.__isset.status) + return false; + else if (__isset.status && !(status == rhs.status)) + return false; + if (__isset.value != rhs.__isset.value) + return false; + else if (__isset.value && !(value == rhs.value)) + return false; + if (__isset.description != rhs.__isset.description) + return false; + else if (__isset.description && !(description == rhs.description)) + return false; + return true; + } + bool operator != (const PortModel &rhs) const { + return !(*this == rhs); + } + + bool operator < (const PortModel & ) const; + + uint32_t read(::apache::thrift::protocol::TProtocol* iprot); + uint32_t write(::apache::thrift::protocol::TProtocol* oprot) const; + + virtual void printTo(std::ostream& out) const; +}; + +void swap(PortModel &a, PortModel &b); + +inline std::ostream& operator<<(std::ostream& out, const PortModel& obj) +{ + obj.printTo(out); + return out; +} + +typedef struct _NodeModel__isset { + _NodeModel__isset() : name(false), applicationId(false), applicationName(false), status(false), description(false) {} + bool name :1; + bool applicationId :1; + bool applicationName :1; + bool status :1; + bool description :1; +} _NodeModel__isset; + +class NodeModel { + public: + + NodeModel(const NodeModel&); + NodeModel& operator=(const NodeModel&); + NodeModel() : nodeId("DO_NOT_SET_AT_CLIENTS"), name(), applicationId(), applicationName(), description() { + } + + virtual ~NodeModel() throw(); + std::string nodeId; + std::string name; + std::string applicationId; + std::string applicationName; + ComponentStatus status; + std::string description; + + _NodeModel__isset __isset; + + void __set_nodeId(const std::string& val); + + void __set_name(const std::string& val); + + void __set_applicationId(const std::string& val); + + void __set_applicationName(const std::string& val); + + void __set_status(const ComponentStatus& val); + + void __set_description(const std::string& val); + + bool operator == (const NodeModel & rhs) const + { + if (!(nodeId == rhs.nodeId)) + return false; + if (__isset.name != rhs.__isset.name) + return false; + else if (__isset.name && !(name == rhs.name)) + return false; + if (__isset.applicationId != rhs.__isset.applicationId) + return false; + else if (__isset.applicationId && !(applicationId == rhs.applicationId)) + return false; + if (__isset.applicationName != rhs.__isset.applicationName) + return false; + else if (__isset.applicationName && !(applicationName == rhs.applicationName)) + return false; + if (__isset.status != rhs.__isset.status) + return false; + else if (__isset.status && !(status == rhs.status)) + return false; + if (__isset.description != rhs.__isset.description) + return false; + else if (__isset.description && !(description == rhs.description)) + return false; return true; } - bool operator != (const Workflow &rhs) const { + bool operator != (const NodeModel &rhs) const { return !(*this == rhs); } - bool operator < (const Workflow & ) const; + bool operator < (const NodeModel & ) const; uint32_t read(::apache::thrift::protocol::TProtocol* iprot); uint32_t write(::apache::thrift::protocol::TProtocol* oprot) const; @@ -114,9 +522,9 @@ class Workflow { virtual void printTo(std::ostream& out) const; }; -void swap(Workflow &a, Workflow &b); +void swap(NodeModel &a, NodeModel &b); -inline std::ostream& operator<<(std::ostream& out, const Workflow& obj) +inline std::ostream& operator<<(std::ostream& out, const NodeModel& obj) { obj.printTo(out); return out;
http://git-wip-us.apache.org/repos/asf/airavata/blob/4c790770/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 8529b1a..df39f6f 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 @@ -194,6 +194,7 @@ interface AiravataIf { */ public function getSSHPubKey(\Airavata\Model\Security\AuthzToken $authzToken, $airavataCredStoreToken, $gatewayId); /** + * * Get a Public Key by Providing the Token * * @param CredStoreToken @@ -215,6 +216,7 @@ interface AiravataIf { */ public function getAllUserSSHPubKeys(\Airavata\Model\Security\AuthzToken $authzToken, $userName); /** + * * Get all Public Keys of the Gateway * * @param CredStoreToken @@ -236,6 +238,7 @@ interface AiravataIf { */ public function getAllGatewaySSHPubKeys(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId); /** + * * Delete a Gateway * * @param gatewayId @@ -256,6 +259,7 @@ interface AiravataIf { */ public function deleteSSHPubKey(\Airavata\Model\Security\AuthzToken $authzToken, $airavataCredStoreToken, $gatewayId); /** + * * Creates a Project with basic metadata. * A Project is a container of experiments. * @@ -263,7 +267,7 @@ interface AiravataIf { * The identifier for the requested gateway. * * @param Project - * The Project Object described in the workspace_model + * The Project Object described in the workspace_model. * * * @@ -278,6 +282,7 @@ interface AiravataIf { */ public function createProject(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\Workspace\Project $project); /** + * * Update an Existing Project * * @param projectId @@ -299,14 +304,15 @@ 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 + * This method is to obtain a project by providing a projectId. * * @param projectId - * projectId of the project you require + * projectId of the project you require. * * @return project - * project data model will be returned + * project data model will be returned. * * * @@ -321,15 +327,18 @@ interface AiravataIf { */ public function getProject(\Airavata\Model\Security\AuthzToken $authzToken, $projectId); /** + * * Delete a Project - * This method is used to delete an existing Project + * This method is used to delete an existing Project. * * @param projectId - * projectId of the project you want to delete + * projectId of the project you want to delete. * * @return boolean * Boolean identifier for the success or failure of the deletion operation. * + * NOTE: This method is not used within gateways connected with Airavata. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -343,20 +352,21 @@ 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 + * + * Get All User Projects + * Get all Project for the user with pagination. Results will be ordered based on creation time DESC. * * @param gatewayId * The identifier for the requested gateway. * * @param userName - * The identifier of the user + * The identifier of the user. * * @param limit - * The amount results to be fetched + * The amount results to be fetched. * * @param offset - * The starting point of the results to be fetched + * The starting point of the results to be fetched. * * * @@ -373,19 +383,25 @@ interface AiravataIf { */ public function getUserProjects(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $userName, $limit, $offset); /** - * Get all Project for user by project name with pagination.Results will be ordered based - * on creation time DESC + * + * Search User Projects by Project Name + * Get all Project for user by project name with pagination.Results will be ordered based on creation time DESC. * * @param gatewayId - * The identifier for the requested gateway. + * The unique identifier for the requested gateway. + * * @param userName - * The identifier of the user + * The identifier of the user. + * * @param projectName - * The name of the project on which the results to be fetched + * The name of the project on which the results to be fetched. + * * @param limit - * The amount results to be fetched + * The amount results to be fetched. + * * @param offset - * The starting point of the results to be fetched + * The starting point of the results to be fetched. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -402,19 +418,25 @@ interface AiravataIf { */ public function searchProjectsByProjectName(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $userName, $projectName, $limit, $offset); /** - * Search and get all Projects for user by project description with pagination. Results - * will be ordered based on creation time DESC + * + * Search User Projects by Project Description + * Search and get all Projects for user by project description with pagination. Results will be ordered based on creation time DESC. * * @param gatewayId - * The identifier for the requested gateway. + * The unique identifier of the gateway making the request. + * * @param userName - * The identifier of the user + * The identifier of the user. + * * @param description - * The description to be matched + * The description to be matched. + * * @param limit - * The amount results to be fetched + * The amount results to be fetched. + * * @param offset - * The starting point of the results to be fetched + * The starting point of the results to be fetched. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -431,19 +453,25 @@ interface AiravataIf { */ public function searchProjectsByProjectDesc(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $userName, $description, $limit, $offset); /** - * Search Experiments by experiment name with pagination. Results will be sorted - * based on creation time DESC + * + * Search User Experiments by Name + * Search user Experiments using experiment name with pagination. Results will be sorted based on creation time DESC. * * @param gatewayId - * Identifier of the requested gateway + * Unique identifier of the requested gateway. + * * @param userName - * Username of the requested user + * Username of the user who created the experiments. + * * @param expName - * Experiment name to be matched + * Experiment name to be matched. + * * @param limit - * Amount of results to be fetched + * Amount of results to be fetched. + * * @param offset - * The starting point of the results to be fetched + * The starting point of the results to be fetched. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -460,19 +488,25 @@ interface AiravataIf { */ public function searchExperimentsByName(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $userName, $expName, $limit, $offset); /** - * Search Experiments by experiment name with pagination. Results will be sorted - * based on creation time DESC + * + * Search By Experiment Description + * Search Experiments by experiment description with pagination. Results will be sorted based on creation time DESC. * * @param gatewayId - * Identifier of the requested gateway + * Unique identifier of the requested gateway. + * * @param userName - * Username of the requested user + * Username of the requested user. + * * @param description - * Experiment description to be matched + * Experiment description to be matched. + * * @param limit - * Amount of results to be fetched + * Amount of results to be fetched. + * * @param offset - * The starting point of the results to be fetched + * The starting point of the results to be fetched. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -489,19 +523,25 @@ interface AiravataIf { */ public function searchExperimentsByDesc(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $userName, $description, $limit, $offset); /** - * Search Experiments by application id with pagination. Results will be sorted - * based on creation time DESC + * + * Search Experiment By the Application + * Search Experiments of a particular application id with pagination. Results will be sorted based on creation time DESC * * @param gatewayId - * Identifier of the requested gateway + * Unique identifier of the requested gateway. + * * @param userName - * Username of the requested user + * Username of the requested user. + * * @param applicationId - * Application id to be matched + * Application id to be matched. + * * @param limit - * Amount of results to be fetched + * Amount of results to be fetched. + * * @param offset - * The starting point of the results to be fetched + * The starting point of the results to be fetched. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -518,19 +558,25 @@ interface AiravataIf { */ public function searchExperimentsByApplication(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $userName, $applicationId, $limit, $offset); /** - * Search Experiments by experiment status with pagination. Results will be sorted - * based on creation time DESC + * + * Search User Experiments by Status + * Search all the Experiments of the given user by experiment status with pagination. Results will be sorted based on creation time DESC * * @param gatewayId - * Identifier of the requested gateway + * Unique identifier of the requested gateway. + * * @param userName - * Username of the requested user + * Username of the user making the request. + * * @param experimentState - * Experiement state to be matched + * Experiement state to be matched. + * * @param limit - * Amount of results to be fetched + * Amount of results to be fetched. + * * @param offset - * The starting point of the results to be fetched + * The starting point of the results to be fetched. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -547,21 +593,31 @@ interface AiravataIf { */ public function searchExperimentsByStatus(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $userName, $experimentState, $limit, $offset); /** - * Search Experiments by experiment creation time with pagination. Results will be sorted - * based on creation time DESC + * + * Search User Experiments by the Creation Time + * This will search all the experiments of the given user by experiment creation time with pagination. Results will be sorted based on creation time DESC. * * @param gatewayId - * Identifier of the requested gateway + * Unique identifier of the requested gateway. + * * @param userName - * Username of the requested user + * Username of the requested user. + * * @param fromTime - * Start time of the experiments creation time + * Start time of the experiments creation time. + * * @param toTime - * End time of the experiement creation time + * End time of the experiement creation time. + * * @param limit - * Amount of results to be fetched + * Amount of results to be fetched. + * * @param offset - * The starting point of the results to be fetched + * The starting point of the results to be fetched. + * + * @return ExperimentSummaryModel + * List of experiments for the given search filter. Here only the Experiment summary will be returned. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -579,19 +635,27 @@ interface AiravataIf { */ public function searchExperimentsByCreationTime(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $userName, $fromTime, $toTime, $limit, $offset); /** - * Search Experiments by using multiple filter criteria with pagination. Results will be sorted - * based on creation time DESC + * Search Experiments. + * Search Experiments by using multiple filter criteria with pagination. Results will be sorted based on creation time DESC. * * @param gatewayId - * Identifier of the requested gateway + * Identifier of the requested gateway. + * * @param userName - * Username of the requested user + * Username of the user requesting the search function. + * * @param filters - * map of multiple filter criteria. + * Map of multiple filter criteria. Currenlt search filters includes Experiment Name, Description, Application, etc.... + * * @param limit - * Amount of results to be fetched + * Amount of results to be fetched. + * * @param offset - * The starting point of the results to be fetched + * The starting point of the results to be fetched. + * + * @return ExperimentSummaryModel + * List of experiments for the given search filter. Here only the Experiment summary will be returned. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -608,13 +672,19 @@ interface AiravataIf { */ public function searchExperiments(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $userName, array $filters, $limit, $offset); /** - * Get Experiment Statisitics for the given gateway for a specific time period + * + * Get Experiment Statistics + * Get Experiment Statisitics for a given gateway for a specific time period. This feature is available only for admins of a particular gateway. Gateway admin access is managed by the user roles. + * * @param gatewayId - * Identifier of the requested gateway + * Unique identifier of the gateway making the request to fetch statistics. + * * @param fromTime - * Starting date time + * Starting date time. + * * @param toTime - * Ending data time + * Ending data time. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -629,15 +699,19 @@ interface AiravataIf { */ public function getExperimentStatistics(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $fromTime, $toTime); /** - * Get Experiments within project with pagination. Results will be sorted - * based on creation time DESC + * + * Get All Experiments of the Project + * Get Experiments within project with pagination. Results will be sorted based on creation time DESC. * * @param projectId - * Identifier of the project + * Uniqie identifier of the project. + * * @param limit - * Amount of results to be fetched + * Amount of results to be fetched. + * * @param offset - * The starting point of the results to be fetched + * The starting point of the results to be fetched. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -653,17 +727,22 @@ interface AiravataIf { */ public function getExperimentsInProject(\Airavata\Model\Security\AuthzToken $authzToken, $projectId, $limit, $offset); /** - * Get experiments by user with pagination. Results will be sorted - * based on creation time DESC + * + * Get All Experiments of the User + * Get experiments by user with pagination. Results will be sorted based on creation time DESC. * * @param gatewayId - * Identifier of the requesting gateway + * Identifier of the requesting gateway. + * * @param userName - * Username of the requested user + * Username of the requested end user. + * * @param limit - * Amount of results to be fetched + * Amount of results to be fetched. + * * @param offset - * The starting point of the results to be fetched + * The starting point of the results to be fetched. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -679,12 +758,17 @@ interface AiravataIf { */ public function getUserExperiments(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, $userName, $limit, $offset); /** + * * + * * Create New Experiment * * Create an experiment for the specified user belonging to the gateway. The gateway identity is not explicitly passed * * but inferred from the sshKeyAuthentication header. This experiment is just a persistent place holder. The client * * has to subsequently configure and launch the created experiment. No action is taken on Airavata Server except * * registering the experiment in a persistent store. * * - * * @param basicExperimentMetadata + * * @param gatewayId + * * The unique ID of the gateway where the experiment is been created. + * * + * * @param ExperimentModel * * The create experiment will require the basic experiment metadata like the name and description, intended user, * * the gateway identifer and if the experiment should be shared public by defualt. During the creation of an experiment * * the ExperimentMetadata is a required field. @@ -725,8 +809,8 @@ interface AiravataIf { */ public function createExperiment(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\Experiment\ExperimentModel $experiment); /** - * Delete an Experiment * + * Delete an Experiment * If the experiment is not already launched experiment can be deleted. * * @param authzToken @@ -735,7 +819,7 @@ interface AiravataIf { * Experiment ID of the experimnet you want to delete. * * @return boolean - * Identifier for the success or failure of the deletion operation + * Identifier for the success or failure of the deletion operation. * * * @@ -749,12 +833,14 @@ interface AiravataIf { */ public function deleteExperiment(\Airavata\Model\Security\AuthzToken $authzToken, $experimentId); /** + * * + * * Get Experiment * * Fetch previously created experiment metadata. * * * * @param airavataExperimentId - * * The identifier for the requested experiment. This is returned during the create experiment step. + * * The unique identifier of the requested experiment. This ID is returned during the create experiment step. * * - * * @return experimentMetada + * * @return ExperimentModel * * This method will return the previously stored experiment metadata. * * * * @throws org.apache.airavata.model.error.InvalidRequestException @@ -807,14 +893,17 @@ interface AiravataIf { */ public function getExperiment(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId); /** + * + * Get Complete Experiment Details * Fetch the completed nested tree structue of previously created experiment metadata which includes processes -> * tasks -> jobs information. * * @param airavataExperimentId * The identifier for the requested experiment. This is returned during the create experiment step. * - * @return experimentMetada - * This method will return the previously stored experiment metadata. + * @return ExperimentModel + * This method will return the previously stored experiment metadata including application input parameters, computational resource scheduling + * information, special input output handling and additional quality of service parameters. * * @throws org.apache.airavata.model.error.InvalidRequestException * For any incorrect forming of the request itself. @@ -865,14 +954,15 @@ interface AiravataIf { */ public function getDetailedExperimentTree(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId); /** - * Configure a previously created experiment with required inputs, scheduling and other quality of service - * parameters. This method only updates the experiment object within the registry. The experiment has to be launched - * to make it actionable by the server. + * + * Update a Previously Created Experiment + * Configure the CREATED experiment with required inputs, scheduling and other quality of service parameters. This method only updates the experiment object within the registry. + * The experiment has to be launched to make it actionable by the server. * * @param airavataExperimentId * The identifier for the requested experiment. This is returned during the create experiment step. * - * @param experimentConfigurationData + * @param ExperimentModel * The configuration information of the experiment with application input parameters, computational resource scheduling * information, special input output handling and additional quality of service parameters. * @@ -929,13 +1019,14 @@ interface AiravataIf { public function updateResourceScheduleing(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId, \Airavata\Model\Scheduling\ComputationalResourceSchedulingModel $resourceScheduling); /** * * - * * Validate experiment configuration. A true in general indicates, the experiment is ready to be launched. - * * - * * @param experimentId + * * Validate experiment configuration. + * * A true in general indicates, the experiment is ready to be launched. * * + * * @param airavataExperimentId + * * Unique identifier of the experiment (Experimnent ID) of the experiment which need to be validated. * * * * @return boolean - * * Identifier for the success or failure of the validation operation + * * Identifier for the success or failure of the validation operation. * * * * * @@ -950,8 +1041,12 @@ interface AiravataIf { */ public function validateExperiment(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId); /** - * Launch a previously created and configured experiment. Airavata Server will then start processing the request and appropriate - * notifications and intermediate and output data will be subsequently available for this experiment. + * + * Launch a Previously Created & Configured Experiment. + * Airavata Server will then start processing the request and appropriate notifications and intermediate and output data will be subsequently available for this experiment. + * + * @gatewayId + * ID of the gateway which will launch the experiment. * * @param airavataExperimentId * The identifier for the requested experiment. This is returned during the create experiment step. @@ -994,17 +1089,18 @@ 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 + * Obtain the status of an experiment by providing the Experiment Id * * @param authzToken * - * @param experiementId - * Experiment ID of the experimnet you require the status + * @param airavataExperimentId + * Experiment ID of the experimnet you require the status. * * @return ExperimentStatus - * ExperimentStatus model with current status will be returned. + * ExperimentStatus model with the current status will be returned. * * * @@ -1030,16 +1126,17 @@ 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 + * This method to be used when need to obtain final outputs of a certain Experiment * * @param authzToken * - * @param experiementId - * Experiment ID of the experimnet you need the outputs + * @param airavataExperimentId + * Experiment ID of the experimnet you need the outputs. * * @return list - * List of experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment + * List of experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment. * * * @@ -1054,16 +1151,17 @@ 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 + * @param airavataExperimentId + * Experiment ID of the experimnet you need intermediate outputs. * * @return list - * List of intermediate experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment + * List of intermediate experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment. * * * @@ -1078,13 +1176,14 @@ interface AiravataIf { */ public function getIntermediateOutputs(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId); /** - * Get Job Status for an Experiment + * + * Get Job Statuses for an Experiment * This method to be used when need to get the job status of an Experiment. An experiment may have one or many jobs; there for one or many job statuses may turnup * * @param authzToken * * @param experiementId - * Experiment ID of the experimnet you need the intermediate outputs + * Experiment ID of the experimnet you need the job statuses. * * @return JobStatus * Job status (string) for all all the existing jobs for the experiment will be returned in the form of a map @@ -1102,16 +1201,17 @@ interface AiravataIf { */ public function getJobStatuses(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId); /** - * Get Job Details for all the jobs within an Experiment + * + * Get Job Details for all the jobs within an Experiment. * This method to be used when need to get the job details for one or many jobs of an Experiment. * * @param authzToken * * @param experiementId - * Experiment ID of the experimnet you need job details + * Experiment ID of the experimnet you need job details. * * @return list of JobDetails - * Job details + * Job details. * * * @@ -1126,7 +1226,9 @@ interface AiravataIf { */ public function getJobDetails(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId); /** - * Clone an specified experiment with a new name. A copy of the experiment configuration is made and is persisted with new metadata. + * + * Clone an Existing Experiment + * Existing specified experiment is cloned and a new name is provided. A copy of the experiment configuration is made and is persisted with new metadata. * The client has to subsequently update this configuration if needed and launch the cloned experiment. * * @param newExperimentName @@ -1138,7 +1240,7 @@ interface AiravataIf { * should be shared public by default. * * @return - * The server-side generated.airavata.registry.core.experiment.globally unique identifier for the newly cloned experiment. + * The server-side generated.airavata.registry.core.experiment.globally unique identifier (Experiment ID) for the newly cloned experiment. * * @throws org.apache.airavata.model.error.InvalidRequestException * For any incorrect forming of the request itself. @@ -1176,12 +1278,16 @@ interface AiravataIf { */ public function cloneExperiment(\Airavata\Model\Security\AuthzToken $authzToken, $existingExperimentID, $newExperimentName); /** - * Terminate a running experiment. + * + * Terminate a running Experiment. + * + * @gatewayId + * ID of the gateway which will terminate the running Experiment. * * @param airavataExperimentId - * The identifier for the requested experiment. This is returned during the create experiment step. + * The identifier of the experiment required termination. This ID is returned during the create experiment step. * - * @return + * @return status * This method call does not have a return value. * * @throws org.apache.airavata.model.error.InvalidRequestException @@ -1219,13 +1325,17 @@ interface AiravataIf { */ public function terminateExperiment(\Airavata\Model\Security\AuthzToken $authzToken, $airavataExperimentId, $gatewayId); /** + * * Register a Application Module. * + * @gatewayId + * ID of the gateway which is registering the new Application Module. + * * @param applicationModule * Application Module Object created from the datamodel. * * @return appModuleId - * Returns a server-side generated airavata appModule globally unique identifier. + * Returns the server-side generated airavata appModule globally unique identifier. * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -1239,13 +1349,14 @@ interface AiravataIf { */ public function registerApplicationModule(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\AppCatalog\AppDeployment\ApplicationModule $applicationModule); /** + * * Fetch a Application Module. * * @param appModuleId - * The identifier for the requested application module + * The unique identifier of the application module required * * @return applicationModule - * Returns a application Module Object. + * Returns an Application Module Object. * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -1271,6 +1382,7 @@ interface AiravataIf { */ public function getApplicationModule(\Airavata\Model\Security\AuthzToken $authzToken, $appModuleId); /** + * * Update a Application Module. * * @param appModuleId @@ -1294,6 +1406,16 @@ interface AiravataIf { */ public function updateApplicationModule(\Airavata\Model\Security\AuthzToken $authzToken, $appModuleId, \Airavata\Model\AppCatalog\AppDeployment\ApplicationModule $applicationModule); /** + * + * Fetch all Application Module Descriptions. + * + * @param gatewayId + * ID of the gateway which need to list all available application deployment documentation. + * + * @return list + * Returns the list of all Application Module Objects. + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @return \Airavata\Model\AppCatalog\AppDeployment\ApplicationModule[] @@ -1304,10 +1426,11 @@ interface AiravataIf { */ public function getAllAppModules(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId); /** - * Delete a Application Module. + * + * Delete an Application Module. * * @param appModuleId - * The identifier for the requested application module to be deleted. + * The identifier of the Application Module to be deleted. * * @return status * Returns a success/failure of the deletion. @@ -1323,9 +1446,13 @@ interface AiravataIf { */ public function deleteApplicationModule(\Airavata\Model\Security\AuthzToken $authzToken, $appModuleId); /** - * Register a Application Deployment. * - * @param applicationModule + * Register an Application Deployment. + * + * @param gatewayId + * ID of the gateway which is registering the new Application Deployment. + * + * @param applicationDeployment * Application Module Object created from the datamodel. * * @return appDeploymentId @@ -1343,6 +1470,7 @@ interface AiravataIf { */ public function registerApplicationDeployment(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\AppCatalog\AppDeployment\ApplicationDeploymentDescription $applicationDeployment); /** + * * Fetch a Application Deployment. * * @param appDeploymentId @@ -1386,10 +1514,11 @@ interface AiravataIf { */ public function getApplicationDeployment(\Airavata\Model\Security\AuthzToken $authzToken, $appDeploymentId); /** - * Update a Application Deployment. + * + * Update an Application Deployment. * * @param appDeploymentId - * The identifier for the requested application deployment to be updated. + * The identifier of the requested application deployment to be updated. * * @param appDeployment * Application Deployment Object created from the datamodel. @@ -1409,10 +1538,11 @@ interface AiravataIf { */ public function updateApplicationDeployment(\Airavata\Model\Security\AuthzToken $authzToken, $appDeploymentId, \Airavata\Model\AppCatalog\AppDeployment\ApplicationDeploymentDescription $applicationDeployment); /** - * Delete a Application deployment. + * + * Delete an Application Deployment. * * @param appDeploymentId - * The identifier for the requested application deployment to be deleted. + * The unique identifier of application deployment to be deleted. * * @return status * Returns a success/failure of the deletion. @@ -1428,10 +1558,14 @@ interface AiravataIf { */ public function deleteApplicationDeployment(\Airavata\Model\Security\AuthzToken $authzToken, $appDeploymentId); /** + * * Fetch all Application Deployment Descriptions. * + * @param gatewayId + * ID of the gateway which need to list all available application deployment documentation. + * * @return list<applicationDeployment. - * Returns the list of all application Deployment Objects. + * Returns the list of all application Deployment Objects. * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -1463,9 +1597,10 @@ interface AiravataIf { */ public function getAppModuleDeployedResources(\Airavata\Model\Security\AuthzToken $authzToken, $appModuleId); /** + * * Register a Application Interface. * - * @param applicationModule + * @param applicationInterface * Application Module Object created from the datamodel. * * @return appInterfaceId @@ -1483,6 +1618,22 @@ interface AiravataIf { */ public function registerApplicationInterface(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\AppCatalog\AppInterface\ApplicationInterfaceDescription $applicationInterface); /** + * + * Clone an Application Interface. + * + * @gatewayId + * The identifier for the gateway profile to be requested + * + * @param existingAppInterfaceID + * Identifier of the existing Application interface you wich to clone. + * + * @param newApplicationName + * Name for the new application interface. + * + * @return appInterfaceId + * Returns a server-side generated globally unique identifier for the newly cloned application interface. + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $existingAppInterfaceID * @param string $newApplicationName @@ -1495,14 +1646,14 @@ interface AiravataIf { */ public function cloneApplicationInterface(\Airavata\Model\Security\AuthzToken $authzToken, $existingAppInterfaceID, $newApplicationName, $gatewayId); /** - * Fetch a Application Interface. + * + * Fetch an Application Interface. * * @param appInterfaceId - * The identifier for the requested application module + * The identifier for the requested application interface. * * @return applicationInterface - * Returns a application Interface Object. - * + * Returns an application Interface Object. * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -1526,10 +1677,11 @@ interface AiravataIf { */ public function getApplicationInterface(\Airavata\Model\Security\AuthzToken $authzToken, $appInterfaceId); /** + * * Update a Application Interface. * * @param appInterfaceId - * The identifier for the requested application deployment to be updated. + * The identifier of the requested application deployment to be updated. * * @param appInterface * Application Interface Object created from the datamodel. @@ -1538,7 +1690,6 @@ interface AiravataIf { * Returns a success/failure of the update. * * - * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $appInterfaceId * @param \Airavata\Model\AppCatalog\AppInterface\ApplicationInterfaceDescription $applicationInterface @@ -1550,7 +1701,8 @@ interface AiravataIf { */ public function updateApplicationInterface(\Airavata\Model\Security\AuthzToken $authzToken, $appInterfaceId, \Airavata\Model\AppCatalog\AppInterface\ApplicationInterfaceDescription $applicationInterface); /** - * Delete a Application Interface. + * + * Delete an Application Interface. * * @param appInterfaceId * The identifier for the requested application interface to be deleted. @@ -1559,7 +1711,6 @@ interface AiravataIf { * Returns a success/failure of the deletion. * * - * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $appInterfaceId * @return bool @@ -1570,11 +1721,12 @@ interface AiravataIf { */ public function deleteApplicationInterface(\Airavata\Model\Security\AuthzToken $authzToken, $appInterfaceId); /** - * Fetch name and id of Application Interface documents. + * + * Fetch name and ID of Application Interface documents. * * * @return map<applicationId, applicationInterfaceNames> - * Returns a list of application interfaces with corresponsing id's + * Returns a list of application interfaces with corresponsing ID's * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -1587,11 +1739,12 @@ interface AiravataIf { */ public function getAllApplicationInterfaceNames(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId); /** + * * Fetch all Application Interface documents. * * * @return map<applicationId, applicationInterfaceNames> - * Returns a list of application interfaces documents + * Returns a list of application interfaces documents (Application Interface ID, name, description, Inputs and Outputs objects). * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -1604,10 +1757,11 @@ interface AiravataIf { */ public function getAllApplicationInterfaces(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId); /** + * * Fetch the list of Application Inputs. * * @param appInterfaceId - * The identifier for the requested application interface + * The identifier of the application interface which need inputs to be fetched. * * @return list<application_interface_model.InputDataObjectType> * Returns a list of application inputs. @@ -1623,10 +1777,11 @@ interface AiravataIf { */ public function getApplicationInputs(\Airavata\Model\Security\AuthzToken $authzToken, $appInterfaceId); /** - * Fetch the list of Application Outputs. + * + * Fetch list of Application Outputs. * * @param appInterfaceId - * The identifier for the requested application interface + * The identifier of the application interface which need outputs to be fetched. * * @return list<application_interface_model.OutputDataObjectType> * Returns a list of application outputs. @@ -1642,14 +1797,15 @@ interface AiravataIf { */ public function getApplicationOutputs(\Airavata\Model\Security\AuthzToken $authzToken, $appInterfaceId); /** + * * Fetch a list of all deployed Compute Hosts for a given application interfaces. * * @param appInterfaceId - * The identifier for the requested application interface + * The identifier for the requested application interface. * * @return map<computeResourceId, computeResourceName> * A map of registered compute resource id's and their corresponding hostnames. - * Deployments of each modules listed within the interfaces will be listed. + * Deployments of each modules listed within the interfaces will be listed. * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -1727,6 +1883,7 @@ interface AiravataIf { */ public function getComputeResource(\Airavata\Model\Security\AuthzToken $authzToken, $computeResourceId); /** + * * Fetch all registered Compute Resources. * * @return A map of registered compute resource id's and thier corresponding hostnames. @@ -1852,7 +2009,7 @@ interface AiravataIf { */ public function getAllStorageResourceNames(\Airavata\Model\Security\AuthzToken $authzToken); /** - * Update a Compute Resource. + * Update a Storage Resource. * * @param storageResourceId * The identifier for the requested compute resource to be updated. @@ -1878,7 +2035,7 @@ interface AiravataIf { * Delete a Storage Resource. * * @param storageResourceId - * The identifier for the requested compute resource to be deleted. + * The identifier of the requested compute resource to be deleted. * * @return status * Returns a success/failure of the deletion. @@ -2054,6 +2211,7 @@ interface AiravataIf { */ public function getSSHJobSubmission(\Airavata\Model\Security\AuthzToken $authzToken, $jobSubmissionId); /** + * * Add a UNICORE Job Submission details to a compute resource * App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. * @@ -2082,10 +2240,13 @@ interface AiravataIf { */ public function addUNICOREJobSubmissionDetails(\Airavata\Model\Security\AuthzToken $authzToken, $computeResourceId, $priorityOrder, \Airavata\Model\AppCatalog\ComputeResource\UnicoreJobSubmission $unicoreJobSubmission); /** + * * * * This method returns UnicoreJobSubmission object + * * * * @param jobSubmissionInterfaceId * * The identifier of the JobSubmission Interface to be retrieved. * * @return UnicoreJobSubmission instance + * * * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -2104,6 +2265,7 @@ interface AiravataIf { */ public function getUnicoreJobSubmission(\Airavata\Model\Security\AuthzToken $authzToken, $jobSubmissionId); /** + * * * * Add a Cloud Job Submission details to a compute resource * * App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces. * * @@ -2118,6 +2280,7 @@ interface AiravataIf { * * * * @return status * * Returns the unique job submission id. + * * * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -2132,6 +2295,7 @@ interface AiravataIf { */ public function addCloudJobSubmissionDetails(\Airavata\Model\Security\AuthzToken $authzToken, $computeResourceId, $priorityOrder, \Airavata\Model\AppCatalog\ComputeResource\CloudJobSubmission $cloudSubmission); /** + * * * * This method returns cloudJobSubmission object * * @param jobSubmissionInterfaceI * * The identifier of the JobSubmission Interface to be retrieved. @@ -2151,6 +2315,7 @@ interface AiravataIf { */ public function getCloudJobSubmission(\Airavata\Model\Security\AuthzToken $authzToken, $jobSubmissionId); /** + * * Update the given SSH Job Submission details * * @param jobSubmissionInterfaceId @@ -2174,6 +2339,7 @@ interface AiravataIf { */ public function updateSSHJobSubmissionDetails(\Airavata\Model\Security\AuthzToken $authzToken, $jobSubmissionInterfaceId, \Airavata\Model\AppCatalog\ComputeResource\SSHJobSubmission $sshJobSubmission); /** + * * Update the cloud Job Submission details * * @param jobSubmissionInterfaceId @@ -2197,6 +2363,7 @@ 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 @@ -2221,6 +2388,7 @@ interface AiravataIf { */ public function updateUnicoreJobSubmissionDetails(\Airavata\Model\Security\AuthzToken $authzToken, $jobSubmissionInterfaceId, \Airavata\Model\AppCatalog\ComputeResource\UnicoreJobSubmission $unicoreJobSubmission); /** + * * Add a Local data movement details to a compute resource * App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. * @@ -2254,6 +2422,7 @@ interface AiravataIf { */ public function addLocalDataMovementDetails(\Airavata\Model\Security\AuthzToken $authzToken, $resourceId, $dataMoveType, $priorityOrder, \Airavata\Model\Data\Movement\LOCALDataMovement $localDataMovement); /** + * * Update the given Local data movement details * * @param dataMovementInterfaceId @@ -2278,7 +2447,8 @@ interface AiravataIf { */ public function updateLocalDataMovementDetails(\Airavata\Model\Security\AuthzToken $authzToken, $dataMovementInterfaceId, \Airavata\Model\Data\Movement\LOCALDataMovement $localDataMovement); /** - * This method returns local datamovement object + * + * This method returns local datamovement object. * * @param dataMovementId * The identifier of the datamovement Interface to be retrieved. @@ -2304,6 +2474,7 @@ interface AiravataIf { */ public function getLocalDataMovement(\Airavata\Model\Security\AuthzToken $authzToken, $dataMovementId); /** + * * Add a SCP data movement details to a compute resource * App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. * @@ -2333,6 +2504,7 @@ interface AiravataIf { */ public function addSCPDataMovementDetails(\Airavata\Model\Security\AuthzToken $authzToken, $resourceId, $dataMoveType, $priorityOrder, \Airavata\Model\Data\Movement\SCPDataMovement $scpDataMovement); /** + * * Update the given scp data movement details * App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. * @@ -2383,6 +2555,7 @@ 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. * @@ -2412,6 +2585,7 @@ 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. * @@ -2437,6 +2611,7 @@ 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 @@ -2460,6 +2635,7 @@ interface AiravataIf { */ public function getUnicoreDataMovement(\Airavata\Model\Security\AuthzToken $authzToken, $dataMovementId); /** + * * Add a GridFTP data movement details to a compute resource * App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces. * @@ -2777,7 +2953,7 @@ interface AiravataIf { * Fetch the given Gateway Resource Profile. * * @param gatewayID - * The identifier for the requested gateway resource + * The identifier for the requested gateway resource. * * @return gatewayResourceProfile * Gateway Resource Profile Object. @@ -2874,6 +3050,22 @@ interface AiravataIf { */ public function addGatewayComputeResourcePreference(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayID, $computeResourceId, \Airavata\Model\AppCatalog\GatewayProfile\ComputeResourcePreference $computeResourcePreference); /** + * Add a Storage Resource Preference to a registered gateway profile. + * + * @param gatewayID + * The identifier of the gateway profile to be added. + * + * @param storageResourceId + * Preferences related to a particular compute resource + * + * @param computeResourcePreference + * The ComputeResourcePreference object to be added to the resource profile. + * + * @return status + * Returns a success/failure of the addition. If a profile already exists, this operation will fail. + * Instead an update should be used. + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayID * @param string $storageResourceId @@ -2886,6 +3078,7 @@ interface AiravataIf { */ public function addGatewayStoragePreference(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayID, $storageResourceId, \Airavata\Model\AppCatalog\GatewayProfile\StoragePreference $storagePreference); /** + * * Fetch a Compute Resource Preference of a registered gateway profile. * * @param gatewayID @@ -2941,6 +3134,19 @@ interface AiravataIf { */ public function getGatewayComputeResourcePreference(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayID, $computeResourceId); /** + * + * Fetch a Storage Resource Preference of a registered gateway profile. + * + * @param gatewayID + * The identifier of the gateway profile to request to fetch the particular storage resource preference. + * + * @param storageResourceId + * Identifier of the Stprage Preference required to be fetched. + * + * @return StoragePreference + * Returns the StoragePreference object. + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayID * @param string $storageResourceId @@ -2952,6 +3158,7 @@ interface AiravataIf { */ public function getGatewayStoragePreference(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayID, $storageResourceId); /** + * * Fetch all Compute Resource Preferences of a registered gateway profile. * * @param gatewayID @@ -2971,6 +3178,15 @@ interface AiravataIf { */ public function getAllGatewayComputeResourcePreferences(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayID); /** + * Fetch all Storage Resource Preferences of a registered gateway profile. + * + * @param gatewayID + * The identifier for the gateway profile to be requested + * + * @return StoragePreference + * Returns the StoragePreference object. + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayID * @return \Airavata\Model\AppCatalog\GatewayProfile\StoragePreference[] @@ -2981,7 +3197,12 @@ interface AiravataIf { */ public function getAllGatewayStoragePreferences(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayID); /** - * Fetch all gateway profiles registered + * + * Fetch all Gateway Profiles registered + * + * @return GatewayResourceProfile + * Returns all the GatewayResourcePrifle list object. + * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -3020,6 +3241,21 @@ interface AiravataIf { */ public function updateGatewayComputeResourcePreference(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayID, $computeResourceId, \Airavata\Model\AppCatalog\GatewayProfile\ComputeResourcePreference $computeResourcePreference); /** + * Update a Storage Resource Preference of a registered gateway profile. + * + * @param gatewayID + * The identifier of the gateway profile to be updated. + * + * @param storageId + * The Storage resource identifier of the one that you want to update + * + * @param storagePreference + * The storagePreference object to be updated to the resource profile. + * + * @return status + * Returns a success/failure of the updation. + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayID * @param string $storageId @@ -3055,6 +3291,18 @@ interface AiravataIf { */ public function deleteGatewayComputeResourcePreference(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayID, $computeResourceId); /** + * Delete the Storage Resource Preference of a registered gateway profile. + * + * @param gatewayID + * The identifier of the gateway profile to be deleted. + * + * @param storageId + * ID of the storage preference you want to delete. + * + * @return status + * Returns a success/failure of the deletion. + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayID * @param string $storageId @@ -3066,6 +3314,18 @@ interface AiravataIf { */ public function deleteGatewayStoragePreference(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayID, $storageId); /** + * Delete the Storage Resource Preference of a registered gateway profile. + * + * @param gatewayID + * The identifier of the gateway profile to be deleted. + * + * @param storageId + * ID of the storage preference you want to delete. + * + * @return status + * Returns a success/failure of the deletion. + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId * @return string[] @@ -3076,9 +3336,13 @@ interface AiravataIf { */ public function getAllWorkflows(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId); /** + * + * API Methods Related for Work-Flow Submission Features. + * + * * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $workflowTemplateId - * @return \Airavata\Model\Workflow + * @return \Airavata\Model\WorkflowModel * @throws \Airavata\API\Error\InvalidRequestException * @throws \Airavata\API\Error\AiravataClientException * @throws \Airavata\API\Error\AiravataSystemException @@ -3097,24 +3361,24 @@ interface AiravataIf { /** * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $gatewayId - * @param \Airavata\Model\Workflow $workflow + * @param \Airavata\Model\WorkflowModel $workflow * @return string * @throws \Airavata\API\Error\InvalidRequestException * @throws \Airavata\API\Error\AiravataClientException * @throws \Airavata\API\Error\AiravataSystemException * @throws \Airavata\API\Error\AuthorizationException */ - public function registerWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\Workflow $workflow); + public function registerWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\WorkflowModel $workflow); /** * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $workflowTemplateId - * @param \Airavata\Model\Workflow $workflow + * @param \Airavata\Model\WorkflowModel $workflow * @throws \Airavata\API\Error\InvalidRequestException * @throws \Airavata\API\Error\AiravataClientException * @throws \Airavata\API\Error\AiravataSystemException * @throws \Airavata\API\Error\AuthorizationException */ - public function updateWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $workflowTemplateId, \Airavata\Model\Workflow $workflow); + public function updateWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $workflowTemplateId, \Airavata\Model\WorkflowModel $workflow); /** * @param \Airavata\Model\Security\AuthzToken $authzToken * @param string $workflowName @@ -3136,7 +3400,9 @@ interface AiravataIf { */ public function isWorkflowExistWithName(\Airavata\Model\Security\AuthzToken $authzToken, $workflowName); /** - * * Data Manager Related API Methods + * * + * * Data Manager Related API Methods. + * * * * * * @param \Airavata\Model\Security\AuthzToken $authzToken @@ -11571,13 +11837,13 @@ class AiravataClient implements \Airavata\API\AiravataIf { return; } - public function registerWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\Workflow $workflow) + public function registerWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\WorkflowModel $workflow) { $this->send_registerWorkflow($authzToken, $gatewayId, $workflow); return $this->recv_registerWorkflow(); } - public function send_registerWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\Workflow $workflow) + public function send_registerWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $gatewayId, \Airavata\Model\WorkflowModel $workflow) { $args = new \Airavata\API\Airavata_registerWorkflow_args(); $args->authzToken = $authzToken; @@ -11636,13 +11902,13 @@ class AiravataClient implements \Airavata\API\AiravataIf { throw new \Exception("registerWorkflow failed: unknown result"); } - public function updateWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $workflowTemplateId, \Airavata\Model\Workflow $workflow) + public function updateWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $workflowTemplateId, \Airavata\Model\WorkflowModel $workflow) { $this->send_updateWorkflow($authzToken, $workflowTemplateId, $workflow); $this->recv_updateWorkflow(); } - public function send_updateWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $workflowTemplateId, \Airavata\Model\Workflow $workflow) + public function send_updateWorkflow(\Airavata\Model\Security\AuthzToken $authzToken, $workflowTemplateId, \Airavata\Model\WorkflowModel $workflow) { $args = new \Airavata\API\Airavata_updateWorkflow_args(); $args->authzToken = $authzToken; @@ -51488,7 +51754,7 @@ class Airavata_getWorkflow_result { static $_TSPEC; /** - * @var \Airavata\Model\Workflow + * @var \Airavata\Model\WorkflowModel */ public $success = null; /** @@ -51514,7 +51780,7 @@ class Airavata_getWorkflow_result { 0 => array( 'var' => 'success', 'type' => TType::STRUCT, - 'class' => '\Airavata\Model\Workflow', + 'class' => '\Airavata\Model\WorkflowModel', ), 1 => array( 'var' => 'ire', @@ -51578,7 +51844,7 @@ class Airavata_getWorkflow_result { { case 0: if ($ftype == TType::STRUCT) { - $this->success = new \Airavata\Model\Workflow(); + $this->success = new \Airavata\Model\WorkflowModel(); $xfer += $this->success->read($input); } else { $xfer += $input->skip($ftype); @@ -51931,7 +52197,7 @@ class Airavata_registerWorkflow_args { */ public $gatewayId = null; /** - * @var \Airavata\Model\Workflow + * @var \Airavata\Model\WorkflowModel */ public $workflow = null; @@ -51950,7 +52216,7 @@ class Airavata_registerWorkflow_args { 3 => array( 'var' => 'workflow', 'type' => TType::STRUCT, - 'class' => '\Airavata\Model\Workflow', + 'class' => '\Airavata\Model\WorkflowModel', ), ); } @@ -52003,7 +52269,7 @@ class Airavata_registerWorkflow_args { break; case 3: if ($ftype == TType::STRUCT) { - $this->workflow = new \Airavata\Model\Workflow(); + $this->workflow = new \Airavata\Model\WorkflowModel(); $xfer += $this->workflow->read($input); } else { $xfer += $input->skip($ftype); @@ -52237,7 +52503,7 @@ class Airavata_updateWorkflow_args { */ public $workflowTemplateId = null; /** - * @var \Airavata\Model\Workflow + * @var \Airavata\Model\WorkflowModel */ public $workflow = null; @@ -52256,7 +52522,7 @@ class Airavata_updateWorkflow_args { 3 => array( 'var' => 'workflow', 'type' => TType::STRUCT, - 'class' => '\Airavata\Model\Workflow', + 'class' => '\Airavata\Model\WorkflowModel', ), ); } @@ -52309,7 +52575,7 @@ class Airavata_updateWorkflow_args { break; case 3: if ($ftype == TType::STRUCT) { - $this->workflow = new \Airavata\Model\Workflow(); + $this->workflow = new \Airavata\Model\WorkflowModel(); $xfer += $this->workflow->read($input); } else { $xfer += $input->skip($ftype);
