http://git-wip-us.apache.org/repos/asf/airavata-site/blob/246aae92/content/api-docs/0.16/task_model.html ---------------------------------------------------------------------- diff --git a/content/api-docs/0.16/task_model.html b/content/api-docs/0.16/task_model.html new file mode 100644 index 0000000..11027c3 --- /dev/null +++ b/content/api-docs/0.16/task_model.html @@ -0,0 +1,99 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: task_model</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: task_model</h1> +<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>task_model</td><td></td> +<td><a href="#Enum_DataStageType">DataStageType</a><br/> +<a href="#Struct_DataStagingTaskModel">DataStagingTaskModel</a><br/> +<a href="#Struct_EnvironmentSetupTaskModel">EnvironmentSetupTaskModel</a><br/> +<a href="#Struct_JobSubmissionTaskModel">JobSubmissionTaskModel</a><br/> +<a href="#Struct_MonitorTaskModel">MonitorTaskModel</a><br/> +<a href="#Struct_TaskModel">TaskModel</a><br/> +<a href="#Enum_TaskTypes">TaskTypes</a><br/> +</td> +<td></code></td> +</tr></table> +<hr/><h2 id="Enumerations">Enumerations</h2> +<div class="definition"><h3 id="Enum_TaskTypes">Enumeration: TaskTypes</h3> +TaskTypes: An enumerated list of TaskTypes. Task being generic, the task type will provide the concrete interpretation. + +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>ENV_SETUP</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>DATA_STAGING</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>JOB_SUBMISSION</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>ENV_CLEANUP</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>MONITORING</code></td><td><code>4</code></td><td> +</td></tr> +<tr><td><code>OUTPUT_FETCHING</code></td><td><code>5</code></td><td> +</td></tr> +</table></div> +<div class="definition"><h3 id="Enum_DataStageType">Enumeration: DataStageType</h3> +DataStagingTaskModel: A structure holding the data staging task details. + +Source and Destination locations includes standard representation of protocol, host, port and path + A friendly description of the task, usally used to communicate information to users. + +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>INPUT</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>OUPUT</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>ARCHIVE_OUTPUT</code></td><td><code>2</code></td><td> +</td></tr> +</table></div> +<hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_TaskModel">Struct: TaskModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>taskId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>taskType</td><td><code><a href="#Enum_TaskTypes">TaskTypes</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>parentProcessId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>4</td><td>creationTime</td><td><code>i64</code></td><td></td><td>required</td><td></td></tr> +<tr><td>5</td><td>lastUpdateTime</td><td><code>i64</code></td><td></td><td>required</td><td></td></tr> +<tr><td>6</td><td>taskStatus</td><td><code><a href="status_models.html#Struct_TaskStatus">status_models.TaskStatus</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>7</td><td>taskDetail</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>8</td><td>subTaskModel</td><td><code>binary</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>9</td><td>taskError</td><td><code><a href="airavata_commons.html#Struct_ErrorModel">airavata_commons.ErrorModel</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>10</td><td>jobs</td><td><code>list<<code><a href="job_model.html#Struct_JobModel">job_model.JobModel</a></code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/>TaskModel: A structure holding the generic task details. + +taskDetail: + A friendly description of the task, usally used to communicate information to users. + +subTaskModel: + A generic byte object for the Task developer to store internal serialized data into registry catalogs. +<br/></div><div class="definition"><h3 id="Struct_DataStagingTaskModel">Struct: DataStagingTaskModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>source</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>destination</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>type</td><td><code><a href="#Enum_DataStageType">DataStageType</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>4</td><td>transferStartTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>transferEndTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>6</td><td>transferRate</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>7</td><td>processInput</td><td><code><a href="application_io_models.html#Struct_InputDataObjectType">application_io_models.InputDataObjectType</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>8</td><td>processOutput</td><td><code><a href="application_io_models.html#Struct_OutputDataObjectType">application_io_models.OutputDataObjectType</a></code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_EnvironmentSetupTaskModel">Struct: EnvironmentSetupTaskModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>location</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>protocol</td><td><code><a href="data_movement_models.html#Enum_SecurityProtocol">data_movement_models.SecurityProtocol</a></code></td><td></td><td>required</td><td></td></tr> +</table><br/>EnvironmentSetupTaskModel: A structure holding the environment creation task details + +<br/></div><div class="definition"><h3 id="Struct_JobSubmissionTaskModel">Struct: JobSubmissionTaskModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>jobSubmissionProtocol</td><td><code><a href="compute_resource_model.html#Enum_JobSubmissionProtocol">compute_resource_model.JobSubmissionProtocol</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>monitorMode</td><td><code><a href="compute_resource_model.html#Enum_MonitorMode">compute_resource_model.MonitorMode</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>wallTime</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_MonitorTaskModel">Struct: MonitorTaskModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>monitorMode</td><td><code><a href="compute_resource_model.html#Enum_MonitorMode">compute_resource_model.MonitorMode</a></code></td><td></td><td>required</td><td></td></tr> +</table><br/></div></div></body></html>
http://git-wip-us.apache.org/repos/asf/airavata-site/blob/246aae92/content/api-docs/0.16/workflow_data_model.html ---------------------------------------------------------------------- diff --git a/content/api-docs/0.16/workflow_data_model.html b/content/api-docs/0.16/workflow_data_model.html new file mode 100644 index 0000000..e01d224 --- /dev/null +++ b/content/api-docs/0.16/workflow_data_model.html @@ -0,0 +1,102 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: workflow_data_model</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: workflow_data_model</h1> +<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>workflow_data_model</td><td></td> +<td><a href="#Enum_ComponentState">ComponentState</a><br/> +<a href="#Struct_ComponentStatus">ComponentStatus</a><br/> +<a href="#Struct_EdgeModel">EdgeModel</a><br/> +<a href="#Struct_NodeModel">NodeModel</a><br/> +<a href="#Struct_PortModel">PortModel</a><br/> +<a href="#Struct_WorkflowModel">WorkflowModel</a><br/> +<a href="#Enum_WorkflowState">WorkflowState</a><br/> +<a href="#Struct_WorkflowStatus">WorkflowStatus</a><br/> +</td> +<td></code></td> +</tr></table> +<hr/><h2 id="Enumerations">Enumerations</h2> +<div class="definition"><h3 id="Enum_WorkflowState">Enumeration: WorkflowState</h3> +<br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>CREATED</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>STARTED</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>EXECUTING</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>COMPLETED</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>FAILED</code></td><td><code>4</code></td><td> +</td></tr> +<tr><td><code>CANCELLING</code></td><td><code>5</code></td><td> +</td></tr> +<tr><td><code>CANCELED</code></td><td><code>6</code></td><td> +</td></tr> +</table></div> +<div class="definition"><h3 id="Enum_ComponentState">Enumeration: ComponentState</h3> +<br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>CREATED</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>WAITING</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>READY</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>RUNNING</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>COMPLETED</code></td><td><code>4</code></td><td> +</td></tr> +<tr><td><code>FAILED</code></td><td><code>5</code></td><td> +</td></tr> +<tr><td><code>CANCELED</code></td><td><code>6</code></td><td> +</td></tr> +</table></div> +<hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_WorkflowModel">Struct: WorkflowModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>templateId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>graph</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>4</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>5</td><td>createdUser</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>6</td><td>image</td><td><code>binary</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>7</td><td>workflowInputs</td><td><code>list<<code><a href="application_io_models.html#Struct_InputDataObjectType">application_io_models.InputDataObjectType</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>8</td><td>workflowOutputs</td><td><code>list<<code><a href="application_io_models.html#Struct_OutputDataObjectType">application_io_models.OutputDataObjectType</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>9</td><td>creationTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_ComponentStatus">Struct: ComponentStatus</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>state</td><td><code><a href="#Enum_ComponentState">ComponentState</a></code></td><td></td><td>required</td><td><code><code><a href="#Const_ComponentState.CREATED">ComponentState.CREATED</a></code></code></td></tr> +<tr><td>2</td><td>reason</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>timeofStateChange</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_WorkflowStatus">Struct: WorkflowStatus</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>state</td><td><code><a href="#Enum_WorkflowState">WorkflowState</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>timeOfStateChange</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>reason</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_EdgeModel">Struct: EdgeModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>edgeId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>status</td><td><code><a href="#Struct_ComponentStatus">ComponentStatus</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_PortModel">Struct: PortModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>portId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>status</td><td><code><a href="#Struct_ComponentStatus">ComponentStatus</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_NodeModel">Struct: NodeModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>nodeId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>applicationId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>applicationName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>status</td><td><code><a href="#Struct_ComponentStatus">ComponentStatus</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>6</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div></div></body></html> http://git-wip-us.apache.org/repos/asf/airavata-site/blob/246aae92/content/api-docs/0.16/workspace_model.html ---------------------------------------------------------------------- diff --git a/content/api-docs/0.16/workspace_model.html b/content/api-docs/0.16/workspace_model.html new file mode 100644 index 0000000..eebfd25 --- /dev/null +++ b/content/api-docs/0.16/workspace_model.html @@ -0,0 +1,44 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: workspace_model</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: workspace_model</h1> +<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>workspace_model</td><td></td> +<td><a href="#Struct_Gateway">Gateway</a><br/> +<a href="#Struct_Group">Group</a><br/> +<a href="#Struct_Project">Project</a><br/> +<a href="#Struct_User">User</a><br/> +</td> +<td></code></td> +</tr></table> +<hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_Group">Struct: Group</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>groupName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_Project">Struct: Project</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>projectID</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>owner</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>4</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>creationTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>6</td><td>sharedUsers</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>7</td><td>sharedGroups</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_User">Struct: User</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>userName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>groupList</td><td><code>list<<code><a href="#Struct_Group">Group</a></code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_Gateway">Struct: Gateway</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>gatewayName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>domain</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>emailAddress</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div></div></body></html>
