Google Git
Sign in
apache / airavata-site / 40f3a7fc27e6b89819ae72503bf882351d9d32d2 / . / source / api-docs / master / airavata_workflow_model.html
blob: c3ecf791339dea8799d77d1a703ab1e3aa187724 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<link href="style.css" rel="stylesheet" type="text/css"/>
<title>Thrift module: airavata_workflow_model</title></head><body>
<div class="container-fluid">
<h1>Thrift module: airavata_workflow_model</h1>
<table class="table-bordered table-striped table-condensed"><thead><tr><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></tr></thead><tbody>
<tr>
<td>airavata_workflow_model</td><td></td>
<td><a href="#Struct_AiravataWorkflow">AiravataWorkflow</a><br/>
<a href="#Enum_ApplicationState">ApplicationState</a><br/>
<a href="#Struct_ApplicationStatus">ApplicationStatus</a><br/>
<a href="#Enum_ComponentType">ComponentType</a><br/>
<a href="#Struct_DataBlock">DataBlock</a><br/>
<a href="#Enum_HandlerState">HandlerState</a><br/>
<a href="#Struct_HandlerStatus">HandlerStatus</a><br/>
<a href="#Enum_HandlerType">HandlerType</a><br/>
<a href="#Struct_WorkflowApplication">WorkflowApplication</a><br/>
<a href="#Struct_WorkflowConnection">WorkflowConnection</a><br/>
<a href="#Struct_WorkflowHandler">WorkflowHandler</a><br/>
<a href="#Enum_WorkflowState">WorkflowState</a><br/>
<a href="#Struct_WorkflowStatus">WorkflowStatus</a><br/>
</td>
<td></td>
</tr></tbody></table>
<hr/><h2 id="Enumerations">Enumerations</h2>
<div class="definition"><h3 id="Enum_ApplicationState">Enumeration: ApplicationState</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>VALIDATED</code></td><td><code>1</code></td><td>
</td></tr>
<tr><td><code>SCHEDULED</code></td><td><code>2</code></td><td>
</td></tr>
<tr><td><code>LAUNCHED</code></td><td><code>3</code></td><td>
</td></tr>
<tr><td><code>EXECUTING</code></td><td><code>4</code></td><td>
</td></tr>
<tr><td><code>CANCELING</code></td><td><code>5</code></td><td>
</td></tr>
<tr><td><code>CANCELED</code></td><td><code>6</code></td><td>
</td></tr>
<tr><td><code>COMPLETED</code></td><td><code>7</code></td><td>
</td></tr>
<tr><td><code>FAILED</code></td><td><code>8</code></td><td>
</td></tr>
</table></div>
<div class="definition"><h3 id="Enum_ComponentType">Enumeration: ComponentType</h3>
<br/><table class="table-bordered table-striped table-condensed">
<tr><td><code>APPLICATION</code></td><td><code>0</code></td><td>
</td></tr>
<tr><td><code>HANDLER</code></td><td><code>1</code></td><td>
</td></tr>
</table></div>
<div class="definition"><h3 id="Enum_HandlerType">Enumeration: HandlerType</h3>
<br/><table class="table-bordered table-striped table-condensed">
<tr><td><code>FLOW_STARTER</code></td><td><code>0</code></td><td>
</td></tr>
<tr><td><code>FLOW_TERMINATOR</code></td><td><code>1</code></td><td>
</td></tr>
</table></div>
<div class="definition"><h3 id="Enum_HandlerState">Enumeration: HandlerState</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>VALIDATED</code></td><td><code>1</code></td><td>
</td></tr>
<tr><td><code>SCHEDULED</code></td><td><code>2</code></td><td>
</td></tr>
<tr><td><code>LAUNCHED</code></td><td><code>3</code></td><td>
</td></tr>
<tr><td><code>EXECUTING</code></td><td><code>4</code></td><td>
</td></tr>
<tr><td><code>CANCELING</code></td><td><code>5</code></td><td>
</td></tr>
<tr><td><code>CANCELED</code></td><td><code>6</code></td><td>
</td></tr>
<tr><td><code>COMPLETED</code></td><td><code>7</code></td><td>
</td></tr>
<tr><td><code>FAILED</code></td><td><code>8</code></td><td>
</td></tr>
</table></div>
<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>VALIDATED</code></td><td><code>1</code></td><td>
</td></tr>
<tr><td><code>SCHEDULED</code></td><td><code>2</code></td><td>
</td></tr>
<tr><td><code>LAUNCHED</code></td><td><code>3</code></td><td>
</td></tr>
<tr><td><code>EXECUTING</code></td><td><code>4</code></td><td>
</td></tr>
<tr><td><code>PAUSING</code></td><td><code>5</code></td><td>
</td></tr>
<tr><td><code>PAUSED</code></td><td><code>6</code></td><td>
</td></tr>
<tr><td><code>RESTARTING</code></td><td><code>7</code></td><td>
</td></tr>
<tr><td><code>CANCELING</code></td><td><code>8</code></td><td>
</td></tr>
<tr><td><code>CANCELED</code></td><td><code>9</code></td><td>
</td></tr>
<tr><td><code>COMPLETED</code></td><td><code>10</code></td><td>
</td></tr>
<tr><td><code>FAILED</code></td><td><code>11</code></td><td>
</td></tr>
</table></div>
<hr/><h2 id="Structs">Data structures</h2>
<div class="definition"><h3 id="Struct_ApplicationStatus">Struct: ApplicationStatus</h3>
<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
<tr><td>1</td><td>id</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>2</td><td>state</td><td><code><a href="#Enum_ApplicationState">ApplicationState</a></code></td><td></td><td>required</td><td></td></tr>
<tr><td>3</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>updatedAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_WorkflowApplication">Struct: WorkflowApplication</h3>
<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
<tr><td>1</td><td>id</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>2</td><td>processId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>3</td><td>applicationInterfaceId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>computeResourceId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>queueName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>nodeCount</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>coreCount</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>8</td><td>wallTimeLimit</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>9</td><td>physicalMemory</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>10</td><td>statuses</td><td><code>list&lt;<code><a href="#Struct_ApplicationStatus">ApplicationStatus</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>11</td><td>errors</td><td><code>list&lt;<code><a href="airavata_commons.html#Struct_ErrorModel">airavata_commons.ErrorModel</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>12</td><td>createdAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>13</td><td>updatedAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_DataBlock">Struct: DataBlock</h3>
<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
<tr><td>1</td><td>id</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>2</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>3</td><td>type</td><td><code><a href="application_io_models.html#Enum_DataType">application_io_models.DataType</a></code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>createdAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>updatedAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_WorkflowConnection">Struct: WorkflowConnection</h3>
<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
<tr><td>1</td><td>id</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>dataBlock</td><td><code><a href="#Struct_DataBlock">DataBlock</a></code></td><td></td><td>optional</td><td></td></tr>
<tr><td>3</td><td>fromType</td><td><code><a href="#Enum_ComponentType">ComponentType</a></code></td><td></td><td>required</td><td></td></tr>
<tr><td>4</td><td>fromId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>5</td><td>fromOutputName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>6</td><td>toType</td><td><code><a href="#Enum_ComponentType">ComponentType</a></code></td><td></td><td>required</td><td></td></tr>
<tr><td>7</td><td>toId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>8</td><td>toInputName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>9</td><td>createdAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>10</td><td>updatedAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_HandlerStatus">Struct: HandlerStatus</h3>
<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
<tr><td>1</td><td>id</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>2</td><td>state</td><td><code><a href="#Enum_HandlerState">HandlerState</a></code></td><td></td><td>required</td><td></td></tr>
<tr><td>3</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>updatedAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_WorkflowHandler">Struct: WorkflowHandler</h3>
<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
<tr><td>1</td><td>id</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>2</td><td>type</td><td><code><a href="#Enum_HandlerType">HandlerType</a></code></td><td></td><td>required</td><td></td></tr>
<tr><td>3</td><td>inputs</td><td><code>list&lt;<code><a href="application_io_models.html#Struct_InputDataObjectType">application_io_models.InputDataObjectType</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>outputs</td><td><code>list&lt;<code><a href="application_io_models.html#Struct_OutputDataObjectType">application_io_models.OutputDataObjectType</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>statuses</td><td><code>list&lt;<code><a href="#Struct_HandlerStatus">HandlerStatus</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>errors</td><td><code>list&lt;<code><a href="airavata_commons.html#Struct_ErrorModel">airavata_commons.ErrorModel</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>createdAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>8</td><td>updatedAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_WorkflowStatus">Struct: WorkflowStatus</h3>
<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
<tr><td>1</td><td>id</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>2</td><td>state</td><td><code><a href="#Enum_WorkflowState">WorkflowState</a></code></td><td></td><td>required</td><td></td></tr>
<tr><td>3</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>updatedAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_AiravataWorkflow">Struct: AiravataWorkflow</h3>
<table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody>
<tr><td>1</td><td>id</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>experimentId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>3</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>applications</td><td><code>list&lt;<code><a href="#Struct_WorkflowApplication">WorkflowApplication</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>handlers</td><td><code>list&lt;<code><a href="#Struct_WorkflowHandler">WorkflowHandler</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>connections</td><td><code>list&lt;<code><a href="#Struct_WorkflowConnection">WorkflowConnection</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>statuses</td><td><code>list&lt;<code><a href="#Struct_WorkflowStatus">WorkflowStatus</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>8</td><td>errors</td><td><code>list&lt;<code><a href="airavata_commons.html#Struct_ErrorModel">airavata_commons.ErrorModel</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>9</td><td>createdAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>10</td><td>updatedAt</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div></div></body></html>