source/api-docs/0.16/application_io

<!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: application_io_models</title></head><body> <div class="container-fluid"> <h1>Thrift module: application_io_models</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>application_io_models</td><td></td> <td><a href="#Enum_DataType">DataType</a><br/> <a href="#Struct_InputDataObjectType">InputDataObjectType</a><br/> <a href="#Struct_OutputDataObjectType">OutputDataObjectType</a><br/> </td> <td></code></td> </tr></table> <hr/><h2 id="Enumerations">Enumerations</h2> <div class="definition"><h3 id="Enum_DataType">Enumeration: DataType</h3> Data Types supported in Airavata. The primitive data types <br/><br/><table class="table-bordered table-striped table-condensed"> <tr><td><code>STRING</code></td><td><code>0</code></td><td> </td></tr> <tr><td><code>INTEGER</code></td><td><code>1</code></td><td> </td></tr> <tr><td><code>FLOAT</code></td><td><code>2</code></td><td> </td></tr> <tr><td><code>URI</code></td><td><code>3</code></td><td> </td></tr> <tr><td><code>STDOUT</code></td><td><code>4</code></td><td> </td></tr> <tr><td><code>STDERR</code></td><td><code>5</code></td><td> </td></tr> </table></div> <hr/><h2 id="Structs">Data structures</h2> <div class="definition"><h3 id="Struct_InputDataObjectType">Struct: InputDataObjectType</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>name</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="#Enum_DataType">DataType</a></code></td><td></td><td>optional</td><td></td></tr> <tr><td>4</td><td>applicationArgument</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> <tr><td>5</td><td>standardInput</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> <tr><td>6</td><td>userFriendlyDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> <tr><td>7</td><td>metaData</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> <tr><td>8</td><td>inputOrder</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> <tr><td>9</td><td>isRequired</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> <tr><td>10</td><td>requiredToAddedToCommandLine</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> <tr><td>11</td><td>dataStaged</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> <tr><td>12</td><td>storageResourceId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> </table><br/>Application Inputs. The paramters describe how inputs are passed to the application. name: Name of the parameter. value: Value of the parameter. A default value could be set during registration. type: Data type of the parameter applicationArguement: The argument flag sent to the application. Such as -p pressure. standardInput: When this value is set, the parameter is sent as standard input rather than a parameter. Typically this is passed using redirection operator ">". userFriendlyDescription: Description to be displayed at the user interface. metaData: Any metadat. This is typically ignore by Airavata and is used by gateways for application configuration. <br/></div><div class="definition"><h3 id="Struct_OutputDataObjectType">Struct: OutputDataObjectType</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>name</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="#Enum_DataType">DataType</a></code></td><td></td><td>optional</td><td></td></tr> <tr><td>4</td><td>applicationArgument</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> <tr><td>5</td><td>isRequired</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> <tr><td>6</td><td>requiredToAddedToCommandLine</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> <tr><td>7</td><td>dataMovement</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> <tr><td>8</td><td>location</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> <tr><td>9</td><td>searchQuery</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> <tr><td>10</td><td>outputStreaming</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> <tr><td>11</td><td>storageResourceId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> </table><br/>Application Outputs. The paramters describe how outputs generated by the application. name: Name of the parameter. value: Value of the parameter. type: Data type of the parameter applicationArguement: The argument flag sent to the application. Such as -p pressure. standardInput: When this value is set, the parameter is sent as standard input rather than a parameter. Typically this is passed using redirection operator ">". userFriendlyDescription: Description to be displayed at the user interface. metaData: Any metadat. This is typically ignore by Airavata and is used by gateways for application configuration. <br/></div></div></body></html>

source/api-docs/0.16/application_io_models.html (96 lines of code) (raw):