Merge pull request #19 from arangodb-managed/OAS-7859

OAS-7859 | Add GraphAnalyticsJobSize field to UsageItem
arangodb-managed · Feb 8, 2024 · fa24867 · fa24867
2 parents 721abbf + 23c75df
commit fa24867
Show file tree

Hide file tree

Showing 6 changed files with 641 additions and 124 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -1867,6 +1867,10 @@ <h2>Table of Contents</h2>
                   <a href="#arangodb.cloud.usage.v1.UsageItem.DeploymentSize"><span class="badge">M</span>UsageItem.DeploymentSize</a>
                 </li>
 
+                <li>
+                  <a href="#arangodb.cloud.usage.v1.UsageItem.GraphAnalyticsJobSize"><span class="badge">M</span>UsageItem.GraphAnalyticsJobSize</a>
+                </li>
+
                 <li>
                   <a href="#arangodb.cloud.usage.v1.UsageItem.MLJobSize"><span class="badge">M</span>UsageItem.MLJobSize</a>
                 </li>
@@ -24325,6 +24329,14 @@ <h3 id="arangodb.cloud.usage.v1.UsageItem">UsageItem</h3>
 This field is only set when the usage item is of kind MLJobSize. </p></td>
                 </tr>
 
+                <tr>
+                  <td>graphanalyticsjob_size</td>
+                  <td><a href="#arangodb.cloud.usage.v1.UsageItem.GraphAnalyticsJobSize">UsageItem.GraphAnalyticsJobSize</a></td>
+                  <td></td>
+                  <td><p>Amount of compute resources used by a given ML job.
+This field is only set when the usage item is of kind MLJobSize. </p></td>
+                </tr>
+
             </tbody>
           </table>
 
@@ -24532,6 +24544,60 @@ <h3 id="arangodb.cloud.usage.v1.UsageItem.DeploymentSize">UsageItem.DeploymentSi
 
 
 
+        <h3 id="arangodb.cloud.usage.v1.UsageItem.GraphAnalyticsJobSize">UsageItem.GraphAnalyticsJobSize</h3>
+        <p>Amount of compute resources used by a Graph Analytics Job.</p>
+
+
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+
+                <tr>
+                  <td>memory_size</td>
+                  <td><a href="#int32">int32</a></td>
+                  <td></td>
+                  <td><p>Amount of memory (in GB) allocated for the job. </p></td>
+                </tr>
+
+                <tr>
+                  <td>cpu_size</td>
+                  <td><a href="#float">float</a></td>
+                  <td></td>
+                  <td><p>Amount of CPU units allocated to the job.
+1 CPU unit equals 1 physical / virtual CPU. </p></td>
+                </tr>
+
+                <tr>
+                  <td>gpu_size</td>
+                  <td><a href="#float">float</a></td>
+                  <td></td>
+                  <td><p>Amount of GPU units allocated to the job.
+1 CPU unit equals 1 physical / virtual GPU. </p></td>
+                </tr>
+
+                <tr>
+                  <td>job_id</td>
+                  <td><a href="#string">string</a></td>
+                  <td></td>
+                  <td><p>ID of the ML job. </p></td>
+                </tr>
+
+                <tr>
+                  <td>job_type</td>
+                  <td><a href="#string">string</a></td>
+                  <td></td>
+                  <td><p>Type of Graph Analytics job. </p></td>
+                </tr>
+
+            </tbody>
+          </table>
+
+
+
+
+
         <h3 id="arangodb.cloud.usage.v1.UsageItem.MLJobSize">UsageItem.MLJobSize</h3>
         <p>Amount of compute resources used by a ML Job.</p>
 

diff --git a/typescript/usage/v1/usage.ts b/typescript/usage/v1/usage.ts
@@ -170,6 +170,11 @@ export interface UsageItem {
   // This field is only set when the usage item is of kind MLJobSize.
   // UsageItem_MLJobSize
   mljob_size?: UsageItem_MLJobSize;
+
+  // Amount of compute resources used by a given ML job.
+  // This field is only set when the usage item is of kind MLJobSize.
+  // UsageItem_GraphAnalyticsJobSize
+  graphanalyticsjob_size?: UsageItem_GraphAnalyticsJobSize;
 }
 
 // Amount of audit log related resources used by the resource covered by this usage item.
@@ -263,6 +268,31 @@ export interface UsageItem_DeploymentSize {
   is_paused?: boolean;
 }
 
+// Amount of compute resources used by a Graph Analytics Job.
+export interface UsageItem_GraphAnalyticsJobSize {
+  // Amount of memory (in GB) allocated for the job.
+  // number
+  memory_size?: number;
+
+  // Amount of CPU units allocated to the job.
+  // 1 CPU unit equals 1 physical / virtual CPU.
+  // number
+  cpu_size?: number;
+
+  // Amount of GPU units allocated to the job.
+  // 1 CPU unit equals 1 physical / virtual GPU.
+  // number
+  gpu_size?: number;
+
+  // ID of the ML job.
+  // string
+  job_id?: string;
+
+  // Type of Graph Analytics job.
+  // string
+  job_type?: string;
+}
+
 // Amount of compute resources used by a ML Job.
 export interface UsageItem_MLJobSize {
   // Amount of memory (in GB) allocated for the job.

diff --git a/usage/v1/kinds.go b/usage/v1/kinds.go
@@ -60,4 +60,8 @@ const (
 	// the amount of resources used by a ML job (of a MLServices).
 	// UsageItems of this kind are closed on creation itself, so open items cannot exist.
 	UsageItemKindMLJobSize = "MLJobSize"
+	// UsageItemKindGraphAnalyticsJobSize indicates a UsageItem that contains
+	// the amount of resources used by a GraphAnalytics job.
+	// UsageItems of this kind are closed on creation, so open items cannot exist.
+	UsageItemKindGraphAnalyticsJobSize = "GraphAnalyticsJobSize"
 )