@scaleway/sdk-jobs 1.0.1

package/dist/v1alpha1/marshalling.gen.js

@@ -0,0 +1,262 @@
+import randomName from "@scaleway/random-name";
+import { resolveOneOf, isJSONObject, unmarshalDate, unmarshalArrayOfObject } from "@scaleway/sdk-client";
+const unmarshalSecretEnvVar = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'SecretEnvVar' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    name: data.name
+  };
+};
+const unmarshalSecretFile = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'SecretFile' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    path: data.path
+  };
+};
+const unmarshalSecret = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Secret' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    envVar: data.env_var ? unmarshalSecretEnvVar(data.env_var) : void 0,
+    file: data.file ? unmarshalSecretFile(data.file) : void 0,
+    secretId: data.secret_id,
+    secretManagerId: data.secret_manager_id,
+    secretManagerVersion: data.secret_manager_version
+  };
+};
+const unmarshalCronSchedule = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'CronSchedule' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    schedule: data.schedule,
+    timezone: data.timezone
+  };
+};
+const unmarshalJobDefinition = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'JobDefinition' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    command: data.command,
+    cpuLimit: data.cpu_limit,
+    createdAt: unmarshalDate(data.created_at),
+    cronSchedule: data.cron_schedule ? unmarshalCronSchedule(data.cron_schedule) : void 0,
+    description: data.description,
+    environmentVariables: data.environment_variables,
+    id: data.id,
+    imageUri: data.image_uri,
+    jobTimeout: data.job_timeout,
+    localStorageCapacity: data.local_storage_capacity,
+    memoryLimit: data.memory_limit,
+    name: data.name,
+    projectId: data.project_id,
+    region: data.region,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalJobRun = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'JobRun' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    command: data.command,
+    cpuLimit: data.cpu_limit,
+    createdAt: unmarshalDate(data.created_at),
+    environmentVariables: data.environment_variables,
+    errorMessage: data.error_message,
+    exitCode: data.exit_code,
+    id: data.id,
+    jobDefinitionId: data.job_definition_id,
+    localStorageCapacity: data.local_storage_capacity,
+    memoryLimit: data.memory_limit,
+    region: data.region,
+    runDuration: data.run_duration,
+    startedAt: unmarshalDate(data.started_at),
+    state: data.state,
+    terminatedAt: unmarshalDate(data.terminated_at),
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalCreateJobDefinitionSecretsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'CreateJobDefinitionSecretsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    secrets: unmarshalArrayOfObject(data.secrets, unmarshalSecret)
+  };
+};
+const unmarshalJobsLimits = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'JobsLimits' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    secretsPerJobDefinition: data.secrets_per_job_definition
+  };
+};
+const unmarshalListJobDefinitionSecretsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListJobDefinitionSecretsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    secrets: unmarshalArrayOfObject(data.secrets, unmarshalSecret),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListJobDefinitionsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListJobDefinitionsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    jobDefinitions: unmarshalArrayOfObject(
+      data.job_definitions,
+      unmarshalJobDefinition
+    ),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListJobRunsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListJobRunsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    jobRuns: unmarshalArrayOfObject(data.job_runs, unmarshalJobRun),
+    totalCount: data.total_count
+  };
+};
+const unmarshalResource = (data) => {
+  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
+  };
+};
+const unmarshalListJobsResourcesResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListJobsResourcesResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    resources: unmarshalArrayOfObject(data.resources, unmarshalResource)
+  };
+};
+const unmarshalStartJobDefinitionResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'StartJobDefinitionResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    jobRuns: unmarshalArrayOfObject(data.job_runs, unmarshalJobRun)
+  };
+};
+const marshalCreateJobDefinitionRequestCronScheduleConfig = (request, defaults) => ({
+  schedule: request.schedule,
+  timezone: request.timezone
+});
+const marshalCreateJobDefinitionRequest = (request, defaults) => ({
+  command: request.command,
+  cpu_limit: request.cpuLimit,
+  cron_schedule: request.cronSchedule !== void 0 ? marshalCreateJobDefinitionRequestCronScheduleConfig(
+    request.cronSchedule
+  ) : void 0,
+  description: request.description,
+  environment_variables: request.environmentVariables !== void 0 ? request.environmentVariables : void 0,
+  image_uri: request.imageUri,
+  job_timeout: request.jobTimeout,
+  local_storage_capacity: request.localStorageCapacity,
+  memory_limit: request.memoryLimit,
+  name: request.name || randomName("job"),
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalCreateJobDefinitionSecretsRequestSecretConfig = (request, defaults) => ({
+  secret_manager_id: request.secretManagerId,
+  secret_manager_version: request.secretManagerVersion,
+  ...resolveOneOf([
+    { param: "path", value: request.path },
+    { param: "env_var_name", value: request.envVarName }
+  ])
+});
+const marshalCreateJobDefinitionSecretsRequest = (request, defaults) => ({
+  secrets: request.secrets.map(
+    (elt) => marshalCreateJobDefinitionSecretsRequestSecretConfig(elt)
+  )
+});
+const marshalStartJobDefinitionRequest = (request, defaults) => ({
+  command: request.command,
+  environment_variables: request.environmentVariables,
+  replicas: request.replicas
+});
+const marshalUpdateJobDefinitionRequestCronScheduleConfig = (request, defaults) => ({
+  schedule: request.schedule,
+  timezone: request.timezone
+});
+const marshalUpdateJobDefinitionRequest = (request, defaults) => ({
+  command: request.command,
+  cpu_limit: request.cpuLimit,
+  cron_schedule: request.cronSchedule !== void 0 ? marshalUpdateJobDefinitionRequestCronScheduleConfig(
+    request.cronSchedule
+  ) : void 0,
+  description: request.description,
+  environment_variables: request.environmentVariables,
+  image_uri: request.imageUri,
+  job_timeout: request.jobTimeout,
+  local_storage_capacity: request.localStorageCapacity,
+  memory_limit: request.memoryLimit,
+  name: request.name
+});
+const marshalUpdateJobDefinitionSecretRequest = (request, defaults) => ({
+  secret_manager_version: request.secretManagerVersion,
+  ...resolveOneOf([
+    { param: "path", value: request.path },
+    { param: "env_var_name", value: request.envVarName }
+  ])
+});
+export {
+  marshalCreateJobDefinitionRequest,
+  marshalCreateJobDefinitionSecretsRequest,
+  marshalStartJobDefinitionRequest,
+  marshalUpdateJobDefinitionRequest,
+  marshalUpdateJobDefinitionSecretRequest,
+  unmarshalCreateJobDefinitionSecretsResponse,
+  unmarshalJobDefinition,
+  unmarshalJobRun,
+  unmarshalJobsLimits,
+  unmarshalListJobDefinitionSecretsResponse,
+  unmarshalListJobDefinitionsResponse,
+  unmarshalListJobRunsResponse,
+  unmarshalListJobsResourcesResponse,
+  unmarshalSecret,
+  unmarshalStartJobDefinitionResponse
+};

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

@@ -0,0 +1,423 @@
+import type { Region as ScwRegion } from '@scaleway/sdk-client';
+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 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 CreateJobDefinitionRequestCronScheduleConfig {
+    schedule: string;
+    timezone: string;
+}
+export interface CreateJobDefinitionSecretsRequestSecretConfig {
+    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;
+    /**
+     * 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;
+    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: ScwRegion;
+}
+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: ScwRegion;
+}
+export interface Resource {
+    cpuLimit: number;
+    memoryLimit: number;
+}
+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.
+     */
+    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;
+    /**
+     * 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?: ScwRegion;
+    /**
+     * UUID of the job definition.
+     */
+    jobDefinitionId: string;
+    /**
+     * List of secrets to inject into the job.
+     */
+    secrets: CreateJobDefinitionSecretsRequestSecretConfig[];
+};
+export interface CreateJobDefinitionSecretsResponse {
+    /**
+     * 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 DeleteJobDefinitionSecretRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the job definition.
+     */
+    jobDefinitionId: string;
+    /**
+     * 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 GetJobDefinitionSecretRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the job definition.
+     */
+    jobDefinitionId: string;
+    /**
+     * 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?: ScwRegion;
+    /**
+     * 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?: ScwRegion;
+};
+export interface JobsLimits {
+    secretsPerJobDefinition: number;
+}
+export type ListJobDefinitionSecretsRequest = {
+    /**
+     * 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 ListJobDefinitionSecretsResponse {
+    /**
+     * List of secret references within a job definition.
+     */
+    secrets: Secret[];
+    /**
+     * 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?: ScwRegion;
+    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?: ScwRegion;
+    page?: number;
+    pageSize?: number;
+    orderBy?: ListJobRunsRequestOrderBy;
+    jobDefinitionId?: string;
+    projectId?: string;
+    organizationId?: string;
+    state?: JobRunState;
+};
+export interface ListJobRunsResponse {
+    jobRuns: JobRun[];
+    totalCount: number;
+}
+export type ListJobsResourcesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+};
+export interface ListJobsResourcesResponse {
+    resources: Resource[];
+}
+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;
+    /**
+     * 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?: 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.
+     */
+    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;
+};
+export type UpdateJobDefinitionSecretRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the job definition.
+     */
+    jobDefinitionId: string;
+    /**
+     * 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;
+};