feat(serverless_jobs): add ListJobsResources method (#1309)

Author: scaleway-bot

packages/clients/src/api/jobs/v1alpha1/api.gen.ts

@@ -15,6 +15,7 @@ import {
   unmarshalJobRun,
   unmarshalListJobDefinitionsResponse,
   unmarshalListJobRunsResponse,
+  unmarshalListJobsResourcesResponse,
   unmarshalStartJobDefinitionResponse,
 } from './marshalling.gen'
 import type {
@@ -28,6 +29,8 @@ import type {
   ListJobDefinitionsResponse,
   ListJobRunsRequest,
   ListJobRunsResponse,
+  ListJobsResourcesRequest,
+  ListJobsResourcesResponse,
   StartJobDefinitionRequest,
   StartJobDefinitionResponse,
   StopJobRunRequest,
@@ -226,4 +229,19 @@ export class API extends ParentAPI {
    */
   listJobRuns = (request: Readonly<ListJobRunsRequest> = {}) =>
     enrichForPagination('jobRuns', this.pageOfListJobRuns, request)
+
+  /**
+   * List jobs resources for the console.
+   *
+   * @param request - The request {@link ListJobsResourcesRequest}
+   * @returns A Promise of ListJobsResourcesResponse
+   */
+  listJobsResources = (request: Readonly<ListJobsResourcesRequest> = {}) =>
+    this.client.fetch<ListJobsResourcesResponse>(
+      {
+        method: 'GET',
+        path: `/serverless-jobs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/jobs-resources`,
+      },
+      unmarshalListJobsResourcesResponse,
+    )
 }

packages/clients/src/api/jobs/v1alpha1/index.gen.ts

@@ -18,6 +18,9 @@ export type {
   ListJobRunsRequest,
   ListJobRunsRequestOrderBy,
   ListJobRunsResponse,
+  ListJobsResourcesRequest,
+  ListJobsResourcesResponse,
+  Resource,
   StartJobDefinitionRequest,
   StartJobDefinitionResponse,
   StopJobRunRequest,

packages/clients/src/api/jobs/v1alpha1/marshalling.gen.ts

@@ -15,6 +15,8 @@ import type {
   JobRun,
   ListJobDefinitionsResponse,
   ListJobRunsResponse,
+  ListJobsResourcesResponse,
+  Resource,
   StartJobDefinitionRequest,
   StartJobDefinitionResponse,
   UpdateJobDefinitionRequest,
@@ -122,6 +124,33 @@ export const unmarshalListJobRunsResponse = (
   } as ListJobRunsResponse
 }
 
+const unmarshalResource = (data: unknown): Resource => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Resource' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    cpuLimit: data.cpu_limit,
+    memoryLimit: data.memory_limit,
+  } as Resource
+}
+
+export const unmarshalListJobsResourcesResponse = (
+  data: unknown,
+): ListJobsResourcesResponse => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListJobsResourcesResponse' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    resources: unmarshalArrayOfObject(data.resources, unmarshalResource),
+  } as ListJobsResourcesResponse
+}
+
 export const unmarshalStartJobDefinitionResponse = (
   data: unknown,
 ): StartJobDefinitionResponse => {

packages/clients/src/api/jobs/v1alpha1/types.gen.ts

@@ -78,6 +78,11 @@ export interface JobRun {
   region: Region
 }
 
+export interface Resource {
+  cpuLimit: number
+  memoryLimit: number
+}
+
 export interface UpdateJobDefinitionRequestCronScheduleConfig {
   schedule?: string
   timezone?: string
@@ -182,6 +187,18 @@ export interface ListJobRunsResponse {
   totalCount: number
 }
 
+export type ListJobsResourcesRequest = {
+  /**
+   * Region to target. If none is passed will use default region from the
+   * config.
+   */
+  region?: Region
+}
+
+export interface ListJobsResourcesResponse {
+  resources: Resource[]
+}
+
 export type StartJobDefinitionRequest = {
   /**
    * Region to target. If none is passed will use default region from the