qovery-typescript-axios 1.1.288 → 1.1.289
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api.ts +432 -169
- package/dist/api.d.ts +420 -160
- package/dist/api.js +14 -8
- package/dist/esm/api.d.ts +420 -160
- package/dist/esm/api.js +6 -0
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -1238,6 +1238,166 @@ export interface Base {
|
|
|
1238
1238
|
*/
|
|
1239
1239
|
'updated_at'?: string;
|
|
1240
1240
|
}
|
|
1241
|
+
/**
|
|
1242
|
+
*
|
|
1243
|
+
* @export
|
|
1244
|
+
* @interface BaseJobResponse
|
|
1245
|
+
*/
|
|
1246
|
+
export interface BaseJobResponse {
|
|
1247
|
+
/**
|
|
1248
|
+
*
|
|
1249
|
+
* @type {string}
|
|
1250
|
+
* @memberof BaseJobResponse
|
|
1251
|
+
*/
|
|
1252
|
+
'id': string;
|
|
1253
|
+
/**
|
|
1254
|
+
*
|
|
1255
|
+
* @type {string}
|
|
1256
|
+
* @memberof BaseJobResponse
|
|
1257
|
+
*/
|
|
1258
|
+
'created_at': string;
|
|
1259
|
+
/**
|
|
1260
|
+
*
|
|
1261
|
+
* @type {string}
|
|
1262
|
+
* @memberof BaseJobResponse
|
|
1263
|
+
*/
|
|
1264
|
+
'updated_at'?: string;
|
|
1265
|
+
/**
|
|
1266
|
+
*
|
|
1267
|
+
* @type {ReferenceObject}
|
|
1268
|
+
* @memberof BaseJobResponse
|
|
1269
|
+
*/
|
|
1270
|
+
'environment': ReferenceObject;
|
|
1271
|
+
/**
|
|
1272
|
+
* Maximum cpu that can be allocated to the job based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu
|
|
1273
|
+
* @type {number}
|
|
1274
|
+
* @memberof BaseJobResponse
|
|
1275
|
+
*/
|
|
1276
|
+
'maximum_cpu': number;
|
|
1277
|
+
/**
|
|
1278
|
+
* Maximum memory that can be allocated to the job based on organization cluster configuration. unit is MB. 1024 MB = 1GB
|
|
1279
|
+
* @type {number}
|
|
1280
|
+
* @memberof BaseJobResponse
|
|
1281
|
+
*/
|
|
1282
|
+
'maximum_memory': number;
|
|
1283
|
+
/**
|
|
1284
|
+
* name is case insensitive
|
|
1285
|
+
* @type {string}
|
|
1286
|
+
* @memberof BaseJobResponse
|
|
1287
|
+
*/
|
|
1288
|
+
'name': string;
|
|
1289
|
+
/**
|
|
1290
|
+
*
|
|
1291
|
+
* @type {string}
|
|
1292
|
+
* @memberof BaseJobResponse
|
|
1293
|
+
*/
|
|
1294
|
+
'description'?: string;
|
|
1295
|
+
/**
|
|
1296
|
+
* unit is millicores (m). 1000m = 1 cpu
|
|
1297
|
+
* @type {number}
|
|
1298
|
+
* @memberof BaseJobResponse
|
|
1299
|
+
*/
|
|
1300
|
+
'cpu': number;
|
|
1301
|
+
/**
|
|
1302
|
+
* unit is MB. 1024 MB = 1GB
|
|
1303
|
+
* @type {number}
|
|
1304
|
+
* @memberof BaseJobResponse
|
|
1305
|
+
*/
|
|
1306
|
+
'memory': number;
|
|
1307
|
+
/**
|
|
1308
|
+
* Maximum number of restart allowed before the job is considered as failed 0 means that no restart/crash of the job is allowed
|
|
1309
|
+
* @type {number}
|
|
1310
|
+
* @memberof BaseJobResponse
|
|
1311
|
+
*/
|
|
1312
|
+
'max_nb_restart'?: number;
|
|
1313
|
+
/**
|
|
1314
|
+
* Maximum number of seconds allowed for the job to run before killing it and mark it as failed
|
|
1315
|
+
* @type {number}
|
|
1316
|
+
* @memberof BaseJobResponse
|
|
1317
|
+
*/
|
|
1318
|
+
'max_duration_seconds'?: number;
|
|
1319
|
+
/**
|
|
1320
|
+
* Indicates if the \'environment preview option\' is enabled for this container. If enabled, a preview environment will be automatically cloned when `/preview` endpoint is called. If not specified, it takes the value of the `auto_preview` property from the associated environment.
|
|
1321
|
+
* @type {boolean}
|
|
1322
|
+
* @memberof BaseJobResponse
|
|
1323
|
+
*/
|
|
1324
|
+
'auto_preview': boolean;
|
|
1325
|
+
/**
|
|
1326
|
+
* Port where to run readiness and liveliness probes checks. The port will not be exposed externally
|
|
1327
|
+
* @type {number}
|
|
1328
|
+
* @memberof BaseJobResponse
|
|
1329
|
+
*/
|
|
1330
|
+
'port'?: number | null;
|
|
1331
|
+
/**
|
|
1332
|
+
*
|
|
1333
|
+
* @type {BaseJobResponseAllOfSource}
|
|
1334
|
+
* @memberof BaseJobResponse
|
|
1335
|
+
*/
|
|
1336
|
+
'source': BaseJobResponseAllOfSource;
|
|
1337
|
+
/**
|
|
1338
|
+
*
|
|
1339
|
+
* @type {Healthcheck}
|
|
1340
|
+
* @memberof BaseJobResponse
|
|
1341
|
+
*/
|
|
1342
|
+
'healthchecks': Healthcheck;
|
|
1343
|
+
/**
|
|
1344
|
+
* Specify if the job will be automatically updated after receiving a new image tag or a new commit according to the source type. The new image tag shall be communicated via the \"Auto Deploy job\" endpoint https://api-doc.qovery.com/#tag/Jobs/operation/autoDeployJobEnvironments
|
|
1345
|
+
* @type {boolean}
|
|
1346
|
+
* @memberof BaseJobResponse
|
|
1347
|
+
*/
|
|
1348
|
+
'auto_deploy'?: boolean;
|
|
1349
|
+
}
|
|
1350
|
+
/**
|
|
1351
|
+
* @type BaseJobResponseAllOfSource
|
|
1352
|
+
* @export
|
|
1353
|
+
*/
|
|
1354
|
+
export type BaseJobResponseAllOfSource = BaseJobResponseAllOfSourceOneOf | BaseJobResponseAllOfSourceOneOf1;
|
|
1355
|
+
|
|
1356
|
+
/**
|
|
1357
|
+
*
|
|
1358
|
+
* @export
|
|
1359
|
+
* @interface BaseJobResponseAllOfSourceOneOf
|
|
1360
|
+
*/
|
|
1361
|
+
export interface BaseJobResponseAllOfSourceOneOf {
|
|
1362
|
+
/**
|
|
1363
|
+
*
|
|
1364
|
+
* @type {ContainerSource}
|
|
1365
|
+
* @memberof BaseJobResponseAllOfSourceOneOf
|
|
1366
|
+
*/
|
|
1367
|
+
'image'?: ContainerSource;
|
|
1368
|
+
}
|
|
1369
|
+
/**
|
|
1370
|
+
*
|
|
1371
|
+
* @export
|
|
1372
|
+
* @interface BaseJobResponseAllOfSourceOneOf1
|
|
1373
|
+
*/
|
|
1374
|
+
export interface BaseJobResponseAllOfSourceOneOf1 {
|
|
1375
|
+
/**
|
|
1376
|
+
*
|
|
1377
|
+
* @type {BaseJobResponseAllOfSourceOneOf1Docker}
|
|
1378
|
+
* @memberof BaseJobResponseAllOfSourceOneOf1
|
|
1379
|
+
*/
|
|
1380
|
+
'docker'?: BaseJobResponseAllOfSourceOneOf1Docker;
|
|
1381
|
+
}
|
|
1382
|
+
/**
|
|
1383
|
+
*
|
|
1384
|
+
* @export
|
|
1385
|
+
* @interface BaseJobResponseAllOfSourceOneOf1Docker
|
|
1386
|
+
*/
|
|
1387
|
+
export interface BaseJobResponseAllOfSourceOneOf1Docker {
|
|
1388
|
+
/**
|
|
1389
|
+
* The path of the associated Dockerfile. Only if you are using build_mode = DOCKER
|
|
1390
|
+
* @type {string}
|
|
1391
|
+
* @memberof BaseJobResponseAllOfSourceOneOf1Docker
|
|
1392
|
+
*/
|
|
1393
|
+
'dockerfile_path'?: string | null;
|
|
1394
|
+
/**
|
|
1395
|
+
*
|
|
1396
|
+
* @type {ApplicationGitRepository}
|
|
1397
|
+
* @memberof BaseJobResponseAllOfSourceOneOf1Docker
|
|
1398
|
+
*/
|
|
1399
|
+
'git_repository'?: ApplicationGitRepository;
|
|
1400
|
+
}
|
|
1241
1401
|
/**
|
|
1242
1402
|
*
|
|
1243
1403
|
* @export
|
|
@@ -4082,6 +4242,172 @@ export interface CreditCardResponseList {
|
|
|
4082
4242
|
*/
|
|
4083
4243
|
'results'?: Array<CreditCard>;
|
|
4084
4244
|
}
|
|
4245
|
+
/**
|
|
4246
|
+
*
|
|
4247
|
+
* @export
|
|
4248
|
+
* @interface CronJobResponse
|
|
4249
|
+
*/
|
|
4250
|
+
export interface CronJobResponse {
|
|
4251
|
+
/**
|
|
4252
|
+
*
|
|
4253
|
+
* @type {string}
|
|
4254
|
+
* @memberof CronJobResponse
|
|
4255
|
+
*/
|
|
4256
|
+
'id': string;
|
|
4257
|
+
/**
|
|
4258
|
+
*
|
|
4259
|
+
* @type {string}
|
|
4260
|
+
* @memberof CronJobResponse
|
|
4261
|
+
*/
|
|
4262
|
+
'created_at': string;
|
|
4263
|
+
/**
|
|
4264
|
+
*
|
|
4265
|
+
* @type {string}
|
|
4266
|
+
* @memberof CronJobResponse
|
|
4267
|
+
*/
|
|
4268
|
+
'updated_at'?: string;
|
|
4269
|
+
/**
|
|
4270
|
+
*
|
|
4271
|
+
* @type {ReferenceObject}
|
|
4272
|
+
* @memberof CronJobResponse
|
|
4273
|
+
*/
|
|
4274
|
+
'environment': ReferenceObject;
|
|
4275
|
+
/**
|
|
4276
|
+
* Maximum cpu that can be allocated to the job based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu
|
|
4277
|
+
* @type {number}
|
|
4278
|
+
* @memberof CronJobResponse
|
|
4279
|
+
*/
|
|
4280
|
+
'maximum_cpu': number;
|
|
4281
|
+
/**
|
|
4282
|
+
* Maximum memory that can be allocated to the job based on organization cluster configuration. unit is MB. 1024 MB = 1GB
|
|
4283
|
+
* @type {number}
|
|
4284
|
+
* @memberof CronJobResponse
|
|
4285
|
+
*/
|
|
4286
|
+
'maximum_memory': number;
|
|
4287
|
+
/**
|
|
4288
|
+
* name is case insensitive
|
|
4289
|
+
* @type {string}
|
|
4290
|
+
* @memberof CronJobResponse
|
|
4291
|
+
*/
|
|
4292
|
+
'name': string;
|
|
4293
|
+
/**
|
|
4294
|
+
*
|
|
4295
|
+
* @type {string}
|
|
4296
|
+
* @memberof CronJobResponse
|
|
4297
|
+
*/
|
|
4298
|
+
'description'?: string;
|
|
4299
|
+
/**
|
|
4300
|
+
* unit is millicores (m). 1000m = 1 cpu
|
|
4301
|
+
* @type {number}
|
|
4302
|
+
* @memberof CronJobResponse
|
|
4303
|
+
*/
|
|
4304
|
+
'cpu': number;
|
|
4305
|
+
/**
|
|
4306
|
+
* unit is MB. 1024 MB = 1GB
|
|
4307
|
+
* @type {number}
|
|
4308
|
+
* @memberof CronJobResponse
|
|
4309
|
+
*/
|
|
4310
|
+
'memory': number;
|
|
4311
|
+
/**
|
|
4312
|
+
* Maximum number of restart allowed before the job is considered as failed 0 means that no restart/crash of the job is allowed
|
|
4313
|
+
* @type {number}
|
|
4314
|
+
* @memberof CronJobResponse
|
|
4315
|
+
*/
|
|
4316
|
+
'max_nb_restart'?: number;
|
|
4317
|
+
/**
|
|
4318
|
+
* Maximum number of seconds allowed for the job to run before killing it and mark it as failed
|
|
4319
|
+
* @type {number}
|
|
4320
|
+
* @memberof CronJobResponse
|
|
4321
|
+
*/
|
|
4322
|
+
'max_duration_seconds'?: number;
|
|
4323
|
+
/**
|
|
4324
|
+
* Indicates if the \'environment preview option\' is enabled for this container. If enabled, a preview environment will be automatically cloned when `/preview` endpoint is called. If not specified, it takes the value of the `auto_preview` property from the associated environment.
|
|
4325
|
+
* @type {boolean}
|
|
4326
|
+
* @memberof CronJobResponse
|
|
4327
|
+
*/
|
|
4328
|
+
'auto_preview': boolean;
|
|
4329
|
+
/**
|
|
4330
|
+
* Port where to run readiness and liveliness probes checks. The port will not be exposed externally
|
|
4331
|
+
* @type {number}
|
|
4332
|
+
* @memberof CronJobResponse
|
|
4333
|
+
*/
|
|
4334
|
+
'port'?: number | null;
|
|
4335
|
+
/**
|
|
4336
|
+
*
|
|
4337
|
+
* @type {BaseJobResponseAllOfSource}
|
|
4338
|
+
* @memberof CronJobResponse
|
|
4339
|
+
*/
|
|
4340
|
+
'source': BaseJobResponseAllOfSource;
|
|
4341
|
+
/**
|
|
4342
|
+
*
|
|
4343
|
+
* @type {Healthcheck}
|
|
4344
|
+
* @memberof CronJobResponse
|
|
4345
|
+
*/
|
|
4346
|
+
'healthchecks': Healthcheck;
|
|
4347
|
+
/**
|
|
4348
|
+
* Specify if the job will be automatically updated after receiving a new image tag or a new commit according to the source type. The new image tag shall be communicated via the \"Auto Deploy job\" endpoint https://api-doc.qovery.com/#tag/Jobs/operation/autoDeployJobEnvironments
|
|
4349
|
+
* @type {boolean}
|
|
4350
|
+
* @memberof CronJobResponse
|
|
4351
|
+
*/
|
|
4352
|
+
'auto_deploy'?: boolean;
|
|
4353
|
+
/**
|
|
4354
|
+
*
|
|
4355
|
+
* @type {string}
|
|
4356
|
+
* @memberof CronJobResponse
|
|
4357
|
+
*/
|
|
4358
|
+
'job_type': CronJobResponseJobTypeEnum;
|
|
4359
|
+
/**
|
|
4360
|
+
*
|
|
4361
|
+
* @type {CronJobResponseAllOfSchedule}
|
|
4362
|
+
* @memberof CronJobResponse
|
|
4363
|
+
*/
|
|
4364
|
+
'schedule': CronJobResponseAllOfSchedule;
|
|
4365
|
+
}
|
|
4366
|
+
|
|
4367
|
+
export const CronJobResponseJobTypeEnum = {
|
|
4368
|
+
CRON: 'CRON'
|
|
4369
|
+
} as const;
|
|
4370
|
+
|
|
4371
|
+
export type CronJobResponseJobTypeEnum = typeof CronJobResponseJobTypeEnum[keyof typeof CronJobResponseJobTypeEnum];
|
|
4372
|
+
|
|
4373
|
+
/**
|
|
4374
|
+
*
|
|
4375
|
+
* @export
|
|
4376
|
+
* @interface CronJobResponseAllOfSchedule
|
|
4377
|
+
*/
|
|
4378
|
+
export interface CronJobResponseAllOfSchedule {
|
|
4379
|
+
/**
|
|
4380
|
+
*
|
|
4381
|
+
* @type {CronJobResponseAllOfScheduleCronjob}
|
|
4382
|
+
* @memberof CronJobResponseAllOfSchedule
|
|
4383
|
+
*/
|
|
4384
|
+
'cronjob'?: CronJobResponseAllOfScheduleCronjob;
|
|
4385
|
+
}
|
|
4386
|
+
/**
|
|
4387
|
+
*
|
|
4388
|
+
* @export
|
|
4389
|
+
* @interface CronJobResponseAllOfScheduleCronjob
|
|
4390
|
+
*/
|
|
4391
|
+
export interface CronJobResponseAllOfScheduleCronjob {
|
|
4392
|
+
/**
|
|
4393
|
+
*
|
|
4394
|
+
* @type {Array<string>}
|
|
4395
|
+
* @memberof CronJobResponseAllOfScheduleCronjob
|
|
4396
|
+
*/
|
|
4397
|
+
'arguments'?: Array<string>;
|
|
4398
|
+
/**
|
|
4399
|
+
* optional entrypoint when launching container
|
|
4400
|
+
* @type {string}
|
|
4401
|
+
* @memberof CronJobResponseAllOfScheduleCronjob
|
|
4402
|
+
*/
|
|
4403
|
+
'entrypoint'?: string;
|
|
4404
|
+
/**
|
|
4405
|
+
* Can only be set if the event is CRON. Represent the cron format for the job schedule without seconds. For example: `* * * * *` represent the cron to launch the job every minute. See https://crontab.guru/ to WISIWIG interface. Timezone is UT
|
|
4406
|
+
* @type {string}
|
|
4407
|
+
* @memberof CronJobResponseAllOfScheduleCronjob
|
|
4408
|
+
*/
|
|
4409
|
+
'scheduled_at': string;
|
|
4410
|
+
}
|
|
4085
4411
|
/**
|
|
4086
4412
|
*
|
|
4087
4413
|
* @export
|
|
@@ -9052,284 +9378,221 @@ export interface JobRequestAllOfSourceImage {
|
|
|
9052
9378
|
*/
|
|
9053
9379
|
'registry_id'?: string;
|
|
9054
9380
|
}
|
|
9381
|
+
/**
|
|
9382
|
+
* @type JobResponse
|
|
9383
|
+
* @export
|
|
9384
|
+
*/
|
|
9385
|
+
export type JobResponse = { job_type: 'CRON' } & CronJobResponse | { job_type: 'LIFECYCLE' } & LifecycleJobResponse;
|
|
9386
|
+
|
|
9387
|
+
/**
|
|
9388
|
+
*
|
|
9389
|
+
* @export
|
|
9390
|
+
* @interface JobResponseList
|
|
9391
|
+
*/
|
|
9392
|
+
export interface JobResponseList {
|
|
9393
|
+
/**
|
|
9394
|
+
*
|
|
9395
|
+
* @type {Array<JobResponse>}
|
|
9396
|
+
* @memberof JobResponseList
|
|
9397
|
+
*/
|
|
9398
|
+
'results'?: Array<JobResponse>;
|
|
9399
|
+
}
|
|
9400
|
+
/**
|
|
9401
|
+
* On which event the job is going to run. ON_START means when a deployment is requested for the environment ON_STOP means when a stop of the environment is requested ON_DELETE means when an environment delete is requested CRON means at a scheduled interval
|
|
9402
|
+
* @export
|
|
9403
|
+
* @enum {string}
|
|
9404
|
+
*/
|
|
9405
|
+
|
|
9406
|
+
export const JobScheduleEvent = {
|
|
9407
|
+
ON_START: 'ON_START',
|
|
9408
|
+
ON_STOP: 'ON_STOP',
|
|
9409
|
+
ON_DELETE: 'ON_DELETE',
|
|
9410
|
+
CRON: 'CRON'
|
|
9411
|
+
} as const;
|
|
9412
|
+
|
|
9413
|
+
export type JobScheduleEvent = typeof JobScheduleEvent[keyof typeof JobScheduleEvent];
|
|
9414
|
+
|
|
9415
|
+
|
|
9416
|
+
/**
|
|
9417
|
+
*
|
|
9418
|
+
* @export
|
|
9419
|
+
* @interface Key
|
|
9420
|
+
*/
|
|
9421
|
+
export interface Key {
|
|
9422
|
+
/**
|
|
9423
|
+
*
|
|
9424
|
+
* @type {string}
|
|
9425
|
+
* @memberof Key
|
|
9426
|
+
*/
|
|
9427
|
+
'key': string;
|
|
9428
|
+
}
|
|
9055
9429
|
/**
|
|
9056
9430
|
*
|
|
9057
9431
|
* @export
|
|
9058
|
-
* @
|
|
9432
|
+
* @enum {string}
|
|
9059
9433
|
*/
|
|
9060
|
-
|
|
9434
|
+
|
|
9435
|
+
export const KubernetesEnum = {
|
|
9436
|
+
K3_S: 'K3S',
|
|
9437
|
+
MANAGED: 'MANAGED'
|
|
9438
|
+
} as const;
|
|
9439
|
+
|
|
9440
|
+
export type KubernetesEnum = typeof KubernetesEnum[keyof typeof KubernetesEnum];
|
|
9441
|
+
|
|
9442
|
+
|
|
9443
|
+
/**
|
|
9444
|
+
*
|
|
9445
|
+
* @export
|
|
9446
|
+
* @interface LifecycleJobResponse
|
|
9447
|
+
*/
|
|
9448
|
+
export interface LifecycleJobResponse {
|
|
9061
9449
|
/**
|
|
9062
9450
|
*
|
|
9063
9451
|
* @type {string}
|
|
9064
|
-
* @memberof
|
|
9452
|
+
* @memberof LifecycleJobResponse
|
|
9065
9453
|
*/
|
|
9066
9454
|
'id': string;
|
|
9067
9455
|
/**
|
|
9068
9456
|
*
|
|
9069
9457
|
* @type {string}
|
|
9070
|
-
* @memberof
|
|
9458
|
+
* @memberof LifecycleJobResponse
|
|
9071
9459
|
*/
|
|
9072
9460
|
'created_at': string;
|
|
9073
9461
|
/**
|
|
9074
9462
|
*
|
|
9075
9463
|
* @type {string}
|
|
9076
|
-
* @memberof
|
|
9464
|
+
* @memberof LifecycleJobResponse
|
|
9077
9465
|
*/
|
|
9078
9466
|
'updated_at'?: string;
|
|
9079
9467
|
/**
|
|
9080
9468
|
*
|
|
9081
9469
|
* @type {ReferenceObject}
|
|
9082
|
-
* @memberof
|
|
9470
|
+
* @memberof LifecycleJobResponse
|
|
9083
9471
|
*/
|
|
9084
9472
|
'environment': ReferenceObject;
|
|
9085
9473
|
/**
|
|
9086
9474
|
* Maximum cpu that can be allocated to the job based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu
|
|
9087
9475
|
* @type {number}
|
|
9088
|
-
* @memberof
|
|
9476
|
+
* @memberof LifecycleJobResponse
|
|
9089
9477
|
*/
|
|
9090
9478
|
'maximum_cpu': number;
|
|
9091
9479
|
/**
|
|
9092
9480
|
* Maximum memory that can be allocated to the job based on organization cluster configuration. unit is MB. 1024 MB = 1GB
|
|
9093
9481
|
* @type {number}
|
|
9094
|
-
* @memberof
|
|
9482
|
+
* @memberof LifecycleJobResponse
|
|
9095
9483
|
*/
|
|
9096
9484
|
'maximum_memory': number;
|
|
9097
9485
|
/**
|
|
9098
9486
|
* name is case insensitive
|
|
9099
9487
|
* @type {string}
|
|
9100
|
-
* @memberof
|
|
9488
|
+
* @memberof LifecycleJobResponse
|
|
9101
9489
|
*/
|
|
9102
9490
|
'name': string;
|
|
9103
9491
|
/**
|
|
9104
9492
|
*
|
|
9105
9493
|
* @type {string}
|
|
9106
|
-
* @memberof
|
|
9494
|
+
* @memberof LifecycleJobResponse
|
|
9107
9495
|
*/
|
|
9108
9496
|
'description'?: string;
|
|
9109
9497
|
/**
|
|
9110
9498
|
* unit is millicores (m). 1000m = 1 cpu
|
|
9111
9499
|
* @type {number}
|
|
9112
|
-
* @memberof
|
|
9500
|
+
* @memberof LifecycleJobResponse
|
|
9113
9501
|
*/
|
|
9114
9502
|
'cpu': number;
|
|
9115
9503
|
/**
|
|
9116
9504
|
* unit is MB. 1024 MB = 1GB
|
|
9117
9505
|
* @type {number}
|
|
9118
|
-
* @memberof
|
|
9506
|
+
* @memberof LifecycleJobResponse
|
|
9119
9507
|
*/
|
|
9120
9508
|
'memory': number;
|
|
9121
9509
|
/**
|
|
9122
9510
|
* Maximum number of restart allowed before the job is considered as failed 0 means that no restart/crash of the job is allowed
|
|
9123
9511
|
* @type {number}
|
|
9124
|
-
* @memberof
|
|
9512
|
+
* @memberof LifecycleJobResponse
|
|
9125
9513
|
*/
|
|
9126
9514
|
'max_nb_restart'?: number;
|
|
9127
9515
|
/**
|
|
9128
9516
|
* Maximum number of seconds allowed for the job to run before killing it and mark it as failed
|
|
9129
9517
|
* @type {number}
|
|
9130
|
-
* @memberof
|
|
9518
|
+
* @memberof LifecycleJobResponse
|
|
9131
9519
|
*/
|
|
9132
9520
|
'max_duration_seconds'?: number;
|
|
9133
9521
|
/**
|
|
9134
9522
|
* Indicates if the \'environment preview option\' is enabled for this container. If enabled, a preview environment will be automatically cloned when `/preview` endpoint is called. If not specified, it takes the value of the `auto_preview` property from the associated environment.
|
|
9135
9523
|
* @type {boolean}
|
|
9136
|
-
* @memberof
|
|
9524
|
+
* @memberof LifecycleJobResponse
|
|
9137
9525
|
*/
|
|
9138
9526
|
'auto_preview': boolean;
|
|
9139
9527
|
/**
|
|
9140
9528
|
* Port where to run readiness and liveliness probes checks. The port will not be exposed externally
|
|
9141
9529
|
* @type {number}
|
|
9142
|
-
* @memberof
|
|
9530
|
+
* @memberof LifecycleJobResponse
|
|
9143
9531
|
*/
|
|
9144
9532
|
'port'?: number | null;
|
|
9145
9533
|
/**
|
|
9146
9534
|
*
|
|
9147
|
-
* @type {
|
|
9148
|
-
* @memberof
|
|
9535
|
+
* @type {BaseJobResponseAllOfSource}
|
|
9536
|
+
* @memberof LifecycleJobResponse
|
|
9149
9537
|
*/
|
|
9150
|
-
'source':
|
|
9538
|
+
'source': BaseJobResponseAllOfSource;
|
|
9151
9539
|
/**
|
|
9152
9540
|
*
|
|
9153
9541
|
* @type {Healthcheck}
|
|
9154
|
-
* @memberof
|
|
9542
|
+
* @memberof LifecycleJobResponse
|
|
9155
9543
|
*/
|
|
9156
9544
|
'healthchecks': Healthcheck;
|
|
9157
|
-
/**
|
|
9158
|
-
*
|
|
9159
|
-
* @type {JobResponseAllOfSchedule}
|
|
9160
|
-
* @memberof JobResponse
|
|
9161
|
-
*/
|
|
9162
|
-
'schedule'?: JobResponseAllOfSchedule;
|
|
9163
9545
|
/**
|
|
9164
9546
|
* Specify if the job will be automatically updated after receiving a new image tag or a new commit according to the source type. The new image tag shall be communicated via the \"Auto Deploy job\" endpoint https://api-doc.qovery.com/#tag/Jobs/operation/autoDeployJobEnvironments
|
|
9165
9547
|
* @type {boolean}
|
|
9166
|
-
* @memberof
|
|
9548
|
+
* @memberof LifecycleJobResponse
|
|
9167
9549
|
*/
|
|
9168
9550
|
'auto_deploy'?: boolean;
|
|
9169
|
-
}
|
|
9170
|
-
/**
|
|
9171
|
-
* If you want to define a Cron job, only the `cronjob` property must be filled A Lifecycle job should contain at least one property `on_XXX` among the 3 properties: `on_start`, `on_stop`, `on_delete`
|
|
9172
|
-
* @export
|
|
9173
|
-
* @interface JobResponseAllOfSchedule
|
|
9174
|
-
*/
|
|
9175
|
-
export interface JobResponseAllOfSchedule {
|
|
9176
|
-
/**
|
|
9177
|
-
*
|
|
9178
|
-
* @type {JobRequestAllOfScheduleOnStart}
|
|
9179
|
-
* @memberof JobResponseAllOfSchedule
|
|
9180
|
-
*/
|
|
9181
|
-
'on_start'?: JobRequestAllOfScheduleOnStart;
|
|
9182
|
-
/**
|
|
9183
|
-
*
|
|
9184
|
-
* @type {JobRequestAllOfScheduleOnStart}
|
|
9185
|
-
* @memberof JobResponseAllOfSchedule
|
|
9186
|
-
*/
|
|
9187
|
-
'on_stop'?: JobRequestAllOfScheduleOnStart;
|
|
9188
9551
|
/**
|
|
9189
9552
|
*
|
|
9190
|
-
* @type {JobRequestAllOfScheduleOnStart}
|
|
9191
|
-
* @memberof JobResponseAllOfSchedule
|
|
9192
|
-
*/
|
|
9193
|
-
'on_delete'?: JobRequestAllOfScheduleOnStart;
|
|
9194
|
-
/**
|
|
9195
|
-
*
|
|
9196
|
-
* @type {JobResponseAllOfScheduleCronjob}
|
|
9197
|
-
* @memberof JobResponseAllOfSchedule
|
|
9198
|
-
*/
|
|
9199
|
-
'cronjob'?: JobResponseAllOfScheduleCronjob;
|
|
9200
|
-
}
|
|
9201
|
-
/**
|
|
9202
|
-
*
|
|
9203
|
-
* @export
|
|
9204
|
-
* @interface JobResponseAllOfScheduleCronjob
|
|
9205
|
-
*/
|
|
9206
|
-
export interface JobResponseAllOfScheduleCronjob {
|
|
9207
|
-
/**
|
|
9208
|
-
*
|
|
9209
|
-
* @type {Array<string>}
|
|
9210
|
-
* @memberof JobResponseAllOfScheduleCronjob
|
|
9211
|
-
*/
|
|
9212
|
-
'arguments'?: Array<string>;
|
|
9213
|
-
/**
|
|
9214
|
-
* optional entrypoint when launching container
|
|
9215
9553
|
* @type {string}
|
|
9216
|
-
* @memberof
|
|
9554
|
+
* @memberof LifecycleJobResponse
|
|
9217
9555
|
*/
|
|
9218
|
-
'
|
|
9219
|
-
/**
|
|
9220
|
-
* Can only be set if the event is CRON. Represent the cron format for the job schedule without seconds. For example: `* * * * *` represent the cron to launch the job every minute. See https://crontab.guru/ to WISIWIG interface. Timezone is UT
|
|
9221
|
-
* @type {string}
|
|
9222
|
-
* @memberof JobResponseAllOfScheduleCronjob
|
|
9223
|
-
*/
|
|
9224
|
-
'scheduled_at': string;
|
|
9225
|
-
}
|
|
9226
|
-
/**
|
|
9227
|
-
* @type JobResponseAllOfSource
|
|
9228
|
-
* @export
|
|
9229
|
-
*/
|
|
9230
|
-
export type JobResponseAllOfSource = JobResponseAllOfSourceOneOf | JobResponseAllOfSourceOneOf1;
|
|
9231
|
-
|
|
9232
|
-
/**
|
|
9233
|
-
*
|
|
9234
|
-
* @export
|
|
9235
|
-
* @interface JobResponseAllOfSourceOneOf
|
|
9236
|
-
*/
|
|
9237
|
-
export interface JobResponseAllOfSourceOneOf {
|
|
9556
|
+
'job_type': LifecycleJobResponseJobTypeEnum;
|
|
9238
9557
|
/**
|
|
9239
9558
|
*
|
|
9240
|
-
* @type {
|
|
9241
|
-
* @memberof
|
|
9559
|
+
* @type {LifecycleJobResponseAllOfSchedule}
|
|
9560
|
+
* @memberof LifecycleJobResponse
|
|
9242
9561
|
*/
|
|
9243
|
-
'
|
|
9244
|
-
}
|
|
9245
|
-
/**
|
|
9246
|
-
*
|
|
9247
|
-
* @export
|
|
9248
|
-
* @interface JobResponseAllOfSourceOneOf1
|
|
9249
|
-
*/
|
|
9250
|
-
export interface JobResponseAllOfSourceOneOf1 {
|
|
9251
|
-
/**
|
|
9252
|
-
*
|
|
9253
|
-
* @type {JobResponseAllOfSourceOneOf1Docker}
|
|
9254
|
-
* @memberof JobResponseAllOfSourceOneOf1
|
|
9255
|
-
*/
|
|
9256
|
-
'docker'?: JobResponseAllOfSourceOneOf1Docker;
|
|
9562
|
+
'schedule': LifecycleJobResponseAllOfSchedule;
|
|
9257
9563
|
}
|
|
9564
|
+
|
|
9565
|
+
export const LifecycleJobResponseJobTypeEnum = {
|
|
9566
|
+
LIFECYCLE: 'LIFECYCLE'
|
|
9567
|
+
} as const;
|
|
9568
|
+
|
|
9569
|
+
export type LifecycleJobResponseJobTypeEnum = typeof LifecycleJobResponseJobTypeEnum[keyof typeof LifecycleJobResponseJobTypeEnum];
|
|
9570
|
+
|
|
9258
9571
|
/**
|
|
9259
9572
|
*
|
|
9260
9573
|
* @export
|
|
9261
|
-
* @interface
|
|
9574
|
+
* @interface LifecycleJobResponseAllOfSchedule
|
|
9262
9575
|
*/
|
|
9263
|
-
export interface
|
|
9264
|
-
/**
|
|
9265
|
-
* The path of the associated Dockerfile. Only if you are using build_mode = DOCKER
|
|
9266
|
-
* @type {string}
|
|
9267
|
-
* @memberof JobResponseAllOfSourceOneOf1Docker
|
|
9268
|
-
*/
|
|
9269
|
-
'dockerfile_path'?: string | null;
|
|
9576
|
+
export interface LifecycleJobResponseAllOfSchedule {
|
|
9270
9577
|
/**
|
|
9271
9578
|
*
|
|
9272
|
-
* @type {
|
|
9273
|
-
* @memberof
|
|
9579
|
+
* @type {JobRequestAllOfScheduleOnStart}
|
|
9580
|
+
* @memberof LifecycleJobResponseAllOfSchedule
|
|
9274
9581
|
*/
|
|
9275
|
-
'
|
|
9276
|
-
}
|
|
9277
|
-
/**
|
|
9278
|
-
*
|
|
9279
|
-
* @export
|
|
9280
|
-
* @interface JobResponseList
|
|
9281
|
-
*/
|
|
9282
|
-
export interface JobResponseList {
|
|
9582
|
+
'on_start'?: JobRequestAllOfScheduleOnStart;
|
|
9283
9583
|
/**
|
|
9284
9584
|
*
|
|
9285
|
-
* @type {
|
|
9286
|
-
* @memberof
|
|
9585
|
+
* @type {JobRequestAllOfScheduleOnStart}
|
|
9586
|
+
* @memberof LifecycleJobResponseAllOfSchedule
|
|
9287
9587
|
*/
|
|
9288
|
-
'
|
|
9289
|
-
}
|
|
9290
|
-
/**
|
|
9291
|
-
* On which event the job is going to run. ON_START means when a deployment is requested for the environment ON_STOP means when a stop of the environment is requested ON_DELETE means when an environment delete is requested CRON means at a scheduled interval
|
|
9292
|
-
* @export
|
|
9293
|
-
* @enum {string}
|
|
9294
|
-
*/
|
|
9295
|
-
|
|
9296
|
-
export const JobScheduleEvent = {
|
|
9297
|
-
ON_START: 'ON_START',
|
|
9298
|
-
ON_STOP: 'ON_STOP',
|
|
9299
|
-
ON_DELETE: 'ON_DELETE',
|
|
9300
|
-
CRON: 'CRON'
|
|
9301
|
-
} as const;
|
|
9302
|
-
|
|
9303
|
-
export type JobScheduleEvent = typeof JobScheduleEvent[keyof typeof JobScheduleEvent];
|
|
9304
|
-
|
|
9305
|
-
|
|
9306
|
-
/**
|
|
9307
|
-
*
|
|
9308
|
-
* @export
|
|
9309
|
-
* @interface Key
|
|
9310
|
-
*/
|
|
9311
|
-
export interface Key {
|
|
9588
|
+
'on_stop'?: JobRequestAllOfScheduleOnStart;
|
|
9312
9589
|
/**
|
|
9313
9590
|
*
|
|
9314
|
-
* @type {
|
|
9315
|
-
* @memberof
|
|
9591
|
+
* @type {JobRequestAllOfScheduleOnStart}
|
|
9592
|
+
* @memberof LifecycleJobResponseAllOfSchedule
|
|
9316
9593
|
*/
|
|
9317
|
-
'
|
|
9594
|
+
'on_delete'?: JobRequestAllOfScheduleOnStart;
|
|
9318
9595
|
}
|
|
9319
|
-
/**
|
|
9320
|
-
*
|
|
9321
|
-
* @export
|
|
9322
|
-
* @enum {string}
|
|
9323
|
-
*/
|
|
9324
|
-
|
|
9325
|
-
export const KubernetesEnum = {
|
|
9326
|
-
K3_S: 'K3S',
|
|
9327
|
-
MANAGED: 'MANAGED'
|
|
9328
|
-
} as const;
|
|
9329
|
-
|
|
9330
|
-
export type KubernetesEnum = typeof KubernetesEnum[keyof typeof KubernetesEnum];
|
|
9331
|
-
|
|
9332
|
-
|
|
9333
9596
|
/**
|
|
9334
9597
|
*
|
|
9335
9598
|
* @export
|