blob: 1492980fcf999650308ad424f12f95a262ca958c [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: application_interface_model</title></head><body>
<div class="container-fluid">
<h1>Thrift module: application_interface_model</h1>
<pre>This file describes the definitions of the Data Structures of Application interfaces. These interfaces are mapped
to application mapping on various resources.
</pre><br/><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>application_interface_model</td><td></td>
<td><a href="#Struct_ApplicationInterfaceDescription">ApplicationInterfaceDescription</a><br/>
</td>
<td></td>
</tr></tbody></table>
<hr/><h2 id="Structs">Data structures</h2>
<div class="definition"><h3 id="Struct_ApplicationInterfaceDescription">Struct: ApplicationInterfaceDescription</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>applicationInterfaceId</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>applicationName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>3</td><td>applicationDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>applicationModules</td><td><code>list&lt;<code>string</code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>applicationInputs</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>6</td><td>applicationOutputs</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>7</td><td>archiveWorkingDirectory</td><td><code>bool</code></td><td></td><td>optional</td><td><code>false</code></td></tr>
<tr><td>8</td><td>hasOptionalFileInputs</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/><pre>Application Interface Description
applicationModules:
Associate all application modules with versions which interface is applicable to.
applicationInputs:
Inputs to be passed to the application
applicationOutputs:
Outputs generated from the application
</pre><br/></div></div></body></html>