| <!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: user_resource_profile_model</title></head><body> |
| <div class="container-fluid"> |
| <h1>Thrift module: user_resource_profile_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>user_resource_profile_model</td><td></td> |
| <td><a href="#Struct_UserComputeResourcePreference">UserComputeResourcePreference</a><br/> |
| <a href="#Struct_UserResourceProfile">UserResourceProfile</a><br/> |
| <a href="#Struct_UserStoragePreference">UserStoragePreference</a><br/> |
| </td> |
| <td></td> |
| </tr></tbody></table> |
| <hr/><h2 id="Structs">Data structures</h2> |
| <div class="definition"><h3 id="Struct_UserComputeResourcePreference">Struct: UserComputeResourcePreference</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>computeResourceId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>loginUserName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>3</td><td>preferredBatchQueue</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>4</td><td>scratchLocation</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>5</td><td>allocationProjectNumber</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>6</td><td>resourceSpecificCredentialStoreToken</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>7</td><td>qualityOfService</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>8</td><td>reservation</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>9</td><td>reservationStartTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>10</td><td>reservationEndTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>11</td><td>validated</td><td><code>bool</code></td><td></td><td>optional</td><td><code>false</code></td></tr> |
| </tbody></table><br/><pre>User specific preferences for a Computer Resource |
| |
| computeResourceId: |
| Corelate the preference to a compute resource. |
| |
| |
| loginUserName: |
| If turned true, Airavata will override the preferences of better alternatives exist. |
| |
| |
| preferredBatchQueue: |
| Gateways can choose a defualt batch queue based on average job dimention, reservations or other metrics. |
| |
| scratchLocation: |
| Path to the local scratch space on a HPC cluster. Typically used to create working directory for job execution. |
| |
| allocationProjectNumber: |
| Typically used on HPC machines to charge computing usage to a account number. For instance, on XSEDE once an |
| allocation is approved, an allocation number is assigned. Before passing this number with job submittions, the |
| account to be used has to be added to the allocation. |
| |
| resourceSpecificCredentialStoreToken: |
| Resource specific credential store token. If this token is specified, then it is superceeded by the gateway's |
| default credential store. |
| |
| validated: |
| If true the the configuration has been validated in the sense that the username and credential can be used to |
| login to the remote host and the scratchLocation is a valid location that the user has permission to write to. |
| Should be treated as read-only and only mutated by Airavata middleware. |
| |
| </pre><br/></div><div class="definition"><h3 id="Struct_UserStoragePreference">Struct: UserStoragePreference</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>storageResourceId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>loginUserName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>3</td><td>fileSystemRootLocation</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>4</td><td>resourceSpecificCredentialStoreToken</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| </tbody></table><br/></div><div class="definition"><h3 id="Struct_UserResourceProfile">Struct: UserResourceProfile</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>userId</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>credentialStoreToken</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>4</td><td>userComputeResourcePreferences</td><td><code>list<<code><a href="#Struct_UserComputeResourcePreference">UserComputeResourcePreference</a></code>></code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>5</td><td>userStoragePreferences</td><td><code>list<<code><a href="#Struct_UserStoragePreference">UserStoragePreference</a></code>></code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>6</td><td>identityServerTenant</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>7</td><td>identityServerPwdCredToken</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| </tbody></table><br/><pre>User Resource Profile |
| |
| userId: |
| Unique identifier used to link user to corresponding user data model |
| |
| gatewayID: |
| Unique identifier for the gateway assigned by Airavata. Corelate this to Airavata Admin API Gateway Registration. |
| |
| credentialStoreToken: |
| Gateway's defualt credential store token. |
| |
| computeResourcePreferences: |
| List of resource preferences for each of the registered compute resources. |
| |
| identityServerTenant: |
| |
| identityServerPwdCredToken: |
| |
| </pre><br/></div></div></body></html> |
