feat(serverless): add CronSchedule to job definitions (#1074)

Author: scaleway-bot

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

@@ -4,6 +4,8 @@ export { API } from './api.gen'
 export * from './content.gen'
 export type {
   CreateJobDefinitionRequest,
+  CreateJobDefinitionRequestCronScheduleConfig,
+  CronSchedule,
   DeleteJobDefinitionRequest,
   GetJobDefinitionRequest,
   GetJobRunRequest,
@@ -19,5 +21,6 @@ export type {
   StartJobDefinitionRequest,
   StopJobRunRequest,
   UpdateJobDefinitionRequest,
+  UpdateJobDefinitionRequestCronScheduleConfig,
 } from './types.gen'
 export * as ValidationRules from './validation-rules.gen'

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

@@ -9,13 +9,29 @@ import {
 import type { DefaultValues } from '../../../bridge'
 import type {
   CreateJobDefinitionRequest,
+  CreateJobDefinitionRequestCronScheduleConfig,
+  CronSchedule,
   JobDefinition,
   JobRun,
   ListJobDefinitionsResponse,
   ListJobRunsResponse,
   UpdateJobDefinitionRequest,
+  UpdateJobDefinitionRequestCronScheduleConfig,
 } from './types.gen'
 
+const unmarshalCronSchedule = (data: unknown): CronSchedule => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'CronSchedule' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    schedule: data.schedule,
+    timezone: data.timezone,
+  } as CronSchedule
+}
+
 export const unmarshalJobDefinition = (data: unknown): JobDefinition => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -27,6 +43,9 @@ export const unmarshalJobDefinition = (data: unknown): JobDefinition => {
     command: data.command,
     cpuLimit: data.cpu_limit,
     createdAt: unmarshalDate(data.created_at),
+    cronSchedule: data.cron_schedule
+      ? unmarshalCronSchedule(data.cron_schedule)
+      : undefined,
     description: data.description,
     environmentVariables: data.environment_variables,
     id: data.id,
@@ -96,12 +115,27 @@ export const unmarshalListJobRunsResponse = (
   } as ListJobRunsResponse
 }
 
+const marshalCreateJobDefinitionRequestCronScheduleConfig = (
+  request: CreateJobDefinitionRequestCronScheduleConfig,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  schedule: request.schedule,
+  timezone: request.timezone,
+})
+
 export const marshalCreateJobDefinitionRequest = (
   request: CreateJobDefinitionRequest,
   defaults: DefaultValues,
 ): Record<string, unknown> => ({
   command: request.command,
   cpu_limit: request.cpuLimit,
+  cron_schedule:
+    request.cronSchedule !== undefined
+      ? marshalCreateJobDefinitionRequestCronScheduleConfig(
+          request.cronSchedule,
+          defaults,
+        )
+      : undefined,
   description: request.description,
   environment_variables:
     request.environmentVariables !== undefined
@@ -114,12 +148,27 @@ export const marshalCreateJobDefinitionRequest = (
   project_id: request.projectId ?? defaults.defaultProjectId,
 })
 
+const marshalUpdateJobDefinitionRequestCronScheduleConfig = (
+  request: UpdateJobDefinitionRequestCronScheduleConfig,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  schedule: request.schedule,
+  timezone: request.timezone,
+})
+
 export const marshalUpdateJobDefinitionRequest = (
   request: UpdateJobDefinitionRequest,
   defaults: DefaultValues,
 ): Record<string, unknown> => ({
   command: request.command,
   cpu_limit: request.cpuLimit,
+  cron_schedule:
+    request.cronSchedule !== undefined
+      ? marshalUpdateJobDefinitionRequestCronScheduleConfig(
+          request.cronSchedule,
+          defaults,
+        )
+      : undefined,
   description: request.description,
   environment_variables: request.environmentVariables,
   image_uri: request.imageUri,

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

@@ -17,6 +17,16 @@ export type ListJobDefinitionsRequestOrderBy =
 
 export type ListJobRunsRequestOrderBy = 'created_at_asc' | 'created_at_desc'
 
+export interface CronSchedule {
+  schedule: string
+  timezone: string
+}
+
+export interface CreateJobDefinitionRequestCronScheduleConfig {
+  schedule: string
+  timezone: string
+}
+
 export interface JobDefinition {
   id: string
   name: string
@@ -30,6 +40,7 @@ export interface JobDefinition {
   environmentVariables: Record<string, string>
   description: string
   jobTimeout?: string
+  cronSchedule?: CronSchedule
   /**
    * Region to target. If none is passed will use default region from the
    * config.
@@ -56,6 +67,11 @@ export interface JobRun {
   region: Region
 }
 
+export interface UpdateJobDefinitionRequestCronScheduleConfig {
+  schedule?: string
+  timezone?: string
+}
+
 export type CreateJobDefinitionRequest = {
   /**
    * Region to target. If none is passed will use default region from the
@@ -80,6 +96,7 @@ export type CreateJobDefinitionRequest = {
   description: string
   /** Timeout of the job in seconds. */
   jobTimeout?: string
+  cronSchedule?: CreateJobDefinitionRequestCronScheduleConfig
 }
 
 export type DeleteJobDefinitionRequest = {
@@ -191,4 +208,5 @@ export type UpdateJobDefinitionRequest = {
   description?: string
   /** Timeout of the job in seconds. */
   jobTimeout?: string
+  cronSchedule?: UpdateJobDefinitionRequestCronScheduleConfig
 }

packages/clients/src/api/jobs/v1alpha1/validation-rules.gen.ts

@@ -17,6 +17,28 @@ export const CreateJobDefinitionRequest = {
   },
 }
 
+export const CreateJobDefinitionRequestCronScheduleConfig = {
+  schedule: {
+    maxLength: 255,
+    minLength: 1,
+  },
+  timezone: {
+    maxLength: 255,
+    minLength: 1,
+  },
+}
+
+export const CronSchedule = {
+  schedule: {
+    maxLength: 255,
+    minLength: 1,
+  },
+  timezone: {
+    maxLength: 255,
+    minLength: 1,
+  },
+}
+
 export const ListJobDefinitionsRequest = {
   page: {
     greaterThanOrEqual: 1,
@@ -52,3 +74,14 @@ export const UpdateJobDefinitionRequest = {
     pattern: /^[A-Za-z0-9-_]{3,50}$/,
   },
 }
+
+export const UpdateJobDefinitionRequestCronScheduleConfig = {
+  schedule: {
+    maxLength: 255,
+    minLength: 1,
+  },
+  timezone: {
+    maxLength: 255,
+    minLength: 1,
+  },
+}