| <!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: messaging_events</title></head><body> |
| <div class="container-fluid"> |
| <h1>Thrift module: messaging_events</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>messaging_events</td><td></td> |
| <td><a href="#Struct_ExperimentStatusChangeEvent">ExperimentStatusChangeEvent</a><br/> |
| <a href="#Struct_JobIdentifier">JobIdentifier</a><br/> |
| <a href="#Struct_JobStatusChangeEvent">JobStatusChangeEvent</a><br/> |
| <a href="#Struct_JobStatusChangeRequestEvent">JobStatusChangeRequestEvent</a><br/> |
| <a href="#Struct_Message">Message</a><br/> |
| <a href="#Enum_MessageLevel">MessageLevel</a><br/> |
| <a href="#Enum_MessageType">MessageType</a><br/> |
| <a href="#Struct_ProcessIdentifier">ProcessIdentifier</a><br/> |
| <a href="#Struct_ProcessStatusChangeEvent">ProcessStatusChangeEvent</a><br/> |
| <a href="#Struct_ProcessStatusChangeRequestEvent">ProcessStatusChangeRequestEvent</a><br/> |
| <a href="#Struct_ProcessSubmitEvent">ProcessSubmitEvent</a><br/> |
| <a href="#Struct_ProcessTerminateEvent">ProcessTerminateEvent</a><br/> |
| <a href="#Struct_TaskIdentifier">TaskIdentifier</a><br/> |
| <a href="#Struct_TaskOutputChangeEvent">TaskOutputChangeEvent</a><br/> |
| <a href="#Struct_TaskStatusChangeEvent">TaskStatusChangeEvent</a><br/> |
| <a href="#Struct_TaskStatusChangeRequestEvent">TaskStatusChangeRequestEvent</a><br/> |
| </td> |
| <td></code></td> |
| </tr></table> |
| <hr/><h2 id="Enumerations">Enumerations</h2> |
| <div class="definition"><h3 id="Enum_MessageLevel">Enumeration: MessageLevel</h3> |
| <br/><table class="table-bordered table-striped table-condensed"> |
| <tr><td><code>INFO</code></td><td><code>0</code></td><td> |
| </td></tr> |
| <tr><td><code>DEBUG</code></td><td><code>1</code></td><td> |
| </td></tr> |
| <tr><td><code>ERROR</code></td><td><code>2</code></td><td> |
| </td></tr> |
| <tr><td><code>ACK</code></td><td><code>3</code></td><td> |
| </td></tr> |
| </table></div> |
| <div class="definition"><h3 id="Enum_MessageType">Enumeration: MessageType</h3> |
| <br/><table class="table-bordered table-striped table-condensed"> |
| <tr><td><code>EXPERIMENT</code></td><td><code>0</code></td><td> |
| </td></tr> |
| <tr><td><code>TASK</code></td><td><code>1</code></td><td> |
| </td></tr> |
| <tr><td><code>PROCESS</code></td><td><code>2</code></td><td> |
| </td></tr> |
| <tr><td><code>JOB</code></td><td><code>3</code></td><td> |
| </td></tr> |
| <tr><td><code>LAUNCHPROCESS</code></td><td><code>4</code></td><td> |
| </td></tr> |
| <tr><td><code>TERMINATEPROCESS</code></td><td><code>5</code></td><td> |
| </td></tr> |
| <tr><td><code>PROCESSOUTPUT</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_ExperimentStatusChangeEvent">Struct: ExperimentStatusChangeEvent</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="status_models.html#Enum_ExperimentState">status_models.ExperimentState</a></code></td><td></td><td>required</td><td></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>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_ProcessIdentifier">Struct: ProcessIdentifier</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>processId</td><td><code>string</code></td><td></td><td>required</td><td></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>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_TaskIdentifier">Struct: TaskIdentifier</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></td></tr> |
| <tr><td>2</td><td>processId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>3</td><td>experimentId</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> |
| </table><br/></div><div class="definition"><h3 id="Struct_TaskStatusChangeEvent">Struct: TaskStatusChangeEvent</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="status_models.html#Enum_TaskState">status_models.TaskState</a></code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>taskIdentity</td><td><code><a href="#Struct_TaskIdentifier">TaskIdentifier</a></code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_TaskStatusChangeRequestEvent">Struct: TaskStatusChangeRequestEvent</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="status_models.html#Enum_TaskState">status_models.TaskState</a></code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>taskIdentity</td><td><code><a href="#Struct_TaskIdentifier">TaskIdentifier</a></code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_ProcessStatusChangeEvent">Struct: ProcessStatusChangeEvent</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="status_models.html#Enum_ProcessState">status_models.ProcessState</a></code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>processIdentity</td><td><code><a href="#Struct_ProcessIdentifier">ProcessIdentifier</a></code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_ProcessStatusChangeRequestEvent">Struct: ProcessStatusChangeRequestEvent</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="status_models.html#Enum_ProcessState">status_models.ProcessState</a></code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>processIdentity</td><td><code><a href="#Struct_ProcessIdentifier">ProcessIdentifier</a></code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_TaskOutputChangeEvent">Struct: TaskOutputChangeEvent</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>output</td><td><code>list<<code><a href="application_io_models.html#Struct_OutputDataObjectType">application_io_models.OutputDataObjectType</a></code>></code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>taskIdentity</td><td><code><a href="#Struct_TaskIdentifier">TaskIdentifier</a></code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_JobIdentifier">Struct: JobIdentifier</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>jobId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>taskId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>3</td><td>processId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>4</td><td>experimentId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>5</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_ProcessSubmitEvent">Struct: ProcessSubmitEvent</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>processId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>3</td><td>experimentId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>4</td><td>tokenId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_ProcessTerminateEvent">Struct: ProcessTerminateEvent</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>processId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>3</td><td>tokenId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_JobStatusChangeEvent">Struct: JobStatusChangeEvent</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="status_models.html#Enum_JobState">status_models.JobState</a></code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>jobIdentity</td><td><code><a href="#Struct_JobIdentifier">JobIdentifier</a></code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_JobStatusChangeRequestEvent">Struct: JobStatusChangeRequestEvent</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="status_models.html#Enum_JobState">status_models.JobState</a></code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>jobIdentity</td><td><code><a href="#Struct_JobIdentifier">JobIdentifier</a></code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_Message">Struct: Message</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>event</td><td><code>binary</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>messageId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> |
| <tr><td>3</td><td>messageType</td><td><code><a href="#Enum_MessageType">MessageType</a></code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>4</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>5</td><td>messageLevel</td><td><code><a href="#Enum_MessageLevel">MessageLevel</a></code></td><td></td><td>optional</td><td></td></tr> |
| </table><br/></div></div></body></html> |
