blob: 5d282efc684499d37c9ac5bad759f612eb30d3b8 [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: workspace_model</title></head><body>
<div class="container-fluid">
<h1>Thrift module: workspace_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>workspace_model</td><td></td>
<td><a href="#Struct_Gateway">Gateway</a><br/>
<a href="#Enum_GatewayApprovalStatus">GatewayApprovalStatus</a><br/>
<a href="#Struct_GatewayUsageReportingCommand">GatewayUsageReportingCommand</a><br/>
<a href="#Struct_Group">Group</a><br/>
<a href="#Struct_Notification">Notification</a><br/>
<a href="#Enum_NotificationPriority">NotificationPriority</a><br/>
<a href="#Struct_Project">Project</a><br/>
<a href="#Struct_User">User</a><br/>
</td>
<td></td>
</tr></tbody></table>
<hr/><h2 id="Enumerations">Enumerations</h2>
<div class="definition"><h3 id="Enum_GatewayApprovalStatus">Enumeration: GatewayApprovalStatus</h3>
<br/><table class="table-bordered table-striped table-condensed">
<tr><td><code>REQUESTED</code></td><td><code>0</code></td><td>
</td></tr>
<tr><td><code>APPROVED</code></td><td><code>1</code></td><td>
</td></tr>
<tr><td><code>ACTIVE</code></td><td><code>2</code></td><td>
</td></tr>
<tr><td><code>DEACTIVATED</code></td><td><code>3</code></td><td>
</td></tr>
<tr><td><code>CANCELLED</code></td><td><code>4</code></td><td>
</td></tr>
<tr><td><code>DENIED</code></td><td><code>5</code></td><td>
</td></tr>
<tr><td><code>CREATED</code></td><td><code>6</code></td><td>
</td></tr>
<tr><td><code>DEPLOYED</code></td><td><code>7</code></td><td>
</td></tr>
</table></div>
<div class="definition"><h3 id="Enum_NotificationPriority">Enumeration: NotificationPriority</h3>
<br/><table class="table-bordered table-striped table-condensed">
<tr><td><code>LOW</code></td><td><code>0</code></td><td>
</td></tr>
<tr><td><code>NORMAL</code></td><td><code>1</code></td><td>
</td></tr>
<tr><td><code>HIGH</code></td><td><code>2</code></td><td>
</td></tr>
</table></div>
<hr/><h2 id="Structs">Data structures</h2>
<div class="definition"><h3 id="Struct_Group">Struct: Group</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>groupName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>2</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_Project">Struct: Project</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>projectID</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>owner</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>
<tr><td>4</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>5</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>creationTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>sharedUsers</td><td><code>list&lt;<code>string</code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>8</td><td>sharedGroups</td><td><code>list&lt;<code>string</code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_User">Struct: User</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>airavataInternalUserId</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>userName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>3</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>4</td><td>firstName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>lastName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>email</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_Gateway">Struct: Gateway</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>airavataInternalGatewayId</td><td><code>string</code></td><td></td><td>optional</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>gatewayApprovalStatus</td><td><code><a href="#Enum_GatewayApprovalStatus">GatewayApprovalStatus</a></code></td><td></td><td>required</td><td></td></tr>
<tr><td>4</td><td>gatewayName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>domain</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>emailAddress</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>gatewayAcronym</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>8</td><td>gatewayURL</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>9</td><td>gatewayPublicAbstract</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>10</td><td>reviewProposalDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>11</td><td>gatewayAdminFirstName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>12</td><td>gatewayAdminLastName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>13</td><td>gatewayAdminEmail</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>14</td><td>identityServerUserName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>15</td><td>identityServerPasswordToken</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>16</td><td>declinedReason</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>17</td><td>oauthClientId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>18</td><td>oauthClientSecret</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>19</td><td>requestCreationTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>20</td><td>requesterUsername</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_GatewayUsageReportingCommand">Struct: GatewayUsageReportingCommand</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>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>2</td><td>computeResourceId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>3</td><td>command</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_Notification">Struct: Notification</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>notificationId</td><td><code>string</code></td><td></td><td>optional</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>title</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>4</td><td>notificationMessage</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>5</td><td>creationTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>publishedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>expirationTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>8</td><td>priority</td><td><code><a href="#Enum_NotificationPriority">NotificationPriority</a></code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div></div></body></html>