@scaleway/sdk-jobs 2.2.0 → 2.2.2

package/dist/v1alpha2/types.gen.d.ts

@@ -0,0 +1,484 @@
+import type { Region as ScwRegion } from '@scaleway/sdk-client';
+export type JobRunReason = 'unknown_reason' | 'invalid_request' | 'timeout' | 'cancellation' | 'technical_error' | 'image_not_found' | 'invalid_image' | 'memory_usage_exceeded' | 'storage_usage_exceeded' | 'exited_with_error' | 'secret_disabled' | 'secret_not_found' | 'quota_exceeded';
+export type JobRunState = 'unknown_state' | 'initialized' | 'validated' | 'queued' | 'running' | 'succeeded' | 'failed' | 'interrupting' | 'interrupted' | 'retrying';
+export type ListJobDefinitionsRequestOrderBy = 'created_at_asc' | 'created_at_desc';
+export type ListJobRunsRequestOrderBy = 'created_at_asc' | 'created_at_desc';
+export interface SecretEnvVar {
+    name: string;
+}
+export interface SecretFile {
+    path: string;
+}
+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 RetryPolicy {
+    /**
+     * Maximum number of retries upon a job failure.
+     */
+    maxRetries: number;
+}
+export interface CreateJobDefinitionRequestCronScheduleConfig {
+    schedule: string;
+    timezone: string;
+}
+export interface CreateSecretsRequestSecretConfig {
+    secretManagerId: string;
+    secretManagerVersion: string;
+    /**
+     *
+     * 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.
+     */
+    envVarName?: string;
+}
+export interface Secret {
+    /**
+     * UUID of the secret reference within the job.
+     */
+    secretId: string;
+    /**
+     * UUID of the secret in Secret Manager.
+     */
+    secretManagerId: string;
+    /**
+     * Version of the secret in Secret Manager.
+     */
+    secretManagerVersion: string;
+    /**
+     * UUID of the job definition.
+     */
+    jobDefinitionId: string;
+    /**
+     * File secret mounted inside the job.
+     *
+     * One-of ('secretConfig'): at most one of 'file', 'envVar' could be set.
+     */
+    file?: SecretFile;
+    /**
+     * Environment variable used to expose the secret.
+     *
+     * One-of ('secretConfig'): at most one of 'file', 'envVar' could be set.
+     */
+    envVar?: SecretEnvVar;
+}
+export interface JobDefinition {
+    id: string;
+    name: string;
+    projectId: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    cpuLimit: number;
+    memoryLimit: number;
+    localStorageCapacity: number;
+    imageUri: string;
+    /**
+     * @deprecated
+     */
+    command?: string;
+    environmentVariables: Record<string, string>;
+    jobTimeout?: string;
+    description: string;
+    cronSchedule?: CronSchedule;
+    startupCommand: string[];
+    args: string[];
+    retryPolicy?: RetryPolicy;
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region: ScwRegion;
+}
+export interface Resource {
+    computeLimitMvcpu: number;
+    memoryLimitBytes: number;
+}
+export interface JobRun {
+    id: string;
+    jobDefinitionId: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    startedAt?: Date;
+    terminatedAt?: Date;
+    runDuration?: string;
+    state: JobRunState;
+    reason?: JobRunReason;
+    exitCode?: number;
+    errorMessage?: string;
+    cpuLimit: number;
+    memoryLimit: number;
+    localStorageCapacity: number;
+    /**
+     * @deprecated
+     */
+    command?: string;
+    environmentVariables: Record<string, string>;
+    startupCommand: string[];
+    args: string[];
+    attempts?: number;
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region: ScwRegion;
+}
+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?: ScwRegion;
+    /**
+     * Name of the job definition.
+     */
+    name?: string;
+    /**
+     * CPU limit of the job (in mvCPU).
+     */
+    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;
+    /**
+     * @deprecated Deprecated: please use startup_command instead.
+     */
+    command?: string;
+    /**
+     * The main executable or entrypoint script to run.
+  If both command and startup_command are provided, only startup_command will be used.
+     */
+    startupCommand?: string[];
+    /**
+     * Passed to the startup command at runtime.
+  Environment variables and secrets can be included, and will be expanded before the arguments are used.
+     */
+    args?: 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;
+    /**
+     * Configure a cron for the job.
+     */
+    cronSchedule?: CreateJobDefinitionRequestCronScheduleConfig;
+    /**
+     * Retry behaviour in case of job failure.
+     */
+    retryPolicy?: RetryPolicy;
+};
+export type CreateSecretsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the job definition.
+     */
+    jobDefinitionId: string;
+    /**
+     * List of secrets to inject into the job.
+     */
+    secrets: CreateSecretsRequestSecretConfig[];
+};
+export interface CreateSecretsResponse {
+    /**
+     * List of secrets created.
+     */
+    secrets: Secret[];
+}
+export type DeleteJobDefinitionRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the job definition to delete.
+     */
+    jobDefinitionId: string;
+};
+export type DeleteSecretRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * 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?: ScwRegion;
+    /**
+     * UUID of the job definition to get.
+     */
+    jobDefinitionId: string;
+};
+export type GetJobLimitsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+};
+export type GetJobRunRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the job run to get.
+     */
+    jobRunId: string;
+};
+export type GetSecretRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the secret reference within the job.
+     */
+    secretId: string;
+};
+export interface JobLimits {
+    secretsPerJobDefinition: number;
+}
+export type ListJobDefinitionsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    page?: number;
+    pageSize?: number;
+    orderBy?: ListJobDefinitionsRequestOrderBy;
+    projectId?: string;
+    organizationId?: string;
+};
+export interface ListJobDefinitionsResponse {
+    jobDefinitions: JobDefinition[];
+    totalCount: number;
+}
+export type ListJobResourcesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+};
+export interface ListJobResourcesResponse {
+    resources: Resource[];
+}
+export type ListJobRunsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    page?: number;
+    pageSize?: number;
+    orderBy?: ListJobRunsRequestOrderBy;
+    jobDefinitionId?: string;
+    projectId?: string;
+    organizationId?: string;
+    state?: JobRunState;
+    states?: JobRunState[];
+    reasons?: JobRunReason[];
+};
+export interface ListJobRunsResponse {
+    jobRuns: JobRun[];
+    totalCount: number;
+}
+export type ListSecretsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the job definition.
+     */
+    jobDefinitionId: string;
+};
+export interface ListSecretsResponse {
+    /**
+     * List of secret references within a job definition.
+     */
+    secrets: Secret[];
+    /**
+     * Total count of secret references within a job definition.
+     */
+    totalCount: number;
+}
+export type StartJobDefinitionRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the job definition to start.
+     */
+    jobDefinitionId: string;
+    /**
+     * @deprecated If empty or not defined, the image's default command is used.
+  Deprecated: please use startup_command instead.
+     */
+    command?: string;
+    /**
+     * Overrides the default defined in the job image.
+  The main executable or entrypoint script to run.
+  If both command and startup_command are provided, only startup_command will be used.
+     */
+    startupCommand?: string[];
+    /**
+     * Overrides the default arguments defined in the job image.
+  Passed to the contextual startup command at runtime.
+  Environment variables and secrets can be included, and will be expanded before the arguments are used.
+     */
+    args?: string[];
+    /**
+     * Contextual environment variables for this specific job run.
+     */
+    environmentVariables?: Record<string, string>;
+    /**
+     * Number of jobs to run.
+     */
+    replicas?: number;
+};
+export interface StartJobDefinitionResponse {
+    /**
+     * List of started job runs.
+     */
+    jobRuns: JobRun[];
+}
+export type StopJobRunRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * 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?: ScwRegion;
+    /**
+     * UUID of the job definition to update.
+     */
+    jobDefinitionId: string;
+    /**
+     * Name of the job definition.
+     */
+    name?: string;
+    /**
+     * CPU limit of the job (in mvCPU).
+     */
+    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;
+    /**
+     * @deprecated Deprecated: please use startup_command instead.
+     */
+    command?: string;
+    /**
+     * The main executable or entrypoint script to run.
+  If both command and startup_command are provided, only startup_command will be used.
+     */
+    startupCommand?: string[];
+    /**
+     * Passed to the startup command at runtime.
+  Environment variables and secrets can be included, and will be expanded before the arguments are used.
+     */
+    args?: string[];
+    /**
+     * Environment variables of the job.
+     */
+    environmentVariables?: Record<string, string>;
+    /**
+     * Description of the job.
+     */
+    description?: string;
+    /**
+     * Timeout of the job in seconds.
+     */
+    jobTimeout?: string;
+    /**
+     * Configure a cron for the job.
+     */
+    cronSchedule?: UpdateJobDefinitionRequestCronScheduleConfig;
+    /**
+     * Retry behaviour in case of job failure.
+     */
+    retryPolicy?: RetryPolicy;
+};
+export type UpdateSecretRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the secret reference within the job.
+     */
+    secretId: string;
+    /**
+     * 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).
+     *
+     * 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).
+     *
+     * One-of ('secretConfig'): at most one of 'path', 'envVarName' could be set.
+     */
+    envVarName?: string;
+};

package/dist/v1alpha2/validation-rules.gen.d.ts

@@ -0,0 +1,108 @@
+export declare const CreateJobDefinitionRequest: {
+    cpuLimit: {
+        greaterThan: number;
+    };
+    description: {
+        maxLength: 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 CreateSecretsRequestSecretConfig: {
+    secretManagerVersion: {
+        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 RetryPolicy: {
+    maxRetries: {
+        lessThanOrEqual: number;
+    };
+};
+export declare const StartJobDefinitionRequest: {
+    replicas: {
+        greaterThan: number;
+    };
+};
+export declare const UpdateJobDefinitionRequest: {
+    cpuLimit: {
+        greaterThan: number;
+    };
+    description: {
+        maxLength: 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;
+    };
+};
+export declare const UpdateSecretRequest: {
+    secretManagerVersion: {
+        minLength: number;
+    };
+};

package/dist/v1alpha2/validation-rules.gen.js

@@ -0,0 +1,121 @@
+const CreateJobDefinitionRequest = {
+  cpuLimit: {
+    greaterThan: 0
+  },
+  description: {
+    maxLength: 255
+  },
+  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[A-Za-z0-9_.-]{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 CreateSecretsRequestSecretConfig = {
+  secretManagerVersion: {
+    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 RetryPolicy = {
+  maxRetries: {
+    lessThanOrEqual: 5
+  }
+};
+const StartJobDefinitionRequest = {
+  replicas: {
+    greaterThan: 0
+  }
+};
+const UpdateJobDefinitionRequest = {
+  cpuLimit: {
+    greaterThan: 0
+  },
+  description: {
+    maxLength: 255
+  },
+  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[A-Za-z0-9_.-]{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
+  }
+};
+const UpdateSecretRequest = {
+  secretManagerVersion: {
+    minLength: 1
+  }
+};
+export {
+  CreateJobDefinitionRequest,
+  CreateJobDefinitionRequestCronScheduleConfig,
+  CreateSecretsRequestSecretConfig,
+  CronSchedule,
+  ListJobDefinitionsRequest,
+  ListJobRunsRequest,
+  RetryPolicy,
+  StartJobDefinitionRequest,
+  UpdateJobDefinitionRequest,
+  UpdateJobDefinitionRequestCronScheduleConfig,
+  UpdateSecretRequest
+};