qovery-typescript-axios 1.1.288 → 1.1.290
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 +472 -191
- package/dist/api.d.ts +460 -182
- package/dist/api.js +14 -8
- package/dist/esm/api.d.ts +460 -182
- 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
|
|
@@ -7642,6 +7968,37 @@ export const HelmForceEvent = {
|
|
|
7642
7968
|
export type HelmForceEvent = typeof HelmForceEvent[keyof typeof HelmForceEvent];
|
|
7643
7969
|
|
|
7644
7970
|
|
|
7971
|
+
/**
|
|
7972
|
+
*
|
|
7973
|
+
* @export
|
|
7974
|
+
* @interface HelmGitRepositoryRequest
|
|
7975
|
+
*/
|
|
7976
|
+
export interface HelmGitRepositoryRequest {
|
|
7977
|
+
/**
|
|
7978
|
+
* application git repository URL
|
|
7979
|
+
* @type {string}
|
|
7980
|
+
* @memberof HelmGitRepositoryRequest
|
|
7981
|
+
*/
|
|
7982
|
+
'url': string;
|
|
7983
|
+
/**
|
|
7984
|
+
* Name of the branch to use. This is optional If not specified, then the branch used is the `main` or `master` one
|
|
7985
|
+
* @type {string}
|
|
7986
|
+
* @memberof HelmGitRepositoryRequest
|
|
7987
|
+
*/
|
|
7988
|
+
'branch'?: string;
|
|
7989
|
+
/**
|
|
7990
|
+
* indicates the root path of the application.
|
|
7991
|
+
* @type {string}
|
|
7992
|
+
* @memberof HelmGitRepositoryRequest
|
|
7993
|
+
*/
|
|
7994
|
+
'root_path'?: string;
|
|
7995
|
+
/**
|
|
7996
|
+
* The git token id on Qovery side
|
|
7997
|
+
* @type {string}
|
|
7998
|
+
* @memberof HelmGitRepositoryRequest
|
|
7999
|
+
*/
|
|
8000
|
+
'git_token_id'?: string | null;
|
|
8001
|
+
}
|
|
7645
8002
|
/**
|
|
7646
8003
|
*
|
|
7647
8004
|
* @export
|
|
@@ -7931,52 +8288,39 @@ export interface HelmRequest {
|
|
|
7931
8288
|
export interface HelmRequestAllOfSource {
|
|
7932
8289
|
/**
|
|
7933
8290
|
*
|
|
7934
|
-
* @type {
|
|
8291
|
+
* @type {HelmGitRepositoryRequest}
|
|
7935
8292
|
* @memberof HelmRequestAllOfSource
|
|
7936
8293
|
*/
|
|
7937
|
-
'
|
|
8294
|
+
'git_repository'?: HelmGitRepositoryRequest | null;
|
|
7938
8295
|
/**
|
|
7939
8296
|
*
|
|
7940
|
-
* @type {
|
|
8297
|
+
* @type {HelmRequestAllOfSourceHelmRepository}
|
|
7941
8298
|
* @memberof HelmRequestAllOfSource
|
|
7942
8299
|
*/
|
|
7943
|
-
'
|
|
7944
|
-
}
|
|
7945
|
-
/**
|
|
7946
|
-
*
|
|
7947
|
-
* @export
|
|
7948
|
-
* @interface HelmRequestAllOfSourceGit
|
|
7949
|
-
*/
|
|
7950
|
-
export interface HelmRequestAllOfSourceGit {
|
|
7951
|
-
/**
|
|
7952
|
-
*
|
|
7953
|
-
* @type {ApplicationGitRepositoryRequest}
|
|
7954
|
-
* @memberof HelmRequestAllOfSourceGit
|
|
7955
|
-
*/
|
|
7956
|
-
'git_repository'?: ApplicationGitRepositoryRequest;
|
|
8300
|
+
'helm_repository'?: HelmRequestAllOfSourceHelmRepository | null;
|
|
7957
8301
|
}
|
|
7958
8302
|
/**
|
|
7959
8303
|
*
|
|
7960
8304
|
* @export
|
|
7961
|
-
* @interface
|
|
8305
|
+
* @interface HelmRequestAllOfSourceHelmRepository
|
|
7962
8306
|
*/
|
|
7963
|
-
export interface
|
|
8307
|
+
export interface HelmRequestAllOfSourceHelmRepository {
|
|
7964
8308
|
/**
|
|
7965
8309
|
* The id of the helm repository
|
|
7966
8310
|
* @type {string}
|
|
7967
|
-
* @memberof
|
|
8311
|
+
* @memberof HelmRequestAllOfSourceHelmRepository
|
|
7968
8312
|
*/
|
|
7969
8313
|
'repository'?: string | null;
|
|
7970
8314
|
/**
|
|
7971
8315
|
* The name of the chart in the repository
|
|
7972
8316
|
* @type {string}
|
|
7973
|
-
* @memberof
|
|
8317
|
+
* @memberof HelmRequestAllOfSourceHelmRepository
|
|
7974
8318
|
*/
|
|
7975
8319
|
'chart_name'?: string;
|
|
7976
8320
|
/**
|
|
7977
8321
|
* The version of the chart to use
|
|
7978
8322
|
* @type {string}
|
|
7979
|
-
* @memberof
|
|
8323
|
+
* @memberof HelmRequestAllOfSourceHelmRepository
|
|
7980
8324
|
*/
|
|
7981
8325
|
'chart_version'?: string;
|
|
7982
8326
|
}
|
|
@@ -9052,284 +9396,221 @@ export interface JobRequestAllOfSourceImage {
|
|
|
9052
9396
|
*/
|
|
9053
9397
|
'registry_id'?: string;
|
|
9054
9398
|
}
|
|
9399
|
+
/**
|
|
9400
|
+
* @type JobResponse
|
|
9401
|
+
* @export
|
|
9402
|
+
*/
|
|
9403
|
+
export type JobResponse = { job_type: 'CRON' } & CronJobResponse | { job_type: 'LIFECYCLE' } & LifecycleJobResponse;
|
|
9404
|
+
|
|
9055
9405
|
/**
|
|
9056
9406
|
*
|
|
9057
9407
|
* @export
|
|
9058
|
-
* @interface
|
|
9408
|
+
* @interface JobResponseList
|
|
9059
9409
|
*/
|
|
9060
|
-
export interface
|
|
9410
|
+
export interface JobResponseList {
|
|
9411
|
+
/**
|
|
9412
|
+
*
|
|
9413
|
+
* @type {Array<JobResponse>}
|
|
9414
|
+
* @memberof JobResponseList
|
|
9415
|
+
*/
|
|
9416
|
+
'results'?: Array<JobResponse>;
|
|
9417
|
+
}
|
|
9418
|
+
/**
|
|
9419
|
+
* 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
|
|
9420
|
+
* @export
|
|
9421
|
+
* @enum {string}
|
|
9422
|
+
*/
|
|
9423
|
+
|
|
9424
|
+
export const JobScheduleEvent = {
|
|
9425
|
+
ON_START: 'ON_START',
|
|
9426
|
+
ON_STOP: 'ON_STOP',
|
|
9427
|
+
ON_DELETE: 'ON_DELETE',
|
|
9428
|
+
CRON: 'CRON'
|
|
9429
|
+
} as const;
|
|
9430
|
+
|
|
9431
|
+
export type JobScheduleEvent = typeof JobScheduleEvent[keyof typeof JobScheduleEvent];
|
|
9432
|
+
|
|
9433
|
+
|
|
9434
|
+
/**
|
|
9435
|
+
*
|
|
9436
|
+
* @export
|
|
9437
|
+
* @interface Key
|
|
9438
|
+
*/
|
|
9439
|
+
export interface Key {
|
|
9061
9440
|
/**
|
|
9062
9441
|
*
|
|
9063
9442
|
* @type {string}
|
|
9064
|
-
* @memberof
|
|
9443
|
+
* @memberof Key
|
|
9444
|
+
*/
|
|
9445
|
+
'key': string;
|
|
9446
|
+
}
|
|
9447
|
+
/**
|
|
9448
|
+
*
|
|
9449
|
+
* @export
|
|
9450
|
+
* @enum {string}
|
|
9451
|
+
*/
|
|
9452
|
+
|
|
9453
|
+
export const KubernetesEnum = {
|
|
9454
|
+
K3_S: 'K3S',
|
|
9455
|
+
MANAGED: 'MANAGED'
|
|
9456
|
+
} as const;
|
|
9457
|
+
|
|
9458
|
+
export type KubernetesEnum = typeof KubernetesEnum[keyof typeof KubernetesEnum];
|
|
9459
|
+
|
|
9460
|
+
|
|
9461
|
+
/**
|
|
9462
|
+
*
|
|
9463
|
+
* @export
|
|
9464
|
+
* @interface LifecycleJobResponse
|
|
9465
|
+
*/
|
|
9466
|
+
export interface LifecycleJobResponse {
|
|
9467
|
+
/**
|
|
9468
|
+
*
|
|
9469
|
+
* @type {string}
|
|
9470
|
+
* @memberof LifecycleJobResponse
|
|
9065
9471
|
*/
|
|
9066
9472
|
'id': string;
|
|
9067
9473
|
/**
|
|
9068
9474
|
*
|
|
9069
9475
|
* @type {string}
|
|
9070
|
-
* @memberof
|
|
9476
|
+
* @memberof LifecycleJobResponse
|
|
9071
9477
|
*/
|
|
9072
9478
|
'created_at': string;
|
|
9073
9479
|
/**
|
|
9074
9480
|
*
|
|
9075
9481
|
* @type {string}
|
|
9076
|
-
* @memberof
|
|
9482
|
+
* @memberof LifecycleJobResponse
|
|
9077
9483
|
*/
|
|
9078
9484
|
'updated_at'?: string;
|
|
9079
9485
|
/**
|
|
9080
9486
|
*
|
|
9081
9487
|
* @type {ReferenceObject}
|
|
9082
|
-
* @memberof
|
|
9488
|
+
* @memberof LifecycleJobResponse
|
|
9083
9489
|
*/
|
|
9084
9490
|
'environment': ReferenceObject;
|
|
9085
9491
|
/**
|
|
9086
9492
|
* Maximum cpu that can be allocated to the job based on organization cluster configuration. unit is millicores (m). 1000m = 1 cpu
|
|
9087
9493
|
* @type {number}
|
|
9088
|
-
* @memberof
|
|
9494
|
+
* @memberof LifecycleJobResponse
|
|
9089
9495
|
*/
|
|
9090
9496
|
'maximum_cpu': number;
|
|
9091
9497
|
/**
|
|
9092
9498
|
* Maximum memory that can be allocated to the job based on organization cluster configuration. unit is MB. 1024 MB = 1GB
|
|
9093
9499
|
* @type {number}
|
|
9094
|
-
* @memberof
|
|
9500
|
+
* @memberof LifecycleJobResponse
|
|
9095
9501
|
*/
|
|
9096
9502
|
'maximum_memory': number;
|
|
9097
9503
|
/**
|
|
9098
9504
|
* name is case insensitive
|
|
9099
9505
|
* @type {string}
|
|
9100
|
-
* @memberof
|
|
9506
|
+
* @memberof LifecycleJobResponse
|
|
9101
9507
|
*/
|
|
9102
9508
|
'name': string;
|
|
9103
9509
|
/**
|
|
9104
9510
|
*
|
|
9105
9511
|
* @type {string}
|
|
9106
|
-
* @memberof
|
|
9512
|
+
* @memberof LifecycleJobResponse
|
|
9107
9513
|
*/
|
|
9108
9514
|
'description'?: string;
|
|
9109
9515
|
/**
|
|
9110
9516
|
* unit is millicores (m). 1000m = 1 cpu
|
|
9111
9517
|
* @type {number}
|
|
9112
|
-
* @memberof
|
|
9518
|
+
* @memberof LifecycleJobResponse
|
|
9113
9519
|
*/
|
|
9114
9520
|
'cpu': number;
|
|
9115
9521
|
/**
|
|
9116
9522
|
* unit is MB. 1024 MB = 1GB
|
|
9117
9523
|
* @type {number}
|
|
9118
|
-
* @memberof
|
|
9524
|
+
* @memberof LifecycleJobResponse
|
|
9119
9525
|
*/
|
|
9120
9526
|
'memory': number;
|
|
9121
9527
|
/**
|
|
9122
9528
|
* Maximum number of restart allowed before the job is considered as failed 0 means that no restart/crash of the job is allowed
|
|
9123
9529
|
* @type {number}
|
|
9124
|
-
* @memberof
|
|
9530
|
+
* @memberof LifecycleJobResponse
|
|
9125
9531
|
*/
|
|
9126
9532
|
'max_nb_restart'?: number;
|
|
9127
9533
|
/**
|
|
9128
9534
|
* Maximum number of seconds allowed for the job to run before killing it and mark it as failed
|
|
9129
9535
|
* @type {number}
|
|
9130
|
-
* @memberof
|
|
9536
|
+
* @memberof LifecycleJobResponse
|
|
9131
9537
|
*/
|
|
9132
9538
|
'max_duration_seconds'?: number;
|
|
9133
9539
|
/**
|
|
9134
9540
|
* 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
9541
|
* @type {boolean}
|
|
9136
|
-
* @memberof
|
|
9542
|
+
* @memberof LifecycleJobResponse
|
|
9137
9543
|
*/
|
|
9138
9544
|
'auto_preview': boolean;
|
|
9139
9545
|
/**
|
|
9140
9546
|
* Port where to run readiness and liveliness probes checks. The port will not be exposed externally
|
|
9141
9547
|
* @type {number}
|
|
9142
|
-
* @memberof
|
|
9548
|
+
* @memberof LifecycleJobResponse
|
|
9143
9549
|
*/
|
|
9144
9550
|
'port'?: number | null;
|
|
9145
9551
|
/**
|
|
9146
9552
|
*
|
|
9147
|
-
* @type {
|
|
9148
|
-
* @memberof
|
|
9553
|
+
* @type {BaseJobResponseAllOfSource}
|
|
9554
|
+
* @memberof LifecycleJobResponse
|
|
9149
9555
|
*/
|
|
9150
|
-
'source':
|
|
9556
|
+
'source': BaseJobResponseAllOfSource;
|
|
9151
9557
|
/**
|
|
9152
9558
|
*
|
|
9153
9559
|
* @type {Healthcheck}
|
|
9154
|
-
* @memberof
|
|
9560
|
+
* @memberof LifecycleJobResponse
|
|
9155
9561
|
*/
|
|
9156
9562
|
'healthchecks': Healthcheck;
|
|
9157
|
-
/**
|
|
9158
|
-
*
|
|
9159
|
-
* @type {JobResponseAllOfSchedule}
|
|
9160
|
-
* @memberof JobResponse
|
|
9161
|
-
*/
|
|
9162
|
-
'schedule'?: JobResponseAllOfSchedule;
|
|
9163
9563
|
/**
|
|
9164
9564
|
* 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
9565
|
* @type {boolean}
|
|
9166
|
-
* @memberof
|
|
9566
|
+
* @memberof LifecycleJobResponse
|
|
9167
9567
|
*/
|
|
9168
9568
|
'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
|
-
/**
|
|
9189
|
-
*
|
|
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
9569
|
/**
|
|
9208
9570
|
*
|
|
9209
|
-
* @type {Array<string>}
|
|
9210
|
-
* @memberof JobResponseAllOfScheduleCronjob
|
|
9211
|
-
*/
|
|
9212
|
-
'arguments'?: Array<string>;
|
|
9213
|
-
/**
|
|
9214
|
-
* optional entrypoint when launching container
|
|
9215
|
-
* @type {string}
|
|
9216
|
-
* @memberof JobResponseAllOfScheduleCronjob
|
|
9217
|
-
*/
|
|
9218
|
-
'entrypoint'?: string;
|
|
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
9571
|
* @type {string}
|
|
9222
|
-
* @memberof
|
|
9572
|
+
* @memberof LifecycleJobResponse
|
|
9223
9573
|
*/
|
|
9224
|
-
'
|
|
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 {
|
|
9574
|
+
'job_type': LifecycleJobResponseJobTypeEnum;
|
|
9238
9575
|
/**
|
|
9239
9576
|
*
|
|
9240
|
-
* @type {
|
|
9241
|
-
* @memberof
|
|
9577
|
+
* @type {LifecycleJobResponseAllOfSchedule}
|
|
9578
|
+
* @memberof LifecycleJobResponse
|
|
9242
9579
|
*/
|
|
9243
|
-
'
|
|
9580
|
+
'schedule': LifecycleJobResponseAllOfSchedule;
|
|
9244
9581
|
}
|
|
9582
|
+
|
|
9583
|
+
export const LifecycleJobResponseJobTypeEnum = {
|
|
9584
|
+
LIFECYCLE: 'LIFECYCLE'
|
|
9585
|
+
} as const;
|
|
9586
|
+
|
|
9587
|
+
export type LifecycleJobResponseJobTypeEnum = typeof LifecycleJobResponseJobTypeEnum[keyof typeof LifecycleJobResponseJobTypeEnum];
|
|
9588
|
+
|
|
9245
9589
|
/**
|
|
9246
9590
|
*
|
|
9247
9591
|
* @export
|
|
9248
|
-
* @interface
|
|
9592
|
+
* @interface LifecycleJobResponseAllOfSchedule
|
|
9249
9593
|
*/
|
|
9250
|
-
export interface
|
|
9594
|
+
export interface LifecycleJobResponseAllOfSchedule {
|
|
9251
9595
|
/**
|
|
9252
9596
|
*
|
|
9253
|
-
* @type {
|
|
9254
|
-
* @memberof
|
|
9255
|
-
*/
|
|
9256
|
-
'docker'?: JobResponseAllOfSourceOneOf1Docker;
|
|
9257
|
-
}
|
|
9258
|
-
/**
|
|
9259
|
-
*
|
|
9260
|
-
* @export
|
|
9261
|
-
* @interface JobResponseAllOfSourceOneOf1Docker
|
|
9262
|
-
*/
|
|
9263
|
-
export interface JobResponseAllOfSourceOneOf1Docker {
|
|
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;
|
|
9270
|
-
/**
|
|
9271
|
-
*
|
|
9272
|
-
* @type {ApplicationGitRepository}
|
|
9273
|
-
* @memberof JobResponseAllOfSourceOneOf1Docker
|
|
9597
|
+
* @type {JobRequestAllOfScheduleOnStart}
|
|
9598
|
+
* @memberof LifecycleJobResponseAllOfSchedule
|
|
9274
9599
|
*/
|
|
9275
|
-
'
|
|
9276
|
-
}
|
|
9277
|
-
/**
|
|
9278
|
-
*
|
|
9279
|
-
* @export
|
|
9280
|
-
* @interface JobResponseList
|
|
9281
|
-
*/
|
|
9282
|
-
export interface JobResponseList {
|
|
9600
|
+
'on_start'?: JobRequestAllOfScheduleOnStart;
|
|
9283
9601
|
/**
|
|
9284
9602
|
*
|
|
9285
|
-
* @type {
|
|
9286
|
-
* @memberof
|
|
9603
|
+
* @type {JobRequestAllOfScheduleOnStart}
|
|
9604
|
+
* @memberof LifecycleJobResponseAllOfSchedule
|
|
9287
9605
|
*/
|
|
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 {
|
|
9606
|
+
'on_stop'?: JobRequestAllOfScheduleOnStart;
|
|
9312
9607
|
/**
|
|
9313
9608
|
*
|
|
9314
|
-
* @type {
|
|
9315
|
-
* @memberof
|
|
9609
|
+
* @type {JobRequestAllOfScheduleOnStart}
|
|
9610
|
+
* @memberof LifecycleJobResponseAllOfSchedule
|
|
9316
9611
|
*/
|
|
9317
|
-
'
|
|
9612
|
+
'on_delete'?: JobRequestAllOfScheduleOnStart;
|
|
9318
9613
|
}
|
|
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
9614
|
/**
|
|
9334
9615
|
*
|
|
9335
9616
|
* @export
|