@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/jobs/v1alpha1/api.gen.cjs

@@ -75,8 +75,7 @@ class API extends api.API {
     request
   );
   /**
-   * Update an existing job definition associated with the specified unique
-   * identifier.
+   * Update an existing job definition associated with the specified unique identifier.
    *
    * @param request - The request {@link UpdateJobDefinitionRequest}
    * @returns A Promise of JobDefinition
@@ -102,8 +101,7 @@ class API extends api.API {
     path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${marshalling.validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
   });
   /**
-   * Run an existing job definition by its unique identifier. This will create a
-   * new job run.
+   * Run an existing job definition by its unique identifier. This will create a new job run.
    *
    * @param request - The request {@link StartJobDefinitionRequest}
    * @returns A Promise of StartJobDefinitionResponse

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

@@ -3,8 +3,8 @@ import type { Region as ScwRegion } from '@scaleway/sdk-client';
 import type { CreateJobDefinitionRequest, CreateJobDefinitionSecretsRequest, CreateJobDefinitionSecretsResponse, DeleteJobDefinitionRequest, DeleteJobDefinitionSecretRequest, GetJobDefinitionRequest, GetJobDefinitionSecretRequest, GetJobRunRequest, GetJobsLimitsRequest, JobDefinition, JobRun, JobsLimits, ListJobDefinitionSecretsRequest, ListJobDefinitionSecretsResponse, ListJobDefinitionsRequest, ListJobDefinitionsResponse, ListJobRunsRequest, ListJobRunsResponse, ListJobsResourcesRequest, ListJobsResourcesResponse, Secret, StartJobDefinitionRequest, StartJobDefinitionResponse, StopJobRunRequest, UpdateJobDefinitionRequest, UpdateJobDefinitionSecretRequest } from './types.gen';
 /**
  * Serverless Jobs API.
- *
- * This API allows you to manage your Serverless Jobs.
+
+This API allows you to manage your Serverless Jobs.
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
@@ -35,8 +35,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<JobDefinition[], void, void>;
     };
     /**
-     * Update an existing job definition associated with the specified unique
-     * identifier.
+     * Update an existing job definition associated with the specified unique identifier.
      *
      * @param request - The request {@link UpdateJobDefinitionRequest}
      * @returns A Promise of JobDefinition
@@ -49,8 +48,7 @@ export declare class API extends ParentAPI {
      */
     deleteJobDefinition: (request: Readonly<DeleteJobDefinitionRequest>) => Promise<void>;
     /**
-     * Run an existing job definition by its unique identifier. This will create a
-     * new job run.
+     * Run an existing job definition by its unique identifier. This will create a new job run.
      *
      * @param request - The request {@link StartJobDefinitionRequest}
      * @returns A Promise of StartJobDefinitionResponse

package/dist/api/jobs/v1alpha1/api.gen.js

@@ -73,8 +73,7 @@ class API extends API$1 {
     request
   );
   /**
-   * Update an existing job definition associated with the specified unique
-   * identifier.
+   * Update an existing job definition associated with the specified unique identifier.
    *
    * @param request - The request {@link UpdateJobDefinitionRequest}
    * @returns A Promise of JobDefinition
@@ -100,8 +99,7 @@ class API extends API$1 {
     path: `/serverless-jobs/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
   });
   /**
-   * Run an existing job definition by its unique identifier. This will create a
-   * new job run.
+   * Run an existing job definition by its unique identifier. This will create a new job run.
    *
    * @param request - The request {@link StartJobDefinitionRequest}
    * @returns A Promise of StartJobDefinitionResponse

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

@@ -9,11 +9,12 @@ export interface SecretFile {
     path: string;
 }
 export interface CronSchedule {
-    /** UNIX cron schedule to run job (e.g., '* * * * *'). */
+    /**
+     * UNIX cron schedule to run job (e.g., '* * * * *').
+     */
     schedule: string;
     /**
-     * Timezone for the cron schedule, in tz database format (e.g.,
-     * 'Europe/Paris').
+     * Timezone for the cron schedule, in tz database format (e.g., 'Europe/Paris').
      */
     timezone: string;
 }
@@ -24,17 +25,29 @@ export interface CreateJobDefinitionRequestCronScheduleConfig {
 export interface CreateJobDefinitionSecretsRequestSecretConfig {
     secretManagerId: string;
     secretManagerVersion: string;
-    /** One-of ('pathOrEnvVar'): at most one of 'path', 'envVarName' could be set. */
+    /**
+     *
+     * One-of ('pathOrEnvVar'): at most one of 'path', 'envVarName' could be set.
+     */
     path?: string;
-    /** One-of ('pathOrEnvVar'): at most one of 'path', 'envVarName' could be set. */
+    /**
+     *
+     * One-of ('pathOrEnvVar'): at most one of 'path', 'envVarName' could be set.
+     */
     envVarName?: string;
 }
 export interface Secret {
-    /** UUID of the secret reference within the job. */
+    /**
+     * UUID of the secret reference within the job.
+     */
     secretId: string;
-    /** UUID of the secret in Secret Manager. */
+    /**
+     * UUID of the secret in Secret Manager.
+     */
     secretManagerId: string;
-    /** Version of the secret in Secret Manager. */
+    /**
+     * Version of the secret in Secret Manager.
+     */
     secretManagerVersion: string;
     /**
      * File secret mounted inside the job.
@@ -65,8 +78,7 @@ export interface JobDefinition {
     cronSchedule?: CronSchedule;
     localStorageCapacity: number;
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region: ScwRegion;
 }
@@ -87,8 +99,7 @@ export interface JobRun {
     localStorageCapacity: number;
     startedAt?: Date;
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region: ScwRegion;
 }
@@ -102,104 +113,135 @@ export interface UpdateJobDefinitionRequestCronScheduleConfig {
 }
 export type CreateJobDefinitionRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Name of the job definition. */
+    /**
+     * Name of the job definition.
+     */
     name?: string;
-    /** CPU limit of the job. */
+    /**
+     * CPU limit of the job.
+     */
     cpuLimit: number;
-    /** Memory limit of the job (in MiB). */
+    /**
+     * Memory limit of the job (in MiB).
+     */
     memoryLimit: number;
-    /** Local storage capacity of the job (in MiB). */
+    /**
+     * Local storage capacity of the job (in MiB).
+     */
     localStorageCapacity?: number;
-    /** Image to use for the job. */
+    /**
+     * Image to use for the job.
+     */
     imageUri: string;
     /**
-     * Startup command. If empty or not defined, the image's default command is
-     * used.
+     * Startup command. If empty or not defined, the image's default command is used.
      */
     command: string;
-    /** UUID of the Scaleway Project containing the job. */
+    /**
+     * UUID of the Scaleway Project containing the job.
+     */
     projectId?: string;
-    /** Environment variables of the job. */
+    /**
+     * Environment variables of the job.
+     */
     environmentVariables?: Record<string, string>;
-    /** Description of the job. */
+    /**
+     * Description of the job.
+     */
     description: string;
-    /** Timeout of the job in seconds. */
+    /**
+     * Timeout of the job in seconds.
+     */
     jobTimeout?: string;
-    /** Configure a cron for the job. */
+    /**
+     * Configure a cron for the job.
+     */
     cronSchedule?: CreateJobDefinitionRequestCronScheduleConfig;
 };
 export type CreateJobDefinitionSecretsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** UUID of the job definition. */
+    /**
+     * UUID of the job definition.
+     */
     jobDefinitionId: string;
-    /** List of secrets to inject into the job. */
+    /**
+     * List of secrets to inject into the job.
+     */
     secrets: CreateJobDefinitionSecretsRequestSecretConfig[];
 };
 export interface CreateJobDefinitionSecretsResponse {
-    /** List of secrets created. */
+    /**
+     * List of secrets created.
+     */
     secrets: Secret[];
 }
 export type DeleteJobDefinitionRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** UUID of the job definition to delete. */
+    /**
+     * UUID of the job definition to delete.
+     */
     jobDefinitionId: string;
 };
 export type DeleteJobDefinitionSecretRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** UUID of the job definition. */
+    /**
+     * UUID of the job definition.
+     */
     jobDefinitionId: string;
-    /** UUID of the secret reference within the job. */
+    /**
+     * UUID of the secret reference within the job.
+     */
     secretId: string;
 };
 export type GetJobDefinitionRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** UUID of the job definition to get. */
+    /**
+     * UUID of the job definition to get.
+     */
     jobDefinitionId: string;
 };
 export type GetJobDefinitionSecretRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** UUID of the job definition. */
+    /**
+     * UUID of the job definition.
+     */
     jobDefinitionId: string;
-    /** UUID of the secret reference within the job. */
+    /**
+     * UUID of the secret reference within the job.
+     */
     secretId: string;
 };
 export type GetJobRunRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** UUID of the job run to get. */
+    /**
+     * UUID of the job run to get.
+     */
     jobRunId: string;
 };
 export type GetJobsLimitsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
 };
@@ -208,23 +250,27 @@ export interface JobsLimits {
 }
 export type ListJobDefinitionSecretsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** UUID of the job definition. */
+    /**
+     * UUID of the job definition.
+     */
     jobDefinitionId: string;
 };
 export interface ListJobDefinitionSecretsResponse {
-    /** List of secret references within a job definition. */
+    /**
+     * List of secret references within a job definition.
+     */
     secrets: Secret[];
-    /** Total count of secret references within a job definition. */
+    /**
+     * Total count of secret references within a job definition.
+     */
     totalCount: number;
 }
 export type ListJobDefinitionsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
     page?: number;
@@ -239,8 +285,7 @@ export interface ListJobDefinitionsResponse {
 }
 export type ListJobRunsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
     page?: number;
@@ -257,8 +302,7 @@ export interface ListJobRunsResponse {
 }
 export type ListJobsResourcesRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
 };
@@ -267,17 +311,24 @@ export interface ListJobsResourcesResponse {
 }
 export type StartJobDefinitionRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** UUID of the job definition to start. */
+    /**
+     * UUID of the job definition to start.
+     */
     jobDefinitionId: string;
-    /** Contextual startup command for this specific job run. */
+    /**
+     * Contextual startup command for this specific job run.
+     */
     command?: string;
-    /** Contextual environment variables for this specific job run. */
+    /**
+     * Contextual environment variables for this specific job run.
+     */
     environmentVariables?: Record<string, string>;
-    /** Number of jobs to run. */
+    /**
+     * Number of jobs to run.
+     */
     replicas?: number;
 };
 export interface StartJobDefinitionResponse {
@@ -285,63 +336,86 @@ export interface StartJobDefinitionResponse {
 }
 export type StopJobRunRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** UUID of the job run to stop. */
+    /**
+     * 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 to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** UUID of the job definition to update. */
+    /**
+     * UUID of the job definition to update.
+     */
     jobDefinitionId: string;
-    /** Name of the job definition. */
+    /**
+     * Name of the job definition.
+     */
     name?: string;
-    /** CPU limit of the job. */
+    /**
+     * CPU limit of the job.
+     */
     cpuLimit?: number;
-    /** Memory limit of the job (in MiB). */
+    /**
+     * Memory limit of the job (in MiB).
+     */
     memoryLimit?: number;
-    /** Local storage capacity of the job (in MiB). */
+    /**
+     * Local storage capacity of the job (in MiB).
+     */
     localStorageCapacity?: number;
-    /** Image to use for the job. */
+    /**
+     * Image to use for the job.
+     */
     imageUri?: string;
-    /** Startup command. */
+    /**
+     * Startup command.
+     */
     command?: string;
-    /** Environment variables of the job. */
+    /**
+     * Environment variables of the job.
+     */
     environmentVariables?: Record<string, string>;
-    /** Description of the job. */
+    /**
+     * Description of the job.
+     */
     description?: string;
-    /** Timeout of the job in seconds. */
+    /**
+     * Timeout of the job in seconds.
+     */
     jobTimeout?: string;
     cronSchedule?: UpdateJobDefinitionRequestCronScheduleConfig;
 };
 export type UpdateJobDefinitionSecretRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** UUID of the job definition. */
+    /**
+     * UUID of the job definition.
+     */
     jobDefinitionId: string;
-    /** UUID of the secret reference within the job. */
+    /**
+     * UUID of the secret reference within the job.
+     */
     secretId: string;
-    /** Version of the secret in Secret Manager. */
+    /**
+     * Version of the secret in Secret Manager.
+     */
     secretManagerVersion?: string;
     /**
-     * Path of the secret to mount inside the job (either `path` or `env_var_name`
-     * must be set).
+     * Path of the secret to mount inside the job (either `path` or `env_var_name` must be set).
      *
      * One-of ('secretConfig'): at most one of 'path', 'envVarName' could be set.
      */
     path?: string;
     /**
-     * Environment variable name used to expose the secret inside the job (either
-     * `path` or `env_var_name` must be set).
+     * Environment variable name used to expose the secret inside the job (either `path` or `env_var_name` must be set).
      *
      * One-of ('secretConfig'): at most one of 'path', 'envVarName' could be set.
      */