@scaleway/sdk-jobs 2.2.1 → 2.3.0

package/dist/v1alpha2/marshalling.gen.js

@@ -1,275 +1,197 @@
+import { isJSONObject, resolveOneOf, unmarshalArrayOfObject, unmarshalDate } from "@scaleway/sdk-client";
 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
-  };
+var 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
-  };
+var 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,
-    jobDefinitionId: data.job_definition_id,
-    secretId: data.secret_id,
-    secretManagerId: data.secret_manager_id,
-    secretManagerVersion: data.secret_manager_version
-  };
+	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,
+		jobDefinitionId: data.job_definition_id,
+		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
-  };
+var 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
+	};
+};
+var unmarshalRetryPolicy = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'RetryPolicy' failed as data isn't a dictionary.`);
+	return { maxRetries: data.max_retries };
 };
 const unmarshalJobDefinition = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'JobDefinition' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    args: data.args,
-    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,
-    startupCommand: data.startup_command,
-    updatedAt: unmarshalDate(data.updated_at)
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'JobDefinition' failed as data isn't a dictionary.`);
+	return {
+		args: data.args,
+		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,
+		retryPolicy: data.retry_policy ? unmarshalRetryPolicy(data.retry_policy) : void 0,
+		startupCommand: data.startup_command,
+		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 {
-    args: data.args,
-    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,
-    reason: data.reason ? data.reason : void 0,
-    region: data.region,
-    runDuration: data.run_duration,
-    startedAt: unmarshalDate(data.started_at),
-    startupCommand: data.startup_command,
-    state: data.state,
-    terminatedAt: unmarshalDate(data.terminated_at),
-    updatedAt: unmarshalDate(data.updated_at)
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'JobRun' failed as data isn't a dictionary.`);
+	return {
+		args: data.args,
+		attempts: data.attempts,
+		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,
+		reason: data.reason ? data.reason : void 0,
+		region: data.region,
+		runDuration: data.run_duration,
+		startedAt: unmarshalDate(data.started_at),
+		startupCommand: data.startup_command,
+		state: data.state,
+		terminatedAt: unmarshalDate(data.terminated_at),
+		updatedAt: unmarshalDate(data.updated_at)
+	};
 };
 const unmarshalCreateSecretsResponse = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'CreateSecretsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    secrets: unmarshalArrayOfObject(data.secrets, unmarshalSecret)
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'CreateSecretsResponse' failed as data isn't a dictionary.`);
+	return { secrets: unmarshalArrayOfObject(data.secrets, unmarshalSecret) };
 };
 const unmarshalJobLimits = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'JobLimits' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    secretsPerJobDefinition: data.secrets_per_job_definition
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'JobLimits' failed as data isn't a dictionary.`);
+	return { secretsPerJobDefinition: data.secrets_per_job_definition };
 };
 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
-  };
+	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 unmarshalResource = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Resource' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    computeLimitMvcpu: data.compute_limit_mvcpu,
-    memoryLimitBytes: data.memory_limit_bytes
-  };
+var unmarshalResource = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Resource' failed as data isn't a dictionary.`);
+	return {
+		computeLimitMvcpu: data.compute_limit_mvcpu,
+		memoryLimitBytes: data.memory_limit_bytes
+	};
 };
 const unmarshalListJobResourcesResponse = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListJobResourcesResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    resources: unmarshalArrayOfObject(data.resources, unmarshalResource)
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListJobResourcesResponse' failed as data isn't a dictionary.`);
+	return { resources: unmarshalArrayOfObject(data.resources, unmarshalResource) };
 };
 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
-  };
+	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 unmarshalListSecretsResponse = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListSecretsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    secrets: unmarshalArrayOfObject(data.secrets, unmarshalSecret),
-    totalCount: data.total_count
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListSecretsResponse' failed as data isn't a dictionary.`);
+	return {
+		secrets: unmarshalArrayOfObject(data.secrets, unmarshalSecret),
+		totalCount: data.total_count
+	};
 };
 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)
-  };
+	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
+var marshalCreateJobDefinitionRequestCronScheduleConfig = (request, defaults) => ({
+	schedule: request.schedule,
+	timezone: request.timezone
 });
+var marshalRetryPolicy = (request, defaults) => ({ max_retries: request.maxRetries });
 const marshalCreateJobDefinitionRequest = (request, defaults) => ({
-  args: request.args,
-  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,
-  startup_command: request.startupCommand
+	args: request.args,
+	command: request.command,
+	cpu_limit: request.cpuLimit,
+	cron_schedule: request.cronSchedule !== void 0 ? marshalCreateJobDefinitionRequestCronScheduleConfig(request.cronSchedule, defaults) : 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,
+	retry_policy: request.retryPolicy !== void 0 ? marshalRetryPolicy(request.retryPolicy, defaults) : void 0,
+	startup_command: request.startupCommand
 });
-const marshalCreateSecretsRequestSecretConfig = (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 }
-  ])
+var marshalCreateSecretsRequestSecretConfig = (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 marshalCreateSecretsRequest = (request, defaults) => ({
-  job_definition_id: request.jobDefinitionId,
-  secrets: request.secrets.map(
-    (elt) => marshalCreateSecretsRequestSecretConfig(elt)
-  )
+	job_definition_id: request.jobDefinitionId,
+	secrets: request.secrets.map((elt) => marshalCreateSecretsRequestSecretConfig(elt, defaults))
 });
 const marshalStartJobDefinitionRequest = (request, defaults) => ({
-  args: request.args,
-  command: request.command,
-  environment_variables: request.environmentVariables,
-  replicas: request.replicas,
-  startup_command: request.startupCommand
+	args: request.args,
+	command: request.command,
+	environment_variables: request.environmentVariables,
+	replicas: request.replicas,
+	startup_command: request.startupCommand
 });
-const marshalUpdateJobDefinitionRequestCronScheduleConfig = (request, defaults) => ({
-  schedule: request.schedule,
-  timezone: request.timezone
+var marshalUpdateJobDefinitionRequestCronScheduleConfig = (request, defaults) => ({
+	schedule: request.schedule,
+	timezone: request.timezone
 });
 const marshalUpdateJobDefinitionRequest = (request, defaults) => ({
-  args: request.args,
-  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,
-  startup_command: request.startupCommand
+	args: request.args,
+	command: request.command,
+	cpu_limit: request.cpuLimit,
+	cron_schedule: request.cronSchedule !== void 0 ? marshalUpdateJobDefinitionRequestCronScheduleConfig(request.cronSchedule, defaults) : 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,
+	retry_policy: request.retryPolicy !== void 0 ? marshalRetryPolicy(request.retryPolicy, defaults) : void 0,
+	startup_command: request.startupCommand
 });
 const marshalUpdateSecretRequest = (request, defaults) => ({
-  secret_manager_version: request.secretManagerVersion,
-  ...resolveOneOf([
-    { param: "path", value: request.path },
-    { param: "env_var_name", value: request.envVarName }
-  ])
+	secret_manager_version: request.secretManagerVersion,
+	...resolveOneOf([{
+		param: "path",
+		value: request.path
+	}, {
+		param: "env_var_name",
+		value: request.envVarName
+	}])
 });
-export {
-  marshalCreateJobDefinitionRequest,
-  marshalCreateSecretsRequest,
-  marshalStartJobDefinitionRequest,
-  marshalUpdateJobDefinitionRequest,
-  marshalUpdateSecretRequest,
-  unmarshalCreateSecretsResponse,
-  unmarshalJobDefinition,
-  unmarshalJobLimits,
-  unmarshalJobRun,
-  unmarshalListJobDefinitionsResponse,
-  unmarshalListJobResourcesResponse,
-  unmarshalListJobRunsResponse,
-  unmarshalListSecretsResponse,
-  unmarshalSecret,
-  unmarshalStartJobDefinitionResponse
-};
+export { marshalCreateJobDefinitionRequest, marshalCreateSecretsRequest, marshalStartJobDefinitionRequest, marshalUpdateJobDefinitionRequest, marshalUpdateSecretRequest, unmarshalCreateSecretsResponse, unmarshalJobDefinition, unmarshalJobLimits, unmarshalJobRun, unmarshalListJobDefinitionsResponse, unmarshalListJobResourcesResponse, unmarshalListJobRunsResponse, unmarshalListSecretsResponse, unmarshalSecret, unmarshalStartJobDefinitionResponse };

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

@@ -1,6 +1,6 @@
 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';
-export type JobRunState = 'unknown_state' | 'initialized' | 'validated' | 'queued' | 'running' | 'succeeded' | 'failed' | 'interrupting' | 'interrupted';
+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 {
@@ -19,6 +19,12 @@ export interface CronSchedule {
      */
     timezone: string;
 }
+export interface RetryPolicy {
+    /**
+     * Maximum number of retries upon a job failure.
+     */
+    maxRetries: number;
+}
 export interface CreateJobDefinitionRequestCronScheduleConfig {
     schedule: string;
     timezone: string;
@@ -87,6 +93,7 @@ export interface JobDefinition {
     cronSchedule?: CronSchedule;
     startupCommand: string[];
     args: string[];
+    retryPolicy?: RetryPolicy;
     /**
      * Region to target. If none is passed will use default region from the config.
      */
@@ -118,6 +125,7 @@ export interface JobRun {
     environmentVariables: Record<string, string>;
     startupCommand: string[];
     args: string[];
+    attempts?: number;
     /**
      * Region to target. If none is passed will use default region from the config.
      */
@@ -186,6 +194,10 @@ export type CreateJobDefinitionRequest = {
      * Configure a cron for the job.
      */
     cronSchedule?: CreateJobDefinitionRequestCronScheduleConfig;
+    /**
+     * Retry behaviour in case of job failure.
+     */
+    retryPolicy?: RetryPolicy;
 };
 export type CreateSecretsRequest = {
     /**
@@ -435,7 +447,14 @@ export type UpdateJobDefinitionRequest = {
      * 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 = {
     /**

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

@@ -61,6 +61,11 @@ export declare const ListJobRunsRequest: {
         lessThanOrEqual: number;
     };
 };
+export declare const RetryPolicy: {
+    maxRetries: {
+        lessThanOrEqual: number;
+    };
+};
 export declare const StartJobDefinitionRequest: {
     replicas: {
         greaterThan: number;