| <!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_commons</title></head><body> |
| <div class="container-fluid"> |
| <h1>Thrift module: airavata_commons</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_commons</td><td></td> |
| <td><a href="#Struct_ErrorModel">ErrorModel</a><br/> |
| <a href="#Struct_ValidationResults">ValidationResults</a><br/> |
| <a href="#Struct_ValidatorResult">ValidatorResult</a><br/> |
| </td> |
| <td><code><a href="#Const_DEFAULT_ID">DEFAULT_ID</a></code><br/> |
| </td> |
| </tr></tbody></table> |
| <hr/><h2 id="Constants">Constants</h2> |
| <table class="table-bordered table-striped table-condensed"><thead><tr><th>Constant</th><th>Type</th><th>Value</th></tr></thead><tbody> |
| <tr id="Const_DEFAULT_ID"><td><code>DEFAULT_ID</code></td><td><code>string</code></td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr></tbody></table><hr/><h2 id="Structs">Data structures</h2> |
| <div class="definition"><h3 id="Struct_ErrorModel">Struct: ErrorModel</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>errorId</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>creationTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>3</td><td>actualErrorMessage</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>4</td><td>userFriendlyMessage</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>5</td><td>transientOrPersistent</td><td><code>bool</code></td><td></td><td>optional</td><td><code>false</code></td></tr> |
| <tr><td>6</td><td>rootCauseErrorIdList</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr> |
| </tbody></table><br/></div><div class="definition"><h3 id="Struct_ValidatorResult">Struct: ValidatorResult</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>result</td><td><code>bool</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>errorDetails</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| </tbody></table><br/><pre>This data structure can be used to store the validation results |
| captured during validation step and during the launchExperiment |
| operation it can be easilly checked to see the errors occured |
| during the experiment launch operation |
| |
| </pre><br/></div><div class="definition"><h3 id="Struct_ValidationResults">Struct: ValidationResults</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>validationState</td><td><code>bool</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>validationResultList</td><td><code>list<<code><a href="#Struct_ValidatorResult">ValidatorResult</a></code>></code></td><td></td><td>required</td><td></td></tr> |
| </tbody></table><br/></div></div></body></html> |
