@scaleway/sdk 2.26.0 → 2.28.0

package/dist/api/jobs/v1alpha1/types.gen.d.ts

@@ -0,0 +1,210 @@
+import type { Region } from '../../../bridge';
+export type JobRunState = 'unknown_state' | 'queued' | 'scheduled' | 'running' | 'succeeded' | 'failed' | 'canceled' | 'internal_error';
+export type ListJobDefinitionsRequestOrderBy = 'created_at_asc' | 'created_at_desc';
+export type ListJobRunsRequestOrderBy = 'created_at_asc' | 'created_at_desc';
+export interface CronSchedule {
+    /** UNIX cron schedule to run job (e.g., '* * * * *'). */
+    schedule: string;
+    /**
+     * Timezone for the cron schedule, in tz database format (e.g.,
+     * 'Europe/Paris').
+     */
+    timezone: string;
+}
+export interface CreateJobDefinitionRequestCronScheduleConfig {
+    schedule: string;
+    timezone: string;
+}
+export interface JobDefinition {
+    id: string;
+    name: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    cpuLimit: number;
+    memoryLimit: number;
+    imageUri: string;
+    command: string;
+    projectId: string;
+    environmentVariables: Record<string, string>;
+    description: string;
+    jobTimeout?: string;
+    cronSchedule?: CronSchedule;
+    localStorageCapacity: number;
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region: Region;
+}
+export interface JobRun {
+    id: string;
+    jobDefinitionId: string;
+    state: JobRunState;
+    createdAt?: Date;
+    updatedAt?: Date;
+    terminatedAt?: Date;
+    exitCode?: number;
+    runDuration?: string;
+    errorMessage: string;
+    cpuLimit: number;
+    memoryLimit: number;
+    command: string;
+    environmentVariables: Record<string, string>;
+    localStorageCapacity: number;
+    startedAt?: Date;
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    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
+     * config.
+     */
+    region?: Region;
+    /** Name of the job definition. */
+    name?: string;
+    /** CPU limit of the job. */
+    cpuLimit: number;
+    /** Memory limit of the job (in MiB). */
+    memoryLimit: number;
+    /** Local storage capacity of the job (in MiB). */
+    localStorageCapacity?: number;
+    /** Image to use for the job. */
+    imageUri: string;
+    /**
+     * Startup command. If empty or not defined, the image's default command is
+     * used.
+     */
+    command: string;
+    /** UUID of the Scaleway Project containing the job. */
+    projectId?: string;
+    /** Environment variables of the job. */
+    environmentVariables?: Record<string, string>;
+    /** Description of the job. */
+    description: string;
+    /** Timeout of the job in seconds. */
+    jobTimeout?: string;
+    cronSchedule?: CreateJobDefinitionRequestCronScheduleConfig;
+};
+export type DeleteJobDefinitionRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** UUID of the job definition to delete. */
+    jobDefinitionId: string;
+};
+export type GetJobDefinitionRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** UUID of the job definition to get. */
+    jobDefinitionId: string;
+};
+export type GetJobRunRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** UUID of the job run to get. */
+    jobRunId: string;
+};
+export type ListJobDefinitionsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    page?: number;
+    pageSize?: number;
+    orderBy?: ListJobDefinitionsRequestOrderBy;
+    projectId?: string;
+    organizationId?: string;
+};
+export interface ListJobDefinitionsResponse {
+    jobDefinitions: JobDefinition[];
+    totalCount: number;
+}
+export type ListJobRunsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    page?: number;
+    pageSize?: number;
+    orderBy?: ListJobRunsRequestOrderBy;
+    jobDefinitionId?: string;
+    projectId?: string;
+    organizationId?: string;
+};
+export interface ListJobRunsResponse {
+    jobRuns: JobRun[];
+    totalCount: number;
+}
+export type StartJobDefinitionRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** UUID of the job definition to start. */
+    jobDefinitionId: string;
+    /** Contextual startup command for this specific job run. */
+    command?: string;
+    /** Contextual environment variables for this specific job run. */
+    environmentVariables?: Record<string, string>;
+    /** Number of jobs to run. */
+    replicas?: number;
+};
+export interface StartJobDefinitionResponse {
+    jobRuns: JobRun[];
+}
+export type StopJobRunRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** UUID of the job run to stop. */
+    jobRunId: string;
+};
+export type UpdateJobDefinitionRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** UUID of the job definition to update. */
+    jobDefinitionId: string;
+    /** Name of the job definition. */
+    name?: string;
+    /** CPU limit of the job. */
+    cpuLimit?: number;
+    /** Memory limit of the job (in MiB). */
+    memoryLimit?: number;
+    /** Local storage capacity of the job (in MiB). */
+    localStorageCapacity?: number;
+    /** Image to use for the job. */
+    imageUri?: string;
+    /** Startup command. */
+    command?: string;
+    /** Environment variables of the job. */
+    environmentVariables?: Record<string, string>;
+    /** Description of the job. */
+    description?: string;
+    /** Timeout of the job in seconds. */
+    jobTimeout?: string;
+    cronSchedule?: UpdateJobDefinitionRequestCronScheduleConfig;
+};

package/dist/api/jobs/v1alpha1/validation-rules.gen.cjs

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const CreateJobDefinitionRequest = {
+  cpuLimit: {
+    greaterThan: 0
+  },
+  imageUri: {
+    pattern: /^((?:(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]|__|[-]+)[a-z0-9]+)*(?:\/[a-z0-9]+(?:(?:[._]|__|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]{0,127}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]{32,}))?$/
+  },
+  localStorageCapacity: {
+    greaterThan: 0
+  },
+  memoryLimit: {
+    greaterThan: 0
+  },
+  name: {
+    pattern: /^[A-Za-z0-9-_]{3,50}$/
+  }
+};
+const CreateJobDefinitionRequestCronScheduleConfig = {
+  schedule: {
+    maxLength: 255,
+    minLength: 1
+  },
+  timezone: {
+    maxLength: 255,
+    minLength: 1
+  }
+};
+const CronSchedule = {
+  schedule: {
+    maxLength: 255,
+    minLength: 1
+  },
+  timezone: {
+    maxLength: 255,
+    minLength: 1
+  }
+};
+const ListJobDefinitionsRequest = {
+  page: {
+    greaterThanOrEqual: 1
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 1e3
+  }
+};
+const ListJobRunsRequest = {
+  page: {
+    greaterThanOrEqual: 1
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 1e3
+  }
+};
+const StartJobDefinitionRequest = {
+  replicas: {
+    greaterThan: 0
+  }
+};
+const UpdateJobDefinitionRequest = {
+  cpuLimit: {
+    greaterThan: 0
+  },
+  imageUri: {
+    pattern: /^((?:(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?\/)?[a-z0-9]+(?:(?:[._]|__|[-]+)[a-z0-9]+)*(?:\/[a-z0-9]+(?:(?:[._]|__|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]{0,127}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]{32,}))?$/
+  },
+  localStorageCapacity: {
+    greaterThan: 0
+  },
+  memoryLimit: {
+    greaterThan: 0
+  },
+  name: {
+    pattern: /^[A-Za-z0-9-_]{3,50}$/
+  }
+};
+const UpdateJobDefinitionRequestCronScheduleConfig = {
+  schedule: {
+    maxLength: 255,
+    minLength: 1
+  },
+  timezone: {
+    maxLength: 255,
+    minLength: 1
+  }
+};
+exports.CreateJobDefinitionRequest = CreateJobDefinitionRequest;
+exports.CreateJobDefinitionRequestCronScheduleConfig = CreateJobDefinitionRequestCronScheduleConfig;
+exports.CronSchedule = CronSchedule;
+exports.ListJobDefinitionsRequest = ListJobDefinitionsRequest;
+exports.ListJobRunsRequest = ListJobRunsRequest;
+exports.StartJobDefinitionRequest = StartJobDefinitionRequest;
+exports.UpdateJobDefinitionRequest = UpdateJobDefinitionRequest;
+exports.UpdateJobDefinitionRequestCronScheduleConfig = UpdateJobDefinitionRequestCronScheduleConfig;

package/dist/api/jobs/v1alpha1/validation-rules.gen.d.ts

@@ -0,0 +1,87 @@
+export declare const CreateJobDefinitionRequest: {
+    cpuLimit: {
+        greaterThan: number;
+    };
+    imageUri: {
+        pattern: RegExp;
+    };
+    localStorageCapacity: {
+        greaterThan: number;
+    };
+    memoryLimit: {
+        greaterThan: number;
+    };
+    name: {
+        pattern: RegExp;
+    };
+};
+export declare const CreateJobDefinitionRequestCronScheduleConfig: {
+    schedule: {
+        maxLength: number;
+        minLength: number;
+    };
+    timezone: {
+        maxLength: number;
+        minLength: number;
+    };
+};
+export declare const CronSchedule: {
+    schedule: {
+        maxLength: number;
+        minLength: number;
+    };
+    timezone: {
+        maxLength: number;
+        minLength: number;
+    };
+};
+export declare const ListJobDefinitionsRequest: {
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const ListJobRunsRequest: {
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const StartJobDefinitionRequest: {
+    replicas: {
+        greaterThan: number;
+    };
+};
+export declare const UpdateJobDefinitionRequest: {
+    cpuLimit: {
+        greaterThan: number;
+    };
+    imageUri: {
+        pattern: RegExp;
+    };
+    localStorageCapacity: {
+        greaterThan: number;
+    };
+    memoryLimit: {
+        greaterThan: number;
+    };
+    name: {
+        pattern: RegExp;
+    };
+};
+export declare const UpdateJobDefinitionRequestCronScheduleConfig: {
+    schedule: {
+        maxLength: number;
+        minLength: number;
+    };
+    timezone: {
+        maxLength: number;
+        minLength: number;
+    };
+};

package/dist/api/jobs/v1alpha1/validation-rules.gen.js

@@ -1,6 +1,3 @@
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
-
 const CreateJobDefinitionRequest = {
   cpuLimit: {
     greaterThan: 0
@@ -44,7 +41,7 @@ const ListJobDefinitionsRequest = {
   },
   pageSize: {
     greaterThanOrEqual: 1,
-    lessThanOrEqual: 1000
+    lessThanOrEqual: 1e3
   }
 };
 const ListJobRunsRequest = {
@@ -53,7 +50,7 @@ const ListJobRunsRequest = {
   },
   pageSize: {
     greaterThanOrEqual: 1,
-    lessThanOrEqual: 1000
+    lessThanOrEqual: 1e3
   }
 };
 const StartJobDefinitionRequest = {
@@ -88,5 +85,13 @@ const UpdateJobDefinitionRequestCronScheduleConfig = {
     minLength: 1
   }
 };
-
-export { CreateJobDefinitionRequest, CreateJobDefinitionRequestCronScheduleConfig, CronSchedule, ListJobDefinitionsRequest, ListJobRunsRequest, StartJobDefinitionRequest, UpdateJobDefinitionRequest, UpdateJobDefinitionRequestCronScheduleConfig };
+export {
+  CreateJobDefinitionRequest,
+  CreateJobDefinitionRequestCronScheduleConfig,
+  CronSchedule,
+  ListJobDefinitionsRequest,
+  ListJobRunsRequest,
+  StartJobDefinitionRequest,
+  UpdateJobDefinitionRequest,
+  UpdateJobDefinitionRequestCronScheduleConfig
+};

package/dist/api/k8s/index.cjs

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const index = require("./v1/index.cjs");
+exports.v1 = index;

package/dist/api/k8s/index.d.ts

@@ -0,0 +1 @@
+export * as v1 from './v1/index';

package/dist/api/k8s/index.js

@@ -1,2 +1,4 @@
-import * as index from './v1/index.js';
-export { index as v1 };
+import * as index from "./v1/index.js";
+export {
+  index as v1
+};