blob: f6bd49ac9f169907839702d3a99decdb5ee14f47 [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: group_resource_profile_model</title></head><body>
<div class="container-fluid">
<h1>Thrift module: group_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>group_resource_profile_model</td><td></td>
<td><a href="#Struct_BatchQueueResourcePolicy">BatchQueueResourcePolicy</a><br/>
<a href="#Struct_ComputeResourcePolicy">ComputeResourcePolicy</a><br/>
<a href="#Struct_ComputeResourceReservation">ComputeResourceReservation</a><br/>
<a href="#Struct_GroupAccountSSHProvisionerConfig">GroupAccountSSHProvisionerConfig</a><br/>
<a href="#Struct_GroupComputeResourcePreference">GroupComputeResourcePreference</a><br/>
<a href="#Struct_GroupResourceProfile">GroupResourceProfile</a><br/>
</td>
<td></td>
</tr></tbody></table>
<hr/><h2 id="Structs">Data structures</h2>
<div class="definition"><h3 id="Struct_GroupAccountSSHProvisionerConfig">Struct: GroupAccountSSHProvisionerConfig</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>resourceId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>2</td><td>groupResourceProfileId</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>configName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>4</td><td>configValue</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_ComputeResourceReservation">Struct: ComputeResourceReservation</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>reservationId</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>reservationName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>3</td><td>queueNames</td><td><code>list&lt;<code>string</code>&gt;</code></td><td></td><td>required</td><td></td></tr>
<tr><td>4</td><td>startTime</td><td><code>i64</code></td><td></td><td>required</td><td></td></tr>
<tr><td>5</td><td>endTime</td><td><code>i64</code></td><td></td><td>required</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_GroupComputeResourcePreference">Struct: GroupComputeResourcePreference</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>groupResourceProfileId</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>overridebyAiravata</td><td><code>bool</code></td><td></td><td>required</td><td><code>true</code></td></tr>
<tr><td>4</td><td>loginUserName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>preferredJobSubmissionProtocol</td><td><code><a href="compute_resource_model.html#Enum_JobSubmissionProtocol">compute_resource_model.JobSubmissionProtocol</a></code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>preferredDataMovementProtocol</td><td><code><a href="data_movement_models.html#Enum_DataMovementProtocol">data_movement_models.DataMovementProtocol</a></code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>preferredBatchQueue</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>8</td><td>scratchLocation</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>9</td><td>allocationProjectNumber</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>10</td><td>resourceSpecificCredentialStoreToken</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>11</td><td>usageReportingGatewayId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>12</td><td>qualityOfService</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>16</td><td>sshAccountProvisioner</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>17</td><td>groupSSHAccountProvisionerConfigs</td><td><code>list&lt;<code><a href="#Struct_GroupAccountSSHProvisionerConfig">GroupAccountSSHProvisionerConfig</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>18</td><td>sshAccountProvisionerAdditionalInfo</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>19</td><td>reservations</td><td><code>list&lt;<code><a href="#Struct_ComputeResourceReservation">ComputeResourceReservation</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_ComputeResourcePolicy">Struct: ComputeResourcePolicy</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>resourcePolicyId</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>computeResourceId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>3</td><td>groupResourceProfileId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr>
<tr><td>4</td><td>allowedBatchQueues</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_BatchQueueResourcePolicy">Struct: BatchQueueResourcePolicy</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>resourcePolicyId</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>computeResourceId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
<tr><td>3</td><td>groupResourceProfileId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr>
<tr><td>4</td><td>queuename</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>maxAllowedNodes</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>maxAllowedCores</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>maxAllowedWalltime</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/></div><div class="definition"><h3 id="Struct_GroupResourceProfile">Struct: GroupResourceProfile</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>groupResourceProfileId</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>groupResourceProfileName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>4</td><td>computePreferences</td><td><code>list&lt;<code><a href="#Struct_GroupComputeResourcePreference">GroupComputeResourcePreference</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>5</td><td>computeResourcePolicies</td><td><code>list&lt;<code><a href="#Struct_ComputeResourcePolicy">ComputeResourcePolicy</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>6</td><td>batchQueueResourcePolicies</td><td><code>list&lt;<code><a href="#Struct_BatchQueueResourcePolicy">BatchQueueResourcePolicy</a></code>&gt;</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>7</td><td>creationTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>8</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
<tr><td>9</td><td>defaultCredentialStoreToken</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
</tbody></table><br/><pre>Group Resource Profile
gatewayID:
Unique identifier for the gateway assigned by Airavata. Corelate this to Airavata Admin API Gateway Registration.
groupResourceProfileId:
computeResourcePreferences:
List of resource preferences for each of the registered compute resources.
computeResourcePolicies:
List of enforced policies for each of the registered compute resources.
batchQueueResourcePolicies:
List of enforced policies on registered batch queues
defaultCredentialStoreToken:
The default credential store token to use for compute resources that don't specify a resource specific credential store token.
</pre><br/></div></div></body></html>