@northflank/js-client 0.4.1 → 0.5.0-beta.0
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/dist/cjs/api-client.d.ts +6013 -0
- package/dist/cjs/api-client.js +1 -0
- package/dist/cjs/package.json +3 -0
- package/dist/esm/api-client.d.ts +6013 -0
- package/dist/esm/api-client.js +15 -0
- package/dist/esm/package.json +3 -0
- package/package.json +12 -19
- package/dist/api-client.d.ts +0 -481
- package/dist/api-client.js +0 -748
- package/dist/api-endpoint.d.ts +0 -63
- package/dist/api-endpoint.js +0 -216
- package/dist/context/api-client-context-provider.d.ts +0 -47
- package/dist/context/api-client-context-provider.js +0 -332
- package/dist/context/api-client-file-context-provider.d.ts +0 -11
- package/dist/context/api-client-file-context-provider.js +0 -138
- package/dist/context/api-client-in-memory-context-provider.d.ts +0 -6
- package/dist/context/api-client-in-memory-context-provider.js +0 -82
- package/dist/context/index.d.ts +0 -3
- package/dist/context/index.js +0 -15
- package/dist/endpoints/abort/addon/backup.d.ts +0 -21
- package/dist/endpoints/abort/addon/backup.js +0 -36
- package/dist/endpoints/abort/addon/restore.d.ts +0 -26
- package/dist/endpoints/abort/addon/restore.js +0 -36
- package/dist/endpoints/abort/job/build.d.ts +0 -21
- package/dist/endpoints/abort/job/build.js +0 -36
- package/dist/endpoints/abort/job/run.d.ts +0 -21
- package/dist/endpoints/abort/job/run.js +0 -36
- package/dist/endpoints/abort/service/build.d.ts +0 -21
- package/dist/endpoints/abort/service/build.js +0 -36
- package/dist/endpoints/add/domain/subdomain.d.ts +0 -33
- package/dist/endpoints/add/domain/subdomain.js +0 -36
- package/dist/endpoints/add/registryCredentials.d.ts +0 -47
- package/dist/endpoints/add/registryCredentials.js +0 -36
- package/dist/endpoints/assign/subdomain/service.d.ts +0 -28
- package/dist/endpoints/assign/subdomain/service.js +0 -36
- package/dist/endpoints/backup/addon.d.ts +0 -51
- package/dist/endpoints/backup/addon.js +0 -36
- package/dist/endpoints/create/addon.d.ts +0 -90
- package/dist/endpoints/create/addon.js +0 -36
- package/dist/endpoints/create/domain.d.ts +0 -27
- package/dist/endpoints/create/domain.js +0 -36
- package/dist/endpoints/create/job/cron.d.ts +0 -157
- package/dist/endpoints/create/job/cron.js +0 -36
- package/dist/endpoints/create/job/manual.d.ts +0 -147
- package/dist/endpoints/create/job/manual.js +0 -36
- package/dist/endpoints/create/project.d.ts +0 -29
- package/dist/endpoints/create/project.js +0 -36
- package/dist/endpoints/create/secret.d.ts +0 -79
- package/dist/endpoints/create/secret.js +0 -36
- package/dist/endpoints/create/service/build.d.ts +0 -116
- package/dist/endpoints/create/service/build.js +0 -36
- package/dist/endpoints/create/service/combined.d.ts +0 -166
- package/dist/endpoints/create/service/combined.js +0 -36
- package/dist/endpoints/create/service/deployment.d.ts +0 -137
- package/dist/endpoints/create/service/deployment.js +0 -36
- package/dist/endpoints/delete/addon.d.ts +0 -19
- package/dist/endpoints/delete/addon.js +0 -36
- package/dist/endpoints/delete/backup.d.ts +0 -21
- package/dist/endpoints/delete/backup.js +0 -36
- package/dist/endpoints/delete/domain.d.ts +0 -17
- package/dist/endpoints/delete/domain.js +0 -36
- package/dist/endpoints/delete/job.d.ts +0 -19
- package/dist/endpoints/delete/job.js +0 -36
- package/dist/endpoints/delete/project.d.ts +0 -17
- package/dist/endpoints/delete/project.js +0 -36
- package/dist/endpoints/delete/registryCredentials.d.ts +0 -17
- package/dist/endpoints/delete/registryCredentials.js +0 -36
- package/dist/endpoints/delete/secret.d.ts +0 -19
- package/dist/endpoints/delete/secret.js +0 -36
- package/dist/endpoints/delete/secretLink.d.ts +0 -21
- package/dist/endpoints/delete/secretLink.js +0 -36
- package/dist/endpoints/delete/service.d.ts +0 -19
- package/dist/endpoints/delete/service.js +0 -36
- package/dist/endpoints/delete/subdomain.d.ts +0 -19
- package/dist/endpoints/delete/subdomain.js +0 -36
- package/dist/endpoints/get/addon/backup/download.d.ts +0 -24
- package/dist/endpoints/get/addon/backup/download.js +0 -36
- package/dist/endpoints/get/addon/backup.d.ts +0 -46
- package/dist/endpoints/get/addon/backup.js +0 -36
- package/dist/endpoints/get/addon/backups.d.ts +0 -54
- package/dist/endpoints/get/addon/backups.js +0 -40
- package/dist/endpoints/get/addon/containers.d.ts +0 -40
- package/dist/endpoints/get/addon/containers.js +0 -40
- package/dist/endpoints/get/addon/credentials.d.ts +0 -24
- package/dist/endpoints/get/addon/credentials.js +0 -36
- package/dist/endpoints/get/addon/types.d.ts +0 -48
- package/dist/endpoints/get/addon/types.js +0 -36
- package/dist/endpoints/get/addon/version.d.ts +0 -53
- package/dist/endpoints/get/addon/version.js +0 -36
- package/dist/endpoints/get/addon.d.ts +0 -69
- package/dist/endpoints/get/addon.js +0 -36
- package/dist/endpoints/get/dnsId.d.ts +0 -15
- package/dist/endpoints/get/dnsId.js +0 -36
- package/dist/endpoints/get/domain.d.ts +0 -33
- package/dist/endpoints/get/domain.js +0 -36
- package/dist/endpoints/get/job/buildArguments.d.ts +0 -19
- package/dist/endpoints/get/job/buildArguments.js +0 -36
- package/dist/endpoints/get/job/builds.d.ts +0 -50
- package/dist/endpoints/get/job/builds.js +0 -39
- package/dist/endpoints/get/job/containers.d.ts +0 -40
- package/dist/endpoints/get/job/containers.js +0 -40
- package/dist/endpoints/get/job/deployment.d.ts +0 -51
- package/dist/endpoints/get/job/deployment.js +0 -36
- package/dist/endpoints/get/job/environment.d.ts +0 -24
- package/dist/endpoints/get/job/environment.js +0 -40
- package/dist/endpoints/get/job/environmentDetails.d.ts +0 -42
- package/dist/endpoints/get/job/environmentDetails.js +0 -36
- package/dist/endpoints/get/job/healthChecks.d.ts +0 -44
- package/dist/endpoints/get/job/healthChecks.js +0 -36
- package/dist/endpoints/get/job/run.d.ts +0 -42
- package/dist/endpoints/get/job/run.js +0 -36
- package/dist/endpoints/get/job/runs.d.ts +0 -52
- package/dist/endpoints/get/job/runs.js +0 -39
- package/dist/endpoints/get/job.d.ts +0 -86
- package/dist/endpoints/get/job.js +0 -36
- package/dist/endpoints/get/project.d.ts +0 -72
- package/dist/endpoints/get/project.js +0 -36
- package/dist/endpoints/get/registryCredentials.d.ts +0 -34
- package/dist/endpoints/get/registryCredentials.js +0 -36
- package/dist/endpoints/get/secret.d.ts +0 -55
- package/dist/endpoints/get/secret.js +0 -39
- package/dist/endpoints/get/secretDetails.d.ts +0 -63
- package/dist/endpoints/get/secretDetails.js +0 -36
- package/dist/endpoints/get/secretLink.d.ts +0 -44
- package/dist/endpoints/get/secretLink.js +0 -36
- package/dist/endpoints/get/service/buildArguments.d.ts +0 -19
- package/dist/endpoints/get/service/buildArguments.js +0 -36
- package/dist/endpoints/get/service/builds.d.ts +0 -50
- package/dist/endpoints/get/service/builds.js +0 -40
- package/dist/endpoints/get/service/containers.d.ts +0 -40
- package/dist/endpoints/get/service/containers.js +0 -40
- package/dist/endpoints/get/service/deployment.d.ts +0 -51
- package/dist/endpoints/get/service/deployment.js +0 -36
- package/dist/endpoints/get/service/environmentVariableDetails.d.ts +0 -42
- package/dist/endpoints/get/service/environmentVariableDetails.js +0 -36
- package/dist/endpoints/get/service/environmentVariables.d.ts +0 -24
- package/dist/endpoints/get/service/environmentVariables.js +0 -40
- package/dist/endpoints/get/service/healthChecks.d.ts +0 -44
- package/dist/endpoints/get/service/healthChecks.js +0 -36
- package/dist/endpoints/get/service/ports.d.ts +0 -35
- package/dist/endpoints/get/service/ports.js +0 -36
- package/dist/endpoints/get/service.d.ts +0 -103
- package/dist/endpoints/get/service.js +0 -36
- package/dist/endpoints/get/subdomain.d.ts +0 -30
- package/dist/endpoints/get/subdomain.js +0 -36
- package/dist/endpoints/import/addon/backup.d.ts +0 -31
- package/dist/endpoints/import/addon/backup.js +0 -36
- package/dist/endpoints/list/addons.d.ts +0 -45
- package/dist/endpoints/list/addons.js +0 -39
- package/dist/endpoints/list/domains.d.ts +0 -34
- package/dist/endpoints/list/domains.js +0 -39
- package/dist/endpoints/list/jobs.d.ts +0 -44
- package/dist/endpoints/list/jobs.js +0 -39
- package/dist/endpoints/list/plans.d.ts +0 -30
- package/dist/endpoints/list/plans.js +0 -36
- package/dist/endpoints/list/projects.d.ts +0 -32
- package/dist/endpoints/list/projects.js +0 -39
- package/dist/endpoints/list/regions.d.ts +0 -18
- package/dist/endpoints/list/regions.js +0 -36
- package/dist/endpoints/list/registryCredentials.d.ts +0 -41
- package/dist/endpoints/list/registryCredentials.js +0 -39
- package/dist/endpoints/list/secrets.d.ts +0 -52
- package/dist/endpoints/list/secrets.js +0 -39
- package/dist/endpoints/list/services.d.ts +0 -44
- package/dist/endpoints/list/services.js +0 -39
- package/dist/endpoints/list/vcs.d.ts +0 -51
- package/dist/endpoints/list/vcs.js +0 -36
- package/dist/endpoints/pause/addon.d.ts +0 -19
- package/dist/endpoints/pause/addon.js +0 -36
- package/dist/endpoints/pause/service.d.ts +0 -19
- package/dist/endpoints/pause/service.js +0 -36
- package/dist/endpoints/restart/addon.d.ts +0 -19
- package/dist/endpoints/restart/addon.js +0 -36
- package/dist/endpoints/restart/service.d.ts +0 -19
- package/dist/endpoints/restart/service.js +0 -36
- package/dist/endpoints/restore/addon/backup.d.ts +0 -21
- package/dist/endpoints/restore/addon/backup.js +0 -36
- package/dist/endpoints/resume/addon.d.ts +0 -19
- package/dist/endpoints/resume/addon.js +0 -36
- package/dist/endpoints/resume/service.d.ts +0 -24
- package/dist/endpoints/resume/service.js +0 -36
- package/dist/endpoints/scale/addon.d.ts +0 -28
- package/dist/endpoints/scale/addon.js +0 -36
- package/dist/endpoints/scale/service.d.ts +0 -26
- package/dist/endpoints/scale/service.js +0 -36
- package/dist/endpoints/start/job/build.d.ts +0 -37
- package/dist/endpoints/start/job/build.js +0 -36
- package/dist/endpoints/start/job/run.d.ts +0 -37
- package/dist/endpoints/start/job/run.js +0 -36
- package/dist/endpoints/start/service/build.d.ts +0 -41
- package/dist/endpoints/start/service/build.js +0 -36
- package/dist/endpoints/unassign/subdomain.d.ts +0 -19
- package/dist/endpoints/unassign/subdomain.js +0 -36
- package/dist/endpoints/update/addon/networkSettings.d.ts +0 -26
- package/dist/endpoints/update/addon/networkSettings.js +0 -36
- package/dist/endpoints/update/addon/security.d.ts +0 -29
- package/dist/endpoints/update/addon/security.js +0 -36
- package/dist/endpoints/update/addon/version.d.ts +0 -24
- package/dist/endpoints/update/addon/version.js +0 -36
- package/dist/endpoints/update/job/buildArguments.d.ts +0 -24
- package/dist/endpoints/update/job/buildArguments.js +0 -36
- package/dist/endpoints/update/job/cmdOverride.d.ts +0 -24
- package/dist/endpoints/update/job/cmdOverride.js +0 -36
- package/dist/endpoints/update/job/deployment.d.ts +0 -37
- package/dist/endpoints/update/job/deployment.js +0 -36
- package/dist/endpoints/update/job/environment.d.ts +0 -24
- package/dist/endpoints/update/job/environment.js +0 -36
- package/dist/endpoints/update/job/healthChecks.d.ts +0 -45
- package/dist/endpoints/update/job/healthChecks.js +0 -36
- package/dist/endpoints/update/job/settings.d.ts +0 -30
- package/dist/endpoints/update/job/settings.js +0 -36
- package/dist/endpoints/update/registryCredentials.d.ts +0 -31
- package/dist/endpoints/update/registryCredentials.js +0 -36
- package/dist/endpoints/update/secret.d.ts +0 -54
- package/dist/endpoints/update/secret.js +0 -36
- package/dist/endpoints/update/secretLink.d.ts +0 -40
- package/dist/endpoints/update/secretLink.js +0 -36
- package/dist/endpoints/update/service/buildArguments.d.ts +0 -24
- package/dist/endpoints/update/service/buildArguments.js +0 -36
- package/dist/endpoints/update/service/buildOptions.d.ts +0 -52
- package/dist/endpoints/update/service/buildOptions.js +0 -36
- package/dist/endpoints/update/service/cmdOverride.d.ts +0 -24
- package/dist/endpoints/update/service/cmdOverride.js +0 -36
- package/dist/endpoints/update/service/deployment.d.ts +0 -37
- package/dist/endpoints/update/service/deployment.js +0 -36
- package/dist/endpoints/update/service/environmentVariables.d.ts +0 -29
- package/dist/endpoints/update/service/environmentVariables.js +0 -36
- package/dist/endpoints/update/service/healthChecks.d.ts +0 -45
- package/dist/endpoints/update/service/healthChecks.js +0 -36
- package/dist/endpoints/update/service/ports.d.ts +0 -55
- package/dist/endpoints/update/service/ports.js +0 -36
- package/dist/endpoints/verify/domain.d.ts +0 -17
- package/dist/endpoints/verify/domain.js +0 -36
- package/dist/endpoints/verify/subdomain.d.ts +0 -19
- package/dist/endpoints/verify/subdomain.js +0 -36
- package/dist/port-forward/client/api-helper.d.ts +0 -30
- package/dist/port-forward/client/api-helper.js +0 -102
- package/dist/port-forward/client/atomic-write.d.ts +0 -3
- package/dist/port-forward/client/atomic-write.js +0 -95
- package/dist/port-forward/client/host-file-ast.d.ts +0 -52
- package/dist/port-forward/client/host-file-ast.js +0 -279
- package/dist/port-forward/client/host-file.d.ts +0 -26
- package/dist/port-forward/client/host-file.js +0 -226
- package/dist/port-forward/client/loopback.d.ts +0 -4
- package/dist/port-forward/client/loopback.js +0 -219
- package/dist/port-forward/client/port-forwarder.d.ts +0 -86
- package/dist/port-forward/client/port-forwarder.js +0 -593
- package/dist/port-forward/client/port-tunnel-tcp.d.ts +0 -34
- package/dist/port-forward/client/port-tunnel-tcp.js +0 -209
- package/dist/port-forward/client/port-tunnel-udp.d.ts +0 -25
- package/dist/port-forward/client/port-tunnel-udp.js +0 -147
- package/dist/port-forward/client/port-tunnel.d.ts +0 -32
- package/dist/port-forward/client/port-tunnel.js +0 -2
- package/dist/port-forward/client/promise-mutex.d.ts +0 -4
- package/dist/port-forward/client/promise-mutex.js +0 -62
- package/dist/utils.d.ts +0 -8
- package/dist/utils.js +0 -97
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
|
|
3
|
-
export declare type GetJobContainersResult = {
|
|
4
|
-
/** An array of containers. */
|
|
5
|
-
'pods': {
|
|
6
|
-
/** The timestamp the pod was created. Example: 1611241087 */
|
|
7
|
-
'createdAt': number;
|
|
8
|
-
/** The name of the pod. Example: "example-service-78b4d4459d-sbtn8" */
|
|
9
|
-
'podName': string;
|
|
10
|
-
/** The region where the pod is deployed. Example: "europe-west" */
|
|
11
|
-
'region': string;
|
|
12
|
-
/** The current status of the pod. Example: "TASK_RUNNING" */
|
|
13
|
-
'status': 'TASK_RUNNING' | 'TASK_STARTING' | 'TASK_STAGING' | 'TASK_KILLING' | 'TASK_KILLED' | 'TASK_FAILED' | 'TASK_FINISHED';
|
|
14
|
-
}[];
|
|
15
|
-
};
|
|
16
|
-
export declare type GetJobContainersCall = (opts: GetJobContainersRequest) => Promise<ApiCallResponse<GetJobContainersResult>>;
|
|
17
|
-
export declare type GetJobContainersRequest = {
|
|
18
|
-
parameters: GetJobContainersParameters;
|
|
19
|
-
options?: GetJobContainersOptions;
|
|
20
|
-
};
|
|
21
|
-
export declare type GetJobContainersParameters = {
|
|
22
|
-
/** ID of the project */ 'projectId': string;
|
|
23
|
-
/** ID of the job */
|
|
24
|
-
'jobId': string;
|
|
25
|
-
};
|
|
26
|
-
export declare type GetJobContainersOptions = {
|
|
27
|
-
/** The number of results to display per request. Maximum of 100 results per page. */
|
|
28
|
-
'per_page'?: number;
|
|
29
|
-
/** The page number to access. */
|
|
30
|
-
'page'?: number;
|
|
31
|
-
/** The cursor returned from the previous page of results, used to request the next page. */
|
|
32
|
-
'cursor'?: string;
|
|
33
|
-
};
|
|
34
|
-
/** Gets a list of containers for the given job. */
|
|
35
|
-
export declare class GetJobContainersEndpoint extends GetApiEndpoint<GetJobContainersRequest, GetJobContainersResult> {
|
|
36
|
-
description: string;
|
|
37
|
-
withAuth: boolean;
|
|
38
|
-
endpointUrl: (opts: GetJobContainersRequest) => string;
|
|
39
|
-
body: () => undefined;
|
|
40
|
-
}
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.GetJobContainersEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../../api-endpoint");
|
|
21
|
-
/** Gets a list of containers for the given job. */
|
|
22
|
-
var GetJobContainersEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(GetJobContainersEndpoint, _super);
|
|
24
|
-
function GetJobContainersEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Gets a list of containers for the given job.';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
var _a;
|
|
30
|
-
var optionEntries = Object.entries((_a = opts === null || opts === void 0 ? void 0 : opts.options) !== null && _a !== void 0 ? _a : {});
|
|
31
|
-
var optionStr = optionEntries.length > 0 ? '?' + optionEntries.map(function (a) { return a[0] + '=' + a[1]; }).join('&') : '';
|
|
32
|
-
return ("/v1/projects/" + opts.parameters.projectId + "/jobs/" + opts.parameters.jobId + "/containers" +
|
|
33
|
-
optionStr);
|
|
34
|
-
};
|
|
35
|
-
_this.body = function () { return undefined; };
|
|
36
|
-
return _this;
|
|
37
|
-
}
|
|
38
|
-
return GetJobContainersEndpoint;
|
|
39
|
-
}(api_endpoint_1.GetApiEndpoint));
|
|
40
|
-
exports.GetJobContainersEndpoint = GetJobContainersEndpoint;
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
|
|
3
|
-
export declare type GetJobDeploymentResult = {
|
|
4
|
-
/** Region where this service is deployed and/or built Example: "europe-west" */
|
|
5
|
-
'region'?: string;
|
|
6
|
-
/** Number of instances/replicas running Example: 1 */
|
|
7
|
-
'instances'?: number;
|
|
8
|
-
'internal': {
|
|
9
|
-
/** Full identifier of deployed entity Example: "/example-user/default-project/example-service" */
|
|
10
|
-
'appId': string;
|
|
11
|
-
/** ID of deployed entity Example: "example-service" */
|
|
12
|
-
'nfObjectId': string;
|
|
13
|
-
/** URL of the repository being deployed Example: "https://github.com/northflank/gatsby-with-northflank" */
|
|
14
|
-
'repository': string;
|
|
15
|
-
/** Branch of the repo being deployed Example: "master" */
|
|
16
|
-
'branch': string;
|
|
17
|
-
/** Commit SHA being deployed. 'latest' means the latest commit is automatically being deployed. Example: "latest" */
|
|
18
|
-
'buildSHA': string;
|
|
19
|
-
/** Type of deployed entity Example: "service" */
|
|
20
|
-
'nfObjectType': 'service' | 'job';
|
|
21
|
-
};
|
|
22
|
-
} | {
|
|
23
|
-
/** Region where this service is deployed and/or built Example: "europe-west" */
|
|
24
|
-
'region'?: string;
|
|
25
|
-
/** Number of instances/replicas running Example: 1 */
|
|
26
|
-
'instances'?: number;
|
|
27
|
-
'external': {
|
|
28
|
-
/** Path of the external image excluding the hostname Example: "nginx:latest" */
|
|
29
|
-
'imagePath': string;
|
|
30
|
-
/** Registry provider hosting the external image Example: "dockerhub" */
|
|
31
|
-
'registryProvider': 'dockerhub' | 'gcr-eu' | 'gcr-us' | 'gitlab' | 'github' | 'custom';
|
|
32
|
-
/** Does the image require authentication */
|
|
33
|
-
'privateImage': boolean;
|
|
34
|
-
};
|
|
35
|
-
};
|
|
36
|
-
export declare type GetJobDeploymentCall = (opts: GetJobDeploymentRequest) => Promise<ApiCallResponse<GetJobDeploymentResult>>;
|
|
37
|
-
export declare type GetJobDeploymentRequest = {
|
|
38
|
-
parameters: GetJobDeploymentParameters;
|
|
39
|
-
};
|
|
40
|
-
export declare type GetJobDeploymentParameters = {
|
|
41
|
-
/** ID of the project */ 'projectId': string;
|
|
42
|
-
/** ID of the job */
|
|
43
|
-
'jobId': string;
|
|
44
|
-
};
|
|
45
|
-
/** Gets information about the deployment of the given job. */
|
|
46
|
-
export declare class GetJobDeploymentEndpoint extends GetApiEndpoint<GetJobDeploymentRequest, GetJobDeploymentResult> {
|
|
47
|
-
description: string;
|
|
48
|
-
withAuth: boolean;
|
|
49
|
-
endpointUrl: (opts: GetJobDeploymentRequest) => string;
|
|
50
|
-
body: () => undefined;
|
|
51
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.GetJobDeploymentEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../../api-endpoint");
|
|
21
|
-
/** Gets information about the deployment of the given job. */
|
|
22
|
-
var GetJobDeploymentEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(GetJobDeploymentEndpoint, _super);
|
|
24
|
-
function GetJobDeploymentEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Gets information about the deployment of the given job.';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
return "/v1/projects/" + opts.parameters.projectId + "/jobs/" + opts.parameters.jobId + "/deployment";
|
|
30
|
-
};
|
|
31
|
-
_this.body = function () { return undefined; };
|
|
32
|
-
return _this;
|
|
33
|
-
}
|
|
34
|
-
return GetJobDeploymentEndpoint;
|
|
35
|
-
}(api_endpoint_1.GetApiEndpoint));
|
|
36
|
-
exports.GetJobDeploymentEndpoint = GetJobDeploymentEndpoint;
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
|
|
3
|
-
export declare type GetJobEnvironmentResult = any;
|
|
4
|
-
export declare type GetJobEnvironmentCall = (opts: GetJobEnvironmentRequest) => Promise<ApiCallResponse<GetJobEnvironmentResult>>;
|
|
5
|
-
export declare type GetJobEnvironmentRequest = {
|
|
6
|
-
parameters: GetJobEnvironmentParameters;
|
|
7
|
-
options?: GetJobEnvironmentOptions;
|
|
8
|
-
};
|
|
9
|
-
export declare type GetJobEnvironmentParameters = {
|
|
10
|
-
/** ID of the project */ 'projectId': string;
|
|
11
|
-
/** ID of the job */
|
|
12
|
-
'jobId': string;
|
|
13
|
-
};
|
|
14
|
-
export declare type GetJobEnvironmentOptions = {
|
|
15
|
-
/** Which secrets to display - if set to `this` only the group's secrets are displayed, if set to `inherited` only secrets from linked addons are displayed, if set to `all` or not provided, both are displayed. */
|
|
16
|
-
'show'?: string;
|
|
17
|
-
};
|
|
18
|
-
/** Returns the environment variables for the given job. */
|
|
19
|
-
export declare class GetJobEnvironmentEndpoint extends GetApiEndpoint<GetJobEnvironmentRequest, GetJobEnvironmentResult> {
|
|
20
|
-
description: string;
|
|
21
|
-
withAuth: boolean;
|
|
22
|
-
endpointUrl: (opts: GetJobEnvironmentRequest) => string;
|
|
23
|
-
body: () => undefined;
|
|
24
|
-
}
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.GetJobEnvironmentEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../../api-endpoint");
|
|
21
|
-
/** Returns the environment variables for the given job. */
|
|
22
|
-
var GetJobEnvironmentEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(GetJobEnvironmentEndpoint, _super);
|
|
24
|
-
function GetJobEnvironmentEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Returns the environment variables for the given job.';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
var _a;
|
|
30
|
-
var optionEntries = Object.entries((_a = opts === null || opts === void 0 ? void 0 : opts.options) !== null && _a !== void 0 ? _a : {});
|
|
31
|
-
var optionStr = optionEntries.length > 0 ? '?' + optionEntries.map(function (a) { return a[0] + '=' + a[1]; }).join('&') : '';
|
|
32
|
-
return ("/v1/projects/" + opts.parameters.projectId + "/jobs/" + opts.parameters.jobId + "/environment" +
|
|
33
|
-
optionStr);
|
|
34
|
-
};
|
|
35
|
-
_this.body = function () { return undefined; };
|
|
36
|
-
return _this;
|
|
37
|
-
}
|
|
38
|
-
return GetJobEnvironmentEndpoint;
|
|
39
|
-
}(api_endpoint_1.GetApiEndpoint));
|
|
40
|
-
exports.GetJobEnvironmentEndpoint = GetJobEnvironmentEndpoint;
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
|
|
3
|
-
export declare type GetJobEnvironmentdetailsResult = {
|
|
4
|
-
/** A stored variable and details about it and its value. This can have the name of any saved variable. */
|
|
5
|
-
'MY_VARIABLE_NAME'?: {
|
|
6
|
-
/** The value of the variable. Example: "abcdef123456" */
|
|
7
|
-
'value': any;
|
|
8
|
-
/** The ID of the secret group the variable is inherited from, if applicable. Example: "example-secret" */
|
|
9
|
-
'inheritedFrom'?: string;
|
|
10
|
-
/** The ID of the addon the variable is inherited from, if applicable. Example: "example-addon" */
|
|
11
|
-
'addonId'?: string;
|
|
12
|
-
/** The priority of the secret group the variable is inherited from, if applicable. Example: 10 */
|
|
13
|
-
'priority'?: number;
|
|
14
|
-
/** An array containing data about other places the variable has been inherited from, but that are not being used as a variable with the same key is found with a higher priority. */
|
|
15
|
-
'overriding': {
|
|
16
|
-
/** The value of the variable. Example: "ffffffffffff" */
|
|
17
|
-
'value': any;
|
|
18
|
-
/** The ID of the secret group the variable is inherited from. Example: "secret-2" */
|
|
19
|
-
'inheritedFrom': string;
|
|
20
|
-
/** The ID of the addon the variable is inherited from, if applicable. Example: "addon-2" */
|
|
21
|
-
'addonId'?: string;
|
|
22
|
-
/** The priority of the secret group the variable is inherited from. */
|
|
23
|
-
'priority': number;
|
|
24
|
-
}[];
|
|
25
|
-
};
|
|
26
|
-
};
|
|
27
|
-
export declare type GetJobEnvironmentdetailsCall = (opts: GetJobEnvironmentdetailsRequest) => Promise<ApiCallResponse<GetJobEnvironmentdetailsResult>>;
|
|
28
|
-
export declare type GetJobEnvironmentdetailsRequest = {
|
|
29
|
-
parameters: GetJobEnvironmentdetailsParameters;
|
|
30
|
-
};
|
|
31
|
-
export declare type GetJobEnvironmentdetailsParameters = {
|
|
32
|
-
/** ID of the project */ 'projectId': string;
|
|
33
|
-
/** ID of the job */
|
|
34
|
-
'jobId': string;
|
|
35
|
-
};
|
|
36
|
-
/** Get details about the environment variables accessible by the given job. */
|
|
37
|
-
export declare class GetJobEnvironmentdetailsEndpoint extends GetApiEndpoint<GetJobEnvironmentdetailsRequest, GetJobEnvironmentdetailsResult> {
|
|
38
|
-
description: string;
|
|
39
|
-
withAuth: boolean;
|
|
40
|
-
endpointUrl: (opts: GetJobEnvironmentdetailsRequest) => string;
|
|
41
|
-
body: () => undefined;
|
|
42
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.GetJobEnvironmentdetailsEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../../api-endpoint");
|
|
21
|
-
/** Get details about the environment variables accessible by the given job. */
|
|
22
|
-
var GetJobEnvironmentdetailsEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(GetJobEnvironmentdetailsEndpoint, _super);
|
|
24
|
-
function GetJobEnvironmentdetailsEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Get details about the environment variables accessible by the given job.';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
return "/v1/projects/" + opts.parameters.projectId + "/jobs/" + opts.parameters.jobId + "/environment/details";
|
|
30
|
-
};
|
|
31
|
-
_this.body = function () { return undefined; };
|
|
32
|
-
return _this;
|
|
33
|
-
}
|
|
34
|
-
return GetJobEnvironmentdetailsEndpoint;
|
|
35
|
-
}(api_endpoint_1.GetApiEndpoint));
|
|
36
|
-
exports.GetJobEnvironmentdetailsEndpoint = GetJobEnvironmentdetailsEndpoint;
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
|
|
3
|
-
export declare type GetJobHealthchecksResult = {
|
|
4
|
-
/** An array of health checks. */
|
|
5
|
-
'healthChecks': {
|
|
6
|
-
/** The protocol to access the health check with. Example: "HTTP" */
|
|
7
|
-
'protocol': 'HTTP' | 'CMD';
|
|
8
|
-
/** The type of health check. Example: "readinessProbe" */
|
|
9
|
-
'type': 'livenessProbe' | 'readinessProbe';
|
|
10
|
-
/** The path of the health check endpoint. Example: "/health-check" */
|
|
11
|
-
'path'?: string;
|
|
12
|
-
/** The command to run for the health check. */
|
|
13
|
-
'cmd'?: any;
|
|
14
|
-
/** HTTP port number for the health check endpoint. Example: 3000 */
|
|
15
|
-
'httpPort'?: any;
|
|
16
|
-
/** TCP port number for the health check endpoint. */
|
|
17
|
-
'tcpSocketPort'?: any;
|
|
18
|
-
/** Initial delay, in seconds, before the health check is first run. Example: 10 */
|
|
19
|
-
'initialDelaySeconds': number;
|
|
20
|
-
/** The time between each check, in seconds. Example: 60 */
|
|
21
|
-
'periodSeconds': number;
|
|
22
|
-
'timeoutSeconds': number;
|
|
23
|
-
/** The maximum number of allowed failures. Example: 3 */
|
|
24
|
-
'failureThreshold': number;
|
|
25
|
-
/** The number of successes required to mark the health check as a success. Example: 1 */
|
|
26
|
-
'successThreshold'?: any;
|
|
27
|
-
}[];
|
|
28
|
-
};
|
|
29
|
-
export declare type GetJobHealthchecksCall = (opts: GetJobHealthchecksRequest) => Promise<ApiCallResponse<GetJobHealthchecksResult>>;
|
|
30
|
-
export declare type GetJobHealthchecksRequest = {
|
|
31
|
-
parameters: GetJobHealthchecksParameters;
|
|
32
|
-
};
|
|
33
|
-
export declare type GetJobHealthchecksParameters = {
|
|
34
|
-
/** ID of the project */ 'projectId': string;
|
|
35
|
-
/** ID of the job */
|
|
36
|
-
'jobId': string;
|
|
37
|
-
};
|
|
38
|
-
/** Lists the health checks for the given job. */
|
|
39
|
-
export declare class GetJobHealthchecksEndpoint extends GetApiEndpoint<GetJobHealthchecksRequest, GetJobHealthchecksResult> {
|
|
40
|
-
description: string;
|
|
41
|
-
withAuth: boolean;
|
|
42
|
-
endpointUrl: (opts: GetJobHealthchecksRequest) => string;
|
|
43
|
-
body: () => undefined;
|
|
44
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.GetJobHealthchecksEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../../api-endpoint");
|
|
21
|
-
/** Lists the health checks for the given job. */
|
|
22
|
-
var GetJobHealthchecksEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(GetJobHealthchecksEndpoint, _super);
|
|
24
|
-
function GetJobHealthchecksEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Lists the health checks for the given job.';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
return "/v1/projects/" + opts.parameters.projectId + "/jobs/" + opts.parameters.jobId + "/health-checks";
|
|
30
|
-
};
|
|
31
|
-
_this.body = function () { return undefined; };
|
|
32
|
-
return _this;
|
|
33
|
-
}
|
|
34
|
-
return GetJobHealthchecksEndpoint;
|
|
35
|
-
}(api_endpoint_1.GetApiEndpoint));
|
|
36
|
-
exports.GetJobHealthchecksEndpoint = GetJobHealthchecksEndpoint;
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
|
|
3
|
-
export declare type GetJobRunResult = {
|
|
4
|
-
/** The ID of the job run Example: "d34582a4-35bd-4c71-8e7c-e36999b88723" */
|
|
5
|
-
'id': string;
|
|
6
|
-
/** Whether the run is currently in progress */
|
|
7
|
-
'active': number;
|
|
8
|
-
/** The number of attempts to retry this job run before it is marked as failed. */
|
|
9
|
-
'backoffLimit': number;
|
|
10
|
-
/** The number of times this job run has concluded successfully or with an error. Example: 1 */
|
|
11
|
-
'completions': number;
|
|
12
|
-
/** Has the job run finished? Example: true */
|
|
13
|
-
'concluded': boolean;
|
|
14
|
-
/** Whether this job run failed to complete successfully */
|
|
15
|
-
'failed': number;
|
|
16
|
-
/** The name of the job run Example: "example-job-5fcf67bc56e1913e21d49504" */
|
|
17
|
-
'runName': string;
|
|
18
|
-
/** A string representing the status of the job. Either SUCCESS, RUNNING or FAILED Example: "SUCCESS" */
|
|
19
|
-
'status': 'SUCCESS' | 'RUNNING' | 'FAILED';
|
|
20
|
-
/** Whether this job run completed successfully */
|
|
21
|
-
'succeeded': number;
|
|
22
|
-
/** The timestamp when the job run started. Example: "2020-12-08T11:47:08Z" */
|
|
23
|
-
'startedAt': string;
|
|
24
|
-
};
|
|
25
|
-
export declare type GetJobRunCall = (opts: GetJobRunRequest) => Promise<ApiCallResponse<GetJobRunResult>>;
|
|
26
|
-
export declare type GetJobRunRequest = {
|
|
27
|
-
parameters: GetJobRunParameters;
|
|
28
|
-
};
|
|
29
|
-
export declare type GetJobRunParameters = {
|
|
30
|
-
/** ID of the project */ 'projectId': string;
|
|
31
|
-
/** ID of the job */
|
|
32
|
-
'jobId': string;
|
|
33
|
-
/** ID of the job run */
|
|
34
|
-
'runId': string;
|
|
35
|
-
};
|
|
36
|
-
/** Returns data about the given job run */
|
|
37
|
-
export declare class GetJobRunEndpoint extends GetApiEndpoint<GetJobRunRequest, GetJobRunResult> {
|
|
38
|
-
description: string;
|
|
39
|
-
withAuth: boolean;
|
|
40
|
-
endpointUrl: (opts: GetJobRunRequest) => string;
|
|
41
|
-
body: () => undefined;
|
|
42
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.GetJobRunEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../../api-endpoint");
|
|
21
|
-
/** Returns data about the given job run */
|
|
22
|
-
var GetJobRunEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(GetJobRunEndpoint, _super);
|
|
24
|
-
function GetJobRunEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Returns data about the given job run';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
return "/v1/projects/" + opts.parameters.projectId + "/jobs/" + opts.parameters.jobId + "/runs/" + opts.parameters.runId;
|
|
30
|
-
};
|
|
31
|
-
_this.body = function () { return undefined; };
|
|
32
|
-
return _this;
|
|
33
|
-
}
|
|
34
|
-
return GetJobRunEndpoint;
|
|
35
|
-
}(api_endpoint_1.GetApiEndpoint));
|
|
36
|
-
exports.GetJobRunEndpoint = GetJobRunEndpoint;
|
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
2
|
-
import { ApiCallResponse, GetApiEndpoint } from '../../../api-endpoint';
|
|
3
|
-
export declare type GetJobRunsResult = {
|
|
4
|
-
/** An array of job run objects. */
|
|
5
|
-
'runs': {
|
|
6
|
-
/** The ID of the job run Example: "d34582a4-35bd-4c71-8e7c-e36999b88723" */
|
|
7
|
-
'id': string;
|
|
8
|
-
/** Whether the run is currently in progress */
|
|
9
|
-
'active': number;
|
|
10
|
-
/** The number of attempts to retry this job run before it is marked as failed. */
|
|
11
|
-
'backoffLimit': number;
|
|
12
|
-
/** The number of times this job run has concluded successfully or with an error. Example: 1 */
|
|
13
|
-
'completions': number;
|
|
14
|
-
/** Has the job run finished? Example: true */
|
|
15
|
-
'concluded': boolean;
|
|
16
|
-
/** Whether this job run failed to complete successfully */
|
|
17
|
-
'failed': number;
|
|
18
|
-
/** The name of the job run Example: "example-job-5fcf67bc56e1913e21d49504" */
|
|
19
|
-
'runName': string;
|
|
20
|
-
/** A string representing the status of the job. Either SUCCESS, RUNNING or FAILED Example: "SUCCESS" */
|
|
21
|
-
'status': 'SUCCESS' | 'RUNNING' | 'FAILED';
|
|
22
|
-
/** Whether this job run completed successfully */
|
|
23
|
-
'succeeded': number;
|
|
24
|
-
/** The timestamp when the job run started. Example: "2020-12-08T11:47:08Z" */
|
|
25
|
-
'startedAt': string;
|
|
26
|
-
}[];
|
|
27
|
-
};
|
|
28
|
-
export declare type GetJobRunsCall = (opts: GetJobRunsRequest) => Promise<ApiCallResponse<GetJobRunsResult>>;
|
|
29
|
-
export declare type GetJobRunsRequest = {
|
|
30
|
-
parameters: GetJobRunsParameters;
|
|
31
|
-
options?: GetJobRunsOptions;
|
|
32
|
-
};
|
|
33
|
-
export declare type GetJobRunsParameters = {
|
|
34
|
-
/** ID of the project */ 'projectId': string;
|
|
35
|
-
/** ID of the job */
|
|
36
|
-
'jobId': string;
|
|
37
|
-
};
|
|
38
|
-
export declare type GetJobRunsOptions = {
|
|
39
|
-
/** The number of results to display per request. Maximum of 100 results per page. */
|
|
40
|
-
'per_page'?: number;
|
|
41
|
-
/** The page number to access. */
|
|
42
|
-
'page'?: number;
|
|
43
|
-
/** The cursor returned from the previous page of results, used to request the next page. */
|
|
44
|
-
'cursor'?: string;
|
|
45
|
-
};
|
|
46
|
-
/** Fetches run history for the given job */
|
|
47
|
-
export declare class GetJobRunsEndpoint extends GetApiEndpoint<GetJobRunsRequest, GetJobRunsResult> {
|
|
48
|
-
description: string;
|
|
49
|
-
withAuth: boolean;
|
|
50
|
-
endpointUrl: (opts: GetJobRunsRequest) => string;
|
|
51
|
-
body: () => undefined;
|
|
52
|
-
}
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/** WARNING: Autogenerated Code - do not modify! */
|
|
3
|
-
var __extends = (this && this.__extends) || (function () {
|
|
4
|
-
var extendStatics = function (d, b) {
|
|
5
|
-
extendStatics = Object.setPrototypeOf ||
|
|
6
|
-
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
7
|
-
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
8
|
-
return extendStatics(d, b);
|
|
9
|
-
};
|
|
10
|
-
return function (d, b) {
|
|
11
|
-
if (typeof b !== "function" && b !== null)
|
|
12
|
-
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
13
|
-
extendStatics(d, b);
|
|
14
|
-
function __() { this.constructor = d; }
|
|
15
|
-
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
16
|
-
};
|
|
17
|
-
})();
|
|
18
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.GetJobRunsEndpoint = void 0;
|
|
20
|
-
var api_endpoint_1 = require("../../../api-endpoint");
|
|
21
|
-
/** Fetches run history for the given job */
|
|
22
|
-
var GetJobRunsEndpoint = /** @class */ (function (_super) {
|
|
23
|
-
__extends(GetJobRunsEndpoint, _super);
|
|
24
|
-
function GetJobRunsEndpoint() {
|
|
25
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
26
|
-
_this.description = 'Fetches run history for the given job';
|
|
27
|
-
_this.withAuth = true;
|
|
28
|
-
_this.endpointUrl = function (opts) {
|
|
29
|
-
var _a;
|
|
30
|
-
var optionEntries = Object.entries((_a = opts === null || opts === void 0 ? void 0 : opts.options) !== null && _a !== void 0 ? _a : {});
|
|
31
|
-
var optionStr = optionEntries.length > 0 ? '?' + optionEntries.map(function (a) { return a[0] + '=' + a[1]; }).join('&') : '';
|
|
32
|
-
return ("/v1/projects/" + opts.parameters.projectId + "/jobs/" + opts.parameters.jobId + "/runs" + optionStr);
|
|
33
|
-
};
|
|
34
|
-
_this.body = function () { return undefined; };
|
|
35
|
-
return _this;
|
|
36
|
-
}
|
|
37
|
-
return GetJobRunsEndpoint;
|
|
38
|
-
}(api_endpoint_1.GetApiEndpoint));
|
|
39
|
-
exports.GetJobRunsEndpoint = GetJobRunsEndpoint;
|