@qlik/api 2.2.0 → 2.3.1
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/analytics/change-stores.d.ts +386 -0
- package/analytics/change-stores.js +123 -0
- package/analytics.d.ts +14 -0
- package/analytics.js +13 -0
- package/api-keys.d.ts +362 -3
- package/api-keys.js +2 -3
- package/apps.d.ts +2673 -3
- package/apps.js +2 -3
- package/assistants.d.ts +1370 -3
- package/assistants.js +2 -3
- package/audits.d.ts +318 -3
- package/audits.js +4 -4
- package/auth-types.d.ts +1 -1
- package/auth-types.js +1 -2
- package/auth.d.ts +94 -2
- package/auth.js +63 -3
- package/automation-connections.d.ts +366 -3
- package/automation-connections.js +2 -3
- package/automation-connectors.d.ts +84 -3
- package/automation-connectors.js +2 -3
- package/automations.d.ts +805 -3
- package/automations.js +2 -3
- package/automl-deployments.d.ts +101 -3
- package/automl-deployments.js +2 -3
- package/automl-predictions.d.ts +238 -3
- package/automl-predictions.js +2 -3
- package/banners.d.ts +184 -3
- package/banners.js +2 -3
- package/brands.d.ts +670 -3
- package/brands.js +2 -3
- package/chunks/auth-XusKk8IA.js +32 -0
- package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
- package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
- package/chunks/{auth-functions-BmZgZYSs.js → interceptors-2VSXImC9.js} +498 -146
- package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-CckTK7bh.js} +3 -3
- package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-D9lpiAb-.js} +1 -5
- package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-BqxAMJ9M.js} +7 -7
- package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
- package/chunks/{qix-DjxuPCX0.js → qix-DpvHvpx7.js} +11 -10
- package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-BXZPnE6J.js} +48 -50
- package/collections.d.ts +582 -3
- package/collections.js +2 -3
- package/conditions.d.ts +662 -3
- package/conditions.js +2 -3
- package/consumption.d.ts +182 -3
- package/consumption.js +2 -3
- package/core/ip-policies.d.ts +328 -4
- package/core/ip-policies.js +108 -5
- package/core.d.ts +13 -4
- package/core.js +3 -4
- package/csp-origins.d.ts +273 -3
- package/csp-origins.js +2 -3
- package/csrf-token.d.ts +62 -3
- package/csrf-token.js +2 -3
- package/data-alerts.d.ts +1004 -3
- package/data-alerts.js +2 -3
- package/data-assets.d.ts +207 -3
- package/data-assets.js +2 -3
- package/data-connections.d.ts +678 -3
- package/data-connections.js +2 -3
- package/data-credentials.d.ts +292 -3
- package/data-credentials.js +2 -3
- package/data-files.d.ts +860 -3
- package/data-files.js +2 -3
- package/data-qualities.d.ts +175 -3
- package/data-qualities.js +2 -3
- package/data-sets.d.ts +424 -3
- package/data-sets.js +2 -3
- package/data-sources.d.ts +348 -3
- package/data-sources.js +2 -3
- package/data-stores.d.ts +537 -3
- package/data-stores.js +2 -3
- package/dcaas.d.ts +192 -3
- package/dcaas.js +2 -3
- package/di-projects.d.ts +812 -4
- package/di-projects.js +25 -4
- package/direct-access-agents.d.ts +710 -4
- package/direct-access-agents.js +37 -5
- package/docs/authentication.md +1 -1
- package/encryption.d.ts +372 -3
- package/encryption.js +2 -3
- package/extensions.d.ts +295 -3
- package/extensions.js +2 -3
- package/global-types.d.ts +1 -1
- package/global-types.js +0 -2
- package/glossaries.d.ts +1223 -3
- package/glossaries.js +2 -3
- package/groups.d.ts +510 -3
- package/groups.js +2 -3
- package/identity-providers.d.ts +711 -3
- package/identity-providers.js +2 -3
- package/index.d.ts +78 -69
- package/index.js +28 -10
- package/interceptors.d.ts +52 -3
- package/interceptors.js +1 -2
- package/invoke-fetch-types.d.ts +1 -1
- package/items.d.ts +536 -3
- package/items.js +2 -3
- package/knowledgebases.d.ts +976 -3
- package/knowledgebases.js +2 -3
- package/licenses.d.ts +663 -3
- package/licenses.js +2 -3
- package/lineage-graphs.d.ts +704 -3
- package/lineage-graphs.js +2 -3
- package/ml.d.ts +2808 -3
- package/ml.js +2 -3
- package/notes.d.ts +110 -3
- package/notes.js +2 -3
- package/notifications.d.ts +98 -3
- package/notifications.js +2 -3
- package/oauth-callback.iife.js +1151 -0
- package/oauth-clients.d.ts +562 -3
- package/oauth-clients.js +2 -3
- package/oauth-tokens.d.ts +126 -3
- package/oauth-tokens.js +2 -3
- package/package.json +5 -4
- package/qix.d.ts +3 -3
- package/qix.js +38 -3
- package/questions.d.ts +364 -3
- package/questions.js +2 -3
- package/quotas.d.ts +112 -3
- package/quotas.js +2 -3
- package/reload-tasks.d.ts +249 -3
- package/reload-tasks.js +2 -3
- package/reloads.d.ts +260 -3
- package/reloads.js +2 -3
- package/report-templates.d.ts +287 -3
- package/report-templates.js +2 -3
- package/reports.d.ts +863 -3
- package/reports.js +2 -3
- package/roles.d.ts +312 -3
- package/roles.js +2 -3
- package/sharing-tasks.d.ts +1164 -3
- package/sharing-tasks.js +2 -3
- package/spaces.d.ts +779 -3
- package/spaces.js +2 -3
- package/tasks.d.ts +564 -3
- package/tasks.js +2 -3
- package/temp-contents.d.ts +167 -3
- package/temp-contents.js +2 -3
- package/tenants.d.ts +360 -3
- package/tenants.js +2 -3
- package/themes.d.ts +270 -3
- package/themes.js +2 -3
- package/transports.d.ts +435 -4
- package/transports.js +20 -5
- package/ui-config.d.ts +274 -3
- package/ui-config.js +2 -3
- package/users.d.ts +674 -3
- package/users.js +2 -3
- package/web-integrations.d.ts +294 -3
- package/web-integrations.js +2 -3
- package/web-notifications.d.ts +273 -3
- package/web-notifications.js +2 -3
- package/webhooks.d.ts +505 -3
- package/webhooks.js +2 -3
- package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
- package/chunks/apps-BwpXUGDb.d.ts +0 -2673
- package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
- package/chunks/audits-DakwzT97.d.ts +0 -316
- package/chunks/auth-6mptVm5Q.d.ts +0 -95
- package/chunks/auth-Cle0_tmz.js +0 -32
- package/chunks/auth-D11iO7ZV.js +0 -65
- package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
- package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
- package/chunks/automations-BGy83EBO.d.ts +0 -797
- package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
- package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
- package/chunks/banners-CgBRnZGv.d.ts +0 -184
- package/chunks/brands-DCgk6Gqx.d.ts +0 -671
- package/chunks/collections-BpYjcpIY.d.ts +0 -582
- package/chunks/conditions-CJJG7Uph.d.ts +0 -662
- package/chunks/consumption-DerFk437.d.ts +0 -182
- package/chunks/core-DQXNZdnf.d.ts +0 -12
- package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
- package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
- package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
- package/chunks/data-assets-CJDcssoX.d.ts +0 -207
- package/chunks/data-connections-VSB13K6g.d.ts +0 -678
- package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
- package/chunks/data-files-CVzn9M6V.d.ts +0 -860
- package/chunks/data-qualities-DBrot957.d.ts +0 -176
- package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
- package/chunks/data-sources-IsAaof_C.d.ts +0 -346
- package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
- package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
- package/chunks/di-projects-DVQTxASr.d.ts +0 -777
- package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
- package/chunks/encryption-BjA6xbCO.d.ts +0 -372
- package/chunks/extensions-OO0WtInj.d.ts +0 -294
- package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
- package/chunks/groups-C86-UG7S.d.ts +0 -511
- package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
- package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
- package/chunks/interceptors-DTYm37AU.js +0 -104
- package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
- package/chunks/ip-policies-DXlf172B.js +0 -108
- package/chunks/items-C-jzqvFW.d.ts +0 -536
- package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
- package/chunks/licenses-xzjnkitW.d.ts +0 -663
- package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
- package/chunks/ml-Abt2MUva.d.ts +0 -2809
- package/chunks/notes-BZxuyDgt.d.ts +0 -111
- package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
- package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
- package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
- package/chunks/qix-CYQsLyGQ.js +0 -40
- package/chunks/questions-BVp0tvNs.d.ts +0 -364
- package/chunks/quotas-CfAebRJd.d.ts +0 -113
- package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
- package/chunks/reloads-CwmagnFx.d.ts +0 -260
- package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
- package/chunks/reports-DzNC6Uq3.d.ts +0 -861
- package/chunks/roles-BYFIY6E7.d.ts +0 -312
- package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
- package/chunks/spaces-BK823t-b.d.ts +0 -780
- package/chunks/tasks-COKDfShO.d.ts +0 -564
- package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
- package/chunks/tenants-Bhn86519.d.ts +0 -361
- package/chunks/themes-v9NbhiBo.d.ts +0 -269
- package/chunks/transports-CqEiFxD3.d.ts +0 -362
- package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
- package/chunks/users-BSOBU_fg.d.ts +0 -675
- package/chunks/web-integrations-MisPAHod.d.ts +0 -295
- package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
- package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
- /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
- /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
- /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
- /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
- /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
- /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
package/di-projects.d.ts
CHANGED
|
@@ -1,4 +1,812 @@
|
|
|
1
|
-
import "./chunks/auth-types-
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { S as DownloadableBlob, y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
|
|
2
|
+
import "./chunks/invoke-fetch-C1Z0RJYU.js";
|
|
3
|
+
|
|
4
|
+
//#region src/public/rest/di-projects.d.ts
|
|
5
|
+
type AsyncActionDetails = {
|
|
6
|
+
endTime?: string;
|
|
7
|
+
error?: AsyncActionError;
|
|
8
|
+
/** Name of the async operation */
|
|
9
|
+
name?: string;
|
|
10
|
+
startTime?: string;
|
|
11
|
+
/** State of the action */
|
|
12
|
+
state?: AsyncCallStatus;
|
|
13
|
+
taskDetails?: {
|
|
14
|
+
error?: AsyncActionError;
|
|
15
|
+
/** Additional details about task state */
|
|
16
|
+
info?: string;
|
|
17
|
+
name?: string;
|
|
18
|
+
/** State of the action */
|
|
19
|
+
state?: AsyncCallStatus;
|
|
20
|
+
taskId?: string;
|
|
21
|
+
}[];
|
|
22
|
+
taskProgress?: AsyncActionTaskProgress;
|
|
23
|
+
/** Type of action being performed */
|
|
24
|
+
type?: AsyncActionType;
|
|
25
|
+
};
|
|
26
|
+
type AsyncActionError = {
|
|
27
|
+
/** Error code */
|
|
28
|
+
code?: string;
|
|
29
|
+
/** Additional error details */
|
|
30
|
+
details?: string;
|
|
31
|
+
/** Error message */
|
|
32
|
+
message?: string;
|
|
33
|
+
};
|
|
34
|
+
type AsyncActionRsp = {
|
|
35
|
+
/** Identifier for tracking the action */
|
|
36
|
+
actionId: string;
|
|
37
|
+
};
|
|
38
|
+
type AsyncActionTaskProgress = {
|
|
39
|
+
/** Number of tasks canceled */
|
|
40
|
+
canceled?: number;
|
|
41
|
+
/** Number of tasks completed successfully */
|
|
42
|
+
completed?: number;
|
|
43
|
+
/** Number of tasks currently executing */
|
|
44
|
+
executing?: number;
|
|
45
|
+
/** Number of tasks that failed */
|
|
46
|
+
failed?: number;
|
|
47
|
+
/** Number of tasks pending execution */
|
|
48
|
+
pending?: number;
|
|
49
|
+
/** Number of tasks skipped due to conflicts */
|
|
50
|
+
skipped?: number;
|
|
51
|
+
};
|
|
52
|
+
/**
|
|
53
|
+
* Type of action being performed
|
|
54
|
+
*/
|
|
55
|
+
type AsyncActionType = "PROJECT_PREPARE" | "PROJECT_VALIDATE" | "TASK_PREPARE" | "TASK_VALIDATE";
|
|
56
|
+
/**
|
|
57
|
+
* State of the action
|
|
58
|
+
*/
|
|
59
|
+
type AsyncCallStatus = "PENDING" | "EXECUTING" | "COMPLETED" | "FAILED" | "CANCELED" | "SKIPPED";
|
|
60
|
+
type CreateDiProjectReq = {
|
|
61
|
+
/** The cloud staging connection string */
|
|
62
|
+
cloudStagingConnection?: string;
|
|
63
|
+
/** A description of the project */
|
|
64
|
+
description?: string;
|
|
65
|
+
/** The name of the project */
|
|
66
|
+
name?: string;
|
|
67
|
+
/** The platform connection string */
|
|
68
|
+
platformConnection?: string;
|
|
69
|
+
/** The platform type of the project. Supported values: - SNOWFLAKE: Snowflake - BIGQUERY: Google BigQuery - SYNAPSE: Azure Synapse - DATABRICKS: Databricks - REDSHIFT: Amazon Redshift - MSSQL: Microsoft SQL Server - FABRIC: Microsoft Fabric (OneLake) - QLIK_QVD: Qlik-managed QVD - QLIK_QVD_CUSTOMER_MANAGED: Customer-managed QVD */
|
|
70
|
+
platformType?: "SNOWFLAKE" | "BIGQUERY" | "SYNAPSE" | "DATABRICKS" | "REDSHIFT" | "MSSQL" | "FABRIC" | "QLIK_QVD" | "QLIK_QVD_CUSTOMER_MANAGED";
|
|
71
|
+
/** The ID of the space where the project will be created */
|
|
72
|
+
space?: string;
|
|
73
|
+
/** The type of the project */
|
|
74
|
+
type?: "DATA_PIPELINE" | "DATA_MOVEMENT";
|
|
75
|
+
};
|
|
76
|
+
type DataTaskDatasetState = {
|
|
77
|
+
cdcStatus?: {
|
|
78
|
+
/** Number of DDL statements executed during the last run */
|
|
79
|
+
ddlCount?: number;
|
|
80
|
+
/** delete portion of totalProcessedCount. Only available for some task types */
|
|
81
|
+
deleteCount?: number;
|
|
82
|
+
/** Insert portion of totalProcessedCount. Only available for some task types */
|
|
83
|
+
insertCount?: number;
|
|
84
|
+
lastProcessed?: string;
|
|
85
|
+
message?: string;
|
|
86
|
+
state?: "QUEUED" | "PROCESSING" | "ACCUMULATING_CHANGES" | "COMPLETED" | "ERROR";
|
|
87
|
+
/** Total number of changes/DMLs applied to the dataset */
|
|
88
|
+
totalProcessedCount?: number;
|
|
89
|
+
/** update portion of totalProcessedCount. Only available for some task types */
|
|
90
|
+
updateCount?: number;
|
|
91
|
+
};
|
|
92
|
+
/** Is the data ready for use? */
|
|
93
|
+
dataReadiness?: "READY" | "NOT_READY" | "ERROR";
|
|
94
|
+
/** Id of the dataset */
|
|
95
|
+
datasetId?: string;
|
|
96
|
+
fullLoad?: {
|
|
97
|
+
/** Number of changes captured and cached during full load (CDC landing/replication tasks only) */
|
|
98
|
+
cachedChangesCount?: number;
|
|
99
|
+
/** Duration in HH:MM:SS format (hours:minutes:seconds) */
|
|
100
|
+
duration?: string;
|
|
101
|
+
endTime?: string;
|
|
102
|
+
/** Number of records that failed to load (currently only for knowledge marts) */
|
|
103
|
+
failedRecordsCount?: number;
|
|
104
|
+
message?: string;
|
|
105
|
+
startTime?: string;
|
|
106
|
+
state?: "QUEUED" | "LOADING" | "COMPLETED" | "ERROR";
|
|
107
|
+
/** Number of records (or docs in knowledge marts) were loaded. */
|
|
108
|
+
totalProcessedCount?: number;
|
|
109
|
+
};
|
|
110
|
+
lastBatchOfChanges?: {
|
|
111
|
+
/** Duration in HH:MM:SS format (hours:minutes:seconds) */
|
|
112
|
+
duration?: string;
|
|
113
|
+
endTime?: string;
|
|
114
|
+
message?: string;
|
|
115
|
+
startTime?: string;
|
|
116
|
+
state?: "QUEUED" | "PROCESSING" | "COMPLETED" | "ERROR";
|
|
117
|
+
/** Throughput in records per second */
|
|
118
|
+
throughputInRecordsPerSecond?: number;
|
|
119
|
+
totalProcessedCount?: number;
|
|
120
|
+
};
|
|
121
|
+
/** Name of the dataset */
|
|
122
|
+
name?: string;
|
|
123
|
+
/** Original name of the dataset, relevant only for data movement tasks */
|
|
124
|
+
sourceName?: string;
|
|
125
|
+
};
|
|
126
|
+
type DataTaskInstanceState = {
|
|
127
|
+
cdcStatus?: {
|
|
128
|
+
accumulatingChangesCount?: number;
|
|
129
|
+
applyingChangesCount?: number;
|
|
130
|
+
/** Duration in HH:MM:SS format (hours:minutes:seconds) */
|
|
131
|
+
latency?: string;
|
|
132
|
+
/** Throughput in kilobytes per second */
|
|
133
|
+
throughputInKilobytesPerSecond?: number;
|
|
134
|
+
totalProcessedCount?: number;
|
|
135
|
+
};
|
|
136
|
+
/** Duration in HH:MM:SS format (hours:minutes:seconds) */
|
|
137
|
+
duration?: string;
|
|
138
|
+
/** Timestamp indicating when the task instance ended */
|
|
139
|
+
endTime?: string;
|
|
140
|
+
fullLoad?: {
|
|
141
|
+
/** Number of datasets that have completed full load in this task run */
|
|
142
|
+
completedCount?: number;
|
|
143
|
+
/** Number of datasets that have failed full load in this task run */
|
|
144
|
+
errorCount?: number;
|
|
145
|
+
/** Number of datasets that are currently being loaded in this task run */
|
|
146
|
+
loadingCount?: number;
|
|
147
|
+
/** Number of datasets that are queued for full load in this task run */
|
|
148
|
+
queuedCount?: number;
|
|
149
|
+
};
|
|
150
|
+
general?: {
|
|
151
|
+
/** The latest point in time the data reflects, based on updates from the source system. */
|
|
152
|
+
dataTaskUpdatedTo?: string;
|
|
153
|
+
/** Total number of datasets produced by the task, including ones in error */
|
|
154
|
+
datasetCount?: number;
|
|
155
|
+
/** Count of datasets that encountered errors */
|
|
156
|
+
datasetsInErrorCount?: number;
|
|
157
|
+
/** For tasks that run on a gateway, this is the id of the gateway */
|
|
158
|
+
gatewayId?: string;
|
|
159
|
+
/** For tasks that run on a gateway, this is the name of the gateway */
|
|
160
|
+
gatewayName?: string;
|
|
161
|
+
/** For tasks that run on a gateway, this is the internal name of the task on the gateway */
|
|
162
|
+
gatewayTaskName?: string;
|
|
163
|
+
/** For lakehouse storage tasks, this is the name of the cluster where the task runs */
|
|
164
|
+
lakehouseClusterName?: string;
|
|
165
|
+
/** The latest point in time the live views reflect, based on updates from the source system. */
|
|
166
|
+
liveViewsUpdatedTo?: string;
|
|
167
|
+
};
|
|
168
|
+
lastBatchOfChanges?: {
|
|
169
|
+
/** This batch starts with operational source changes from this time. */
|
|
170
|
+
relatesToRecordsFrom?: string;
|
|
171
|
+
/** This batch ends with operational source changes from this time. */
|
|
172
|
+
relatesToRecordsTo?: string;
|
|
173
|
+
/** Throughput in records per second */
|
|
174
|
+
throughputInRecordsPerSecond?: number;
|
|
175
|
+
totalProcessedCount?: number;
|
|
176
|
+
};
|
|
177
|
+
message?: string;
|
|
178
|
+
/** Timestamp indicating when the task instance started */
|
|
179
|
+
startTime?: string;
|
|
180
|
+
state?: "STARTING" | "RUNNING" | "COMPLETED" | "FAILED" | "CANCELED" | "STOPPING";
|
|
181
|
+
};
|
|
182
|
+
type DataTaskItemRsp = {
|
|
183
|
+
description?: string;
|
|
184
|
+
id?: string;
|
|
185
|
+
name?: string;
|
|
186
|
+
ownerId?: string;
|
|
187
|
+
spaceId?: string;
|
|
188
|
+
type?: DataTaskType;
|
|
189
|
+
};
|
|
190
|
+
type DataTaskRuntimeState = {
|
|
191
|
+
lastRun?: DataTaskInstanceState;
|
|
192
|
+
/** Name of the data task */
|
|
193
|
+
name?: string;
|
|
194
|
+
runReadiness?: {
|
|
195
|
+
message?: string;
|
|
196
|
+
state?: "READY_TO_RUN" | "ALREADY_RUNNING" | "NOT_RUNNABLE";
|
|
197
|
+
};
|
|
198
|
+
type?: DataTaskType;
|
|
199
|
+
};
|
|
200
|
+
type DataTaskType = "LANDING" | "STORAGE" | "QVD_STORAGE" | "TRANSFORM" | "DATAMART" | "REGISTERED_DATA" | "REPLICATION" | "DISTRIBUTION" | "LAKE_LANDING" | "KNOWLEDGE_MART" | "FILE_BASED_KNOWLEDGE_MART" | "LAKEHOUSE_STORAGE" | "LAKEHOUSE_MIRROR";
|
|
201
|
+
type DiProjectItemRsp = {
|
|
202
|
+
description?: string;
|
|
203
|
+
id?: string;
|
|
204
|
+
name?: string;
|
|
205
|
+
ownerId?: string;
|
|
206
|
+
spaceId?: string;
|
|
207
|
+
};
|
|
208
|
+
type DiProjectOperationSelectedTask = {
|
|
209
|
+
/** Task identifier */
|
|
210
|
+
taskId: string;
|
|
211
|
+
};
|
|
212
|
+
type Error = {
|
|
213
|
+
code?: string;
|
|
214
|
+
detail?: string;
|
|
215
|
+
source?: ErrorSource;
|
|
216
|
+
status?: number;
|
|
217
|
+
title?: string;
|
|
218
|
+
};
|
|
219
|
+
type ErrorSource = {
|
|
220
|
+
parameter?: string;
|
|
221
|
+
pointer?: string;
|
|
222
|
+
};
|
|
223
|
+
type Errors = {
|
|
224
|
+
errors?: Error[];
|
|
225
|
+
traceId?: string;
|
|
226
|
+
};
|
|
227
|
+
type ExportDiProjectReq = {
|
|
228
|
+
/** Include bindings in the exported zip file (optional, default is false) */
|
|
229
|
+
includeBindings?: boolean;
|
|
230
|
+
};
|
|
231
|
+
type GetDiExportProjectVariablesRsp = {
|
|
232
|
+
nameToIdMap?: Record<string, string>;
|
|
233
|
+
variables?: Record<string, string>;
|
|
234
|
+
};
|
|
235
|
+
type ImportDiProjectRsp = unknown;
|
|
236
|
+
type ListDataTasksRsp = {
|
|
237
|
+
dataTasks?: DataTaskItemRsp[];
|
|
238
|
+
};
|
|
239
|
+
type ListDiProjectsRsp = {
|
|
240
|
+
projects?: DiProjectItemRsp[];
|
|
241
|
+
};
|
|
242
|
+
type PrepareProjectReq = {
|
|
243
|
+
allowRecreate?: boolean;
|
|
244
|
+
/** Array of tasks to prepare. Leave empty to trigger project-level orchestration using built-in logic (same as in the user interface). */
|
|
245
|
+
selectedTasks?: TaskSelectionList;
|
|
246
|
+
};
|
|
247
|
+
type PrepareTaskReq = {
|
|
248
|
+
/** Allow recreation of existing artifacts */
|
|
249
|
+
allowRecreate: boolean;
|
|
250
|
+
};
|
|
251
|
+
type ReloadDiTaskReq = {
|
|
252
|
+
/** Reload strategy (optional, applies to materialized SQL transformations and transformation flows tasks) */
|
|
253
|
+
reloadStrategy?: "NONE" | "TRUNCATE" | "COMPARE_AND_APPLY";
|
|
254
|
+
/** Datasets to reload (optional, if omitted or empty, all datasets will be reloaded). */
|
|
255
|
+
selectedDatasets?: {
|
|
256
|
+
datasetId?: string;
|
|
257
|
+
}[];
|
|
258
|
+
};
|
|
259
|
+
/**
|
|
260
|
+
* Indicates whether the reload request was registered successfully.
|
|
261
|
+
*/
|
|
262
|
+
type ReloadRequestResponse = {
|
|
263
|
+
/** Always true when the server successfully registers the request. */
|
|
264
|
+
success: boolean;
|
|
265
|
+
};
|
|
266
|
+
type StartTaskReq = {
|
|
267
|
+
/** Task run option for the task (optional, applies to Replication tasks only). */
|
|
268
|
+
option?: "PROCESS_CHANGES_FROM_TIMESTAMP" | "PROCESS_CHANGES_FROM_POSITION" | "RECOVER_USING_LOCALLY_STORED_CHECKPOINT";
|
|
269
|
+
/** The value indicating where to resume the process, either a timestamp or an offset depending on the run option (optional, applies to Replication tasks only). */
|
|
270
|
+
processChangesFrom?: string;
|
|
271
|
+
};
|
|
272
|
+
/**
|
|
273
|
+
* Array of tasks to prepare. Leave empty to trigger project-level orchestration using built-in logic (same as in the user interface).
|
|
274
|
+
*/
|
|
275
|
+
type TaskSelectionList = DiProjectOperationSelectedTask[];
|
|
276
|
+
type UpdateDiExportProjectVariablesReq = {
|
|
277
|
+
variables?: Record<string, string>;
|
|
278
|
+
};
|
|
279
|
+
type UpdateDiExportProjectVariablesRsp = unknown;
|
|
280
|
+
type ValidateProjectReq = {
|
|
281
|
+
/** Array of tasks to prepare. Leave empty to trigger project-level orchestration using built-in logic (same as in the user interface). */
|
|
282
|
+
selectedTasks?: TaskSelectionList;
|
|
283
|
+
};
|
|
284
|
+
/**
|
|
285
|
+
* Request body for task validation
|
|
286
|
+
*/
|
|
287
|
+
type ValidateTaskReq = unknown;
|
|
288
|
+
/**
|
|
289
|
+
* List data integration projects.
|
|
290
|
+
*
|
|
291
|
+
* @param query an object with query parameters
|
|
292
|
+
* @throws GetDiProjectsHttpError
|
|
293
|
+
*/
|
|
294
|
+
declare function getDiProjects(query: {
|
|
295
|
+
/** Filter by space id */
|
|
296
|
+
spaceId?: string;
|
|
297
|
+
}, options?: ApiCallOptions): Promise<GetDiProjectsHttpResponse>;
|
|
298
|
+
type GetDiProjectsHttpResponse = {
|
|
299
|
+
data: ListDiProjectsRsp;
|
|
300
|
+
headers: Headers;
|
|
301
|
+
status: 200;
|
|
302
|
+
};
|
|
303
|
+
type GetDiProjectsHttpError = {
|
|
304
|
+
data: Errors;
|
|
305
|
+
headers: Headers;
|
|
306
|
+
status: 400 | 404;
|
|
307
|
+
};
|
|
308
|
+
/**
|
|
309
|
+
* Creates a new data integration project in the specified space.
|
|
310
|
+
*
|
|
311
|
+
* @param body an object with the body content
|
|
312
|
+
* @throws CreateDiProjectHttpError
|
|
313
|
+
*/
|
|
314
|
+
declare function createDiProject(body: CreateDiProjectReq, options?: ApiCallOptions): Promise<CreateDiProjectHttpResponse>;
|
|
315
|
+
type CreateDiProjectHttpResponse = {
|
|
316
|
+
data: DiProjectItemRsp;
|
|
317
|
+
headers: Headers;
|
|
318
|
+
status: 201;
|
|
319
|
+
};
|
|
320
|
+
type CreateDiProjectHttpError = {
|
|
321
|
+
data: Errors;
|
|
322
|
+
headers: Headers;
|
|
323
|
+
status: 400 | 500;
|
|
324
|
+
};
|
|
325
|
+
/**
|
|
326
|
+
* Retrieves the status of an asynchronous operation.
|
|
327
|
+
*
|
|
328
|
+
* @param actionId Identifier of the action.
|
|
329
|
+
* @param query an object with query parameters
|
|
330
|
+
* @throws GetDiProjectHttpError
|
|
331
|
+
*/
|
|
332
|
+
declare function getDiProject(actionId: string, query: {
|
|
333
|
+
/** Specifies whether to include detailed status information in the response. Set to `true` to return detailed information. */
|
|
334
|
+
detailed?: boolean;
|
|
335
|
+
}, options?: ApiCallOptions): Promise<GetDiProjectHttpResponse>;
|
|
336
|
+
type GetDiProjectHttpResponse = {
|
|
337
|
+
data: AsyncActionDetails;
|
|
338
|
+
headers: Headers;
|
|
339
|
+
status: 200;
|
|
340
|
+
};
|
|
341
|
+
type GetDiProjectHttpError = {
|
|
342
|
+
data: Errors;
|
|
343
|
+
headers: Headers;
|
|
344
|
+
status: 404;
|
|
345
|
+
};
|
|
346
|
+
/**
|
|
347
|
+
* Exports the specified data integration project.
|
|
348
|
+
*
|
|
349
|
+
* @param projectId Identifier of the data project.
|
|
350
|
+
* @param body an object with the body content
|
|
351
|
+
* @throws ExportDiProjectHttpError
|
|
352
|
+
*/
|
|
353
|
+
declare function exportDiProject(projectId: string, body: ExportDiProjectReq, options?: ApiCallOptions): Promise<ExportDiProjectHttpResponse>;
|
|
354
|
+
type ExportDiProjectHttpResponse = {
|
|
355
|
+
data: DownloadableBlob;
|
|
356
|
+
headers: Headers;
|
|
357
|
+
status: 200;
|
|
358
|
+
};
|
|
359
|
+
type ExportDiProjectHttpError = {
|
|
360
|
+
data: Errors;
|
|
361
|
+
headers: Headers;
|
|
362
|
+
status: 400 | 404 | 500;
|
|
363
|
+
};
|
|
364
|
+
/**
|
|
365
|
+
* Imports a data integration project from a `.zip` file.
|
|
366
|
+
*
|
|
367
|
+
* @param projectId Identifier of the data project.
|
|
368
|
+
* @param body an object with the body content
|
|
369
|
+
* @throws ImportDiProjectHttpError
|
|
370
|
+
*/
|
|
371
|
+
declare function importDiProject(projectId: string, body: {
|
|
372
|
+
zip?: BodyInit;
|
|
373
|
+
}, options?: ApiCallOptions): Promise<ImportDiProjectHttpResponse>;
|
|
374
|
+
type ImportDiProjectHttpResponse = {
|
|
375
|
+
data: ImportDiProjectRsp;
|
|
376
|
+
headers: Headers;
|
|
377
|
+
status: 200;
|
|
378
|
+
};
|
|
379
|
+
type ImportDiProjectHttpError = {
|
|
380
|
+
data: Errors;
|
|
381
|
+
headers: Headers;
|
|
382
|
+
status: 400 | 404 | 500;
|
|
383
|
+
};
|
|
384
|
+
/**
|
|
385
|
+
* Prepares the data integration project and its tasks for execution.
|
|
386
|
+
*
|
|
387
|
+
* @param projectId Identifier of the data project.
|
|
388
|
+
* @param body an object with the body content
|
|
389
|
+
* @throws PrepareDiProjectHttpError
|
|
390
|
+
*/
|
|
391
|
+
declare function prepareDiProject(projectId: string, body: PrepareProjectReq, options?: ApiCallOptions): Promise<PrepareDiProjectHttpResponse>;
|
|
392
|
+
type PrepareDiProjectHttpResponse = {
|
|
393
|
+
data: AsyncActionRsp;
|
|
394
|
+
headers: Headers;
|
|
395
|
+
status: 202;
|
|
396
|
+
};
|
|
397
|
+
type PrepareDiProjectHttpError = {
|
|
398
|
+
data: Errors;
|
|
399
|
+
headers: Headers;
|
|
400
|
+
status: 400 | 404;
|
|
401
|
+
};
|
|
402
|
+
/**
|
|
403
|
+
* Validates the data integration project and its tasks.
|
|
404
|
+
*
|
|
405
|
+
* @param projectId Identifier of the data project.
|
|
406
|
+
* @param body an object with the body content
|
|
407
|
+
* @throws ValidateDiProjectHttpError
|
|
408
|
+
*/
|
|
409
|
+
declare function validateDiProject(projectId: string, body: ValidateProjectReq, options?: ApiCallOptions): Promise<ValidateDiProjectHttpResponse>;
|
|
410
|
+
type ValidateDiProjectHttpResponse = {
|
|
411
|
+
data: AsyncActionRsp;
|
|
412
|
+
headers: Headers;
|
|
413
|
+
status: 202;
|
|
414
|
+
};
|
|
415
|
+
type ValidateDiProjectHttpError = {
|
|
416
|
+
data: Errors;
|
|
417
|
+
headers: Headers;
|
|
418
|
+
status: 400 | 404;
|
|
419
|
+
};
|
|
420
|
+
/**
|
|
421
|
+
* Retrieves the export variables for a specific data integration project.
|
|
422
|
+
*
|
|
423
|
+
* @param projectId Identifier of the data project.
|
|
424
|
+
* @param query an object with query parameters
|
|
425
|
+
* @throws GetDiProjectExportVariablesHttpError
|
|
426
|
+
*/
|
|
427
|
+
declare function getDiProjectExportVariables(projectId: string, query: {
|
|
428
|
+
/** Recalculate the bindings if true, otherwise saved bindings are returned. */
|
|
429
|
+
recalculate?: boolean;
|
|
430
|
+
}, options?: ApiCallOptions): Promise<GetDiProjectExportVariablesHttpResponse>;
|
|
431
|
+
type GetDiProjectExportVariablesHttpResponse = {
|
|
432
|
+
data: GetDiExportProjectVariablesRsp;
|
|
433
|
+
headers: Headers;
|
|
434
|
+
status: 200;
|
|
435
|
+
};
|
|
436
|
+
type GetDiProjectExportVariablesHttpError = {
|
|
437
|
+
data: Errors;
|
|
438
|
+
headers: Headers;
|
|
439
|
+
status: 400 | 404;
|
|
440
|
+
};
|
|
441
|
+
/**
|
|
442
|
+
* Updates the export variables for a specific data integration project.
|
|
443
|
+
*
|
|
444
|
+
* @param projectId Identifier of the data project.
|
|
445
|
+
* @param body an object with the body content
|
|
446
|
+
* @throws SetDiProjectExportVariablesHttpError
|
|
447
|
+
*/
|
|
448
|
+
declare function setDiProjectExportVariables(projectId: string, body: UpdateDiExportProjectVariablesReq, options?: ApiCallOptions): Promise<SetDiProjectExportVariablesHttpResponse>;
|
|
449
|
+
type SetDiProjectExportVariablesHttpResponse = {
|
|
450
|
+
data: UpdateDiExportProjectVariablesRsp;
|
|
451
|
+
headers: Headers;
|
|
452
|
+
status: 200;
|
|
453
|
+
};
|
|
454
|
+
type SetDiProjectExportVariablesHttpError = {
|
|
455
|
+
data: Errors;
|
|
456
|
+
headers: Headers;
|
|
457
|
+
status: 400 | 404 | 500;
|
|
458
|
+
};
|
|
459
|
+
/**
|
|
460
|
+
* Lists data tasks within a given data integration project.
|
|
461
|
+
*
|
|
462
|
+
* @param projectId Identifier of the data project.
|
|
463
|
+
* @throws GetDiProjectDiTasksHttpError
|
|
464
|
+
*/
|
|
465
|
+
declare function getDiProjectDiTasks(projectId: string, options?: ApiCallOptions): Promise<GetDiProjectDiTasksHttpResponse>;
|
|
466
|
+
type GetDiProjectDiTasksHttpResponse = {
|
|
467
|
+
data: ListDataTasksRsp;
|
|
468
|
+
headers: Headers;
|
|
469
|
+
status: 200;
|
|
470
|
+
};
|
|
471
|
+
type GetDiProjectDiTasksHttpError = {
|
|
472
|
+
data: Errors;
|
|
473
|
+
headers: Headers;
|
|
474
|
+
status: 400 | 404;
|
|
475
|
+
};
|
|
476
|
+
/**
|
|
477
|
+
* Get a specific data task within a project.
|
|
478
|
+
*
|
|
479
|
+
* @param projectId Identifier of the data project.
|
|
480
|
+
* @param dataTaskId Identifier of the data task.
|
|
481
|
+
* @throws GetDiProjectDiTaskHttpError
|
|
482
|
+
*/
|
|
483
|
+
declare function getDiProjectDiTask(projectId: string, dataTaskId: string, options?: ApiCallOptions): Promise<GetDiProjectDiTaskHttpResponse>;
|
|
484
|
+
type GetDiProjectDiTaskHttpResponse = {
|
|
485
|
+
data: DataTaskItemRsp;
|
|
486
|
+
headers: Headers;
|
|
487
|
+
status: 200;
|
|
488
|
+
};
|
|
489
|
+
type GetDiProjectDiTaskHttpError = {
|
|
490
|
+
data: Errors;
|
|
491
|
+
headers: Headers;
|
|
492
|
+
status: 400 | 404;
|
|
493
|
+
};
|
|
494
|
+
/**
|
|
495
|
+
* Prepares the specified data task for execution.
|
|
496
|
+
*
|
|
497
|
+
* @param projectId Identifier of the data project.
|
|
498
|
+
* @param dataTaskId Identifier of the data task.
|
|
499
|
+
* @param body an object with the body content
|
|
500
|
+
* @throws PrepareDiProjectDiTaskHttpError
|
|
501
|
+
*/
|
|
502
|
+
declare function prepareDiProjectDiTask(projectId: string, dataTaskId: string, body: PrepareTaskReq, options?: ApiCallOptions): Promise<PrepareDiProjectDiTaskHttpResponse>;
|
|
503
|
+
type PrepareDiProjectDiTaskHttpResponse = {
|
|
504
|
+
data: AsyncActionRsp;
|
|
505
|
+
headers: Headers;
|
|
506
|
+
status: 202;
|
|
507
|
+
};
|
|
508
|
+
type PrepareDiProjectDiTaskHttpError = {
|
|
509
|
+
data: Errors;
|
|
510
|
+
headers: Headers;
|
|
511
|
+
status: 400 | 404;
|
|
512
|
+
};
|
|
513
|
+
/**
|
|
514
|
+
* Registers a request to reload the datasets associated with the specified data task. The reload does not occur immediately; it will take effect on the next scheduled or manual run of the task.
|
|
515
|
+
*
|
|
516
|
+
* @param projectId Identifier of the data project.
|
|
517
|
+
* @param dataTaskId Identifier of the data task.
|
|
518
|
+
* @param body an object with the body content
|
|
519
|
+
* @throws RequestReloadDiProjectDiTaskHttpError
|
|
520
|
+
*/
|
|
521
|
+
declare function requestReloadDiProjectDiTask(projectId: string, dataTaskId: string, body: ReloadDiTaskReq, options?: ApiCallOptions): Promise<RequestReloadDiProjectDiTaskHttpResponse>;
|
|
522
|
+
type RequestReloadDiProjectDiTaskHttpResponse = {
|
|
523
|
+
data: ReloadRequestResponse;
|
|
524
|
+
headers: Headers;
|
|
525
|
+
status: 200;
|
|
526
|
+
};
|
|
527
|
+
type RequestReloadDiProjectDiTaskHttpError = {
|
|
528
|
+
data: Errors;
|
|
529
|
+
headers: Headers;
|
|
530
|
+
status: 400 | 404;
|
|
531
|
+
};
|
|
532
|
+
/**
|
|
533
|
+
* Validates the specified data task.
|
|
534
|
+
*
|
|
535
|
+
* @param projectId Identifier of the data project.
|
|
536
|
+
* @param dataTaskId Identifier of the data task.
|
|
537
|
+
* @param body an object with the body content
|
|
538
|
+
* @throws ValidateDiProjectDiTaskHttpError
|
|
539
|
+
*/
|
|
540
|
+
declare function validateDiProjectDiTask(projectId: string, dataTaskId: string, body: ValidateTaskReq, options?: ApiCallOptions): Promise<ValidateDiProjectDiTaskHttpResponse>;
|
|
541
|
+
type ValidateDiProjectDiTaskHttpResponse = {
|
|
542
|
+
data: AsyncActionRsp;
|
|
543
|
+
headers: Headers;
|
|
544
|
+
status: 202;
|
|
545
|
+
};
|
|
546
|
+
type ValidateDiProjectDiTaskHttpError = {
|
|
547
|
+
data: Errors;
|
|
548
|
+
headers: Headers;
|
|
549
|
+
status: 400 | 404;
|
|
550
|
+
};
|
|
551
|
+
/**
|
|
552
|
+
* Start a data task on a data integration project.
|
|
553
|
+
*
|
|
554
|
+
* @param projectId Identifier of the data project.
|
|
555
|
+
* @param dataTaskId Identifier of the data task.
|
|
556
|
+
* @param body an object with the body content
|
|
557
|
+
* @throws StartDiProjectDiTaskRuntimeWithBodyHttpError
|
|
558
|
+
*/
|
|
559
|
+
declare function startDiProjectDiTaskRuntimeWithBody(projectId: string, dataTaskId: string, body: StartTaskReq, options?: ApiCallOptions): Promise<StartDiProjectDiTaskRuntimeWithBodyHttpResponse>;
|
|
560
|
+
type StartDiProjectDiTaskRuntimeWithBodyHttpResponse = {
|
|
561
|
+
data: void;
|
|
562
|
+
headers: Headers;
|
|
563
|
+
status: 204;
|
|
564
|
+
};
|
|
565
|
+
type StartDiProjectDiTaskRuntimeWithBodyHttpError = {
|
|
566
|
+
data: Errors;
|
|
567
|
+
headers: Headers;
|
|
568
|
+
status: 400 | 404;
|
|
569
|
+
};
|
|
570
|
+
/**
|
|
571
|
+
* Start a data task on a data integration project.
|
|
572
|
+
*
|
|
573
|
+
* @param projectId Identifier of the data project.
|
|
574
|
+
* @param dataTaskId Identifier of the data task.
|
|
575
|
+
* @throws StartDiProjectDiTaskRuntimeHttpError
|
|
576
|
+
*/
|
|
577
|
+
declare function startDiProjectDiTaskRuntime(projectId: string, dataTaskId: string, options?: ApiCallOptions): Promise<StartDiProjectDiTaskRuntimeHttpResponse>;
|
|
578
|
+
type StartDiProjectDiTaskRuntimeHttpResponse = {
|
|
579
|
+
data: void;
|
|
580
|
+
headers: Headers;
|
|
581
|
+
status: 204;
|
|
582
|
+
};
|
|
583
|
+
type StartDiProjectDiTaskRuntimeHttpError = {
|
|
584
|
+
data: Errors;
|
|
585
|
+
headers: Headers;
|
|
586
|
+
status: 400 | 404;
|
|
587
|
+
};
|
|
588
|
+
/**
|
|
589
|
+
* Stop a data task on a data integration project.
|
|
590
|
+
*
|
|
591
|
+
* @param projectId Identifier of the data project.
|
|
592
|
+
* @param dataTaskId Identifier of the data task.
|
|
593
|
+
* @throws StopDiProjectDiTaskRuntimeHttpError
|
|
594
|
+
*/
|
|
595
|
+
declare function stopDiProjectDiTaskRuntime(projectId: string, dataTaskId: string, options?: ApiCallOptions): Promise<StopDiProjectDiTaskRuntimeHttpResponse>;
|
|
596
|
+
type StopDiProjectDiTaskRuntimeHttpResponse = {
|
|
597
|
+
data: void;
|
|
598
|
+
headers: Headers;
|
|
599
|
+
status: 204;
|
|
600
|
+
};
|
|
601
|
+
type StopDiProjectDiTaskRuntimeHttpError = {
|
|
602
|
+
data: Errors;
|
|
603
|
+
headers: Headers;
|
|
604
|
+
status: 400 | 404;
|
|
605
|
+
};
|
|
606
|
+
/**
|
|
607
|
+
* Get the current runtime state of a data task
|
|
608
|
+
*
|
|
609
|
+
* @param projectId Identifier of the data project.
|
|
610
|
+
* @param dataTaskId Identifier of the data task.
|
|
611
|
+
* @throws GetDiProjectDiTaskRuntimeStateHttpError
|
|
612
|
+
*/
|
|
613
|
+
declare function getDiProjectDiTaskRuntimeState(projectId: string, dataTaskId: string, options?: ApiCallOptions): Promise<GetDiProjectDiTaskRuntimeStateHttpResponse>;
|
|
614
|
+
type GetDiProjectDiTaskRuntimeStateHttpResponse = {
|
|
615
|
+
data: DataTaskRuntimeState;
|
|
616
|
+
headers: Headers;
|
|
617
|
+
status: 200;
|
|
618
|
+
};
|
|
619
|
+
type GetDiProjectDiTaskRuntimeStateHttpError = {
|
|
620
|
+
data: Errors;
|
|
621
|
+
headers: Headers;
|
|
622
|
+
status: 400 | 404;
|
|
623
|
+
};
|
|
624
|
+
/**
|
|
625
|
+
* Returns dataset-level runtime state for a data task
|
|
626
|
+
*
|
|
627
|
+
* @param projectId Identifier of the data project.
|
|
628
|
+
* @param dataTaskId Identifier of the data task.
|
|
629
|
+
* @throws GetDiProjectDiTaskRuntimeStateDatasetsHttpError
|
|
630
|
+
*/
|
|
631
|
+
declare function getDiProjectDiTaskRuntimeStateDatasets(projectId: string, dataTaskId: string, options?: ApiCallOptions): Promise<GetDiProjectDiTaskRuntimeStateDatasetsHttpResponse>;
|
|
632
|
+
type GetDiProjectDiTaskRuntimeStateDatasetsHttpResponse = {
|
|
633
|
+
data: {
|
|
634
|
+
datasets?: DataTaskDatasetState[];
|
|
635
|
+
};
|
|
636
|
+
headers: Headers;
|
|
637
|
+
status: 200;
|
|
638
|
+
};
|
|
639
|
+
type GetDiProjectDiTaskRuntimeStateDatasetsHttpError = {
|
|
640
|
+
data: Errors;
|
|
641
|
+
headers: Headers;
|
|
642
|
+
status: 400 | 404;
|
|
643
|
+
};
|
|
644
|
+
/**
|
|
645
|
+
* Clears the cache for di-projects api requests.
|
|
646
|
+
*/
|
|
647
|
+
declare function clearCache(): void;
|
|
648
|
+
type DiProjectsAPI = {
|
|
649
|
+
/**
|
|
650
|
+
* List data integration projects.
|
|
651
|
+
*
|
|
652
|
+
* @param query an object with query parameters
|
|
653
|
+
* @throws GetDiProjectsHttpError
|
|
654
|
+
*/
|
|
655
|
+
getDiProjects: typeof getDiProjects;
|
|
656
|
+
/**
|
|
657
|
+
* Creates a new data integration project in the specified space.
|
|
658
|
+
*
|
|
659
|
+
* @param body an object with the body content
|
|
660
|
+
* @throws CreateDiProjectHttpError
|
|
661
|
+
*/
|
|
662
|
+
createDiProject: typeof createDiProject;
|
|
663
|
+
/**
|
|
664
|
+
* Retrieves the status of an asynchronous operation.
|
|
665
|
+
*
|
|
666
|
+
* @param actionId Identifier of the action.
|
|
667
|
+
* @param query an object with query parameters
|
|
668
|
+
* @throws GetDiProjectHttpError
|
|
669
|
+
*/
|
|
670
|
+
getDiProject: typeof getDiProject;
|
|
671
|
+
/**
|
|
672
|
+
* Exports the specified data integration project.
|
|
673
|
+
*
|
|
674
|
+
* @param projectId Identifier of the data project.
|
|
675
|
+
* @param body an object with the body content
|
|
676
|
+
* @throws ExportDiProjectHttpError
|
|
677
|
+
*/
|
|
678
|
+
exportDiProject: typeof exportDiProject;
|
|
679
|
+
/**
|
|
680
|
+
* Imports a data integration project from a `.zip` file.
|
|
681
|
+
*
|
|
682
|
+
* @param projectId Identifier of the data project.
|
|
683
|
+
* @param body an object with the body content
|
|
684
|
+
* @throws ImportDiProjectHttpError
|
|
685
|
+
*/
|
|
686
|
+
importDiProject: typeof importDiProject;
|
|
687
|
+
/**
|
|
688
|
+
* Prepares the data integration project and its tasks for execution.
|
|
689
|
+
*
|
|
690
|
+
* @param projectId Identifier of the data project.
|
|
691
|
+
* @param body an object with the body content
|
|
692
|
+
* @throws PrepareDiProjectHttpError
|
|
693
|
+
*/
|
|
694
|
+
prepareDiProject: typeof prepareDiProject;
|
|
695
|
+
/**
|
|
696
|
+
* Validates the data integration project and its tasks.
|
|
697
|
+
*
|
|
698
|
+
* @param projectId Identifier of the data project.
|
|
699
|
+
* @param body an object with the body content
|
|
700
|
+
* @throws ValidateDiProjectHttpError
|
|
701
|
+
*/
|
|
702
|
+
validateDiProject: typeof validateDiProject;
|
|
703
|
+
/**
|
|
704
|
+
* Retrieves the export variables for a specific data integration project.
|
|
705
|
+
*
|
|
706
|
+
* @param projectId Identifier of the data project.
|
|
707
|
+
* @param query an object with query parameters
|
|
708
|
+
* @throws GetDiProjectExportVariablesHttpError
|
|
709
|
+
*/
|
|
710
|
+
getDiProjectExportVariables: typeof getDiProjectExportVariables;
|
|
711
|
+
/**
|
|
712
|
+
* Updates the export variables for a specific data integration project.
|
|
713
|
+
*
|
|
714
|
+
* @param projectId Identifier of the data project.
|
|
715
|
+
* @param body an object with the body content
|
|
716
|
+
* @throws SetDiProjectExportVariablesHttpError
|
|
717
|
+
*/
|
|
718
|
+
setDiProjectExportVariables: typeof setDiProjectExportVariables;
|
|
719
|
+
/**
|
|
720
|
+
* Lists data tasks within a given data integration project.
|
|
721
|
+
*
|
|
722
|
+
* @param projectId Identifier of the data project.
|
|
723
|
+
* @throws GetDiProjectDiTasksHttpError
|
|
724
|
+
*/
|
|
725
|
+
getDiProjectDiTasks: typeof getDiProjectDiTasks;
|
|
726
|
+
/**
|
|
727
|
+
* Get a specific data task within a project.
|
|
728
|
+
*
|
|
729
|
+
* @param projectId Identifier of the data project.
|
|
730
|
+
* @param dataTaskId Identifier of the data task.
|
|
731
|
+
* @throws GetDiProjectDiTaskHttpError
|
|
732
|
+
*/
|
|
733
|
+
getDiProjectDiTask: typeof getDiProjectDiTask;
|
|
734
|
+
/**
|
|
735
|
+
* Prepares the specified data task for execution.
|
|
736
|
+
*
|
|
737
|
+
* @param projectId Identifier of the data project.
|
|
738
|
+
* @param dataTaskId Identifier of the data task.
|
|
739
|
+
* @param body an object with the body content
|
|
740
|
+
* @throws PrepareDiProjectDiTaskHttpError
|
|
741
|
+
*/
|
|
742
|
+
prepareDiProjectDiTask: typeof prepareDiProjectDiTask;
|
|
743
|
+
/**
|
|
744
|
+
* Registers a request to reload the datasets associated with the specified data task. The reload does not occur immediately; it will take effect on the next scheduled or manual run of the task.
|
|
745
|
+
*
|
|
746
|
+
* @param projectId Identifier of the data project.
|
|
747
|
+
* @param dataTaskId Identifier of the data task.
|
|
748
|
+
* @param body an object with the body content
|
|
749
|
+
* @throws RequestReloadDiProjectDiTaskHttpError
|
|
750
|
+
*/
|
|
751
|
+
requestReloadDiProjectDiTask: typeof requestReloadDiProjectDiTask;
|
|
752
|
+
/**
|
|
753
|
+
* Validates the specified data task.
|
|
754
|
+
*
|
|
755
|
+
* @param projectId Identifier of the data project.
|
|
756
|
+
* @param dataTaskId Identifier of the data task.
|
|
757
|
+
* @param body an object with the body content
|
|
758
|
+
* @throws ValidateDiProjectDiTaskHttpError
|
|
759
|
+
*/
|
|
760
|
+
validateDiProjectDiTask: typeof validateDiProjectDiTask;
|
|
761
|
+
/**
|
|
762
|
+
* Start a data task on a data integration project.
|
|
763
|
+
*
|
|
764
|
+
* @param projectId Identifier of the data project.
|
|
765
|
+
* @param dataTaskId Identifier of the data task.
|
|
766
|
+
* @param body an object with the body content
|
|
767
|
+
* @throws StartDiProjectDiTaskRuntimeWithBodyHttpError
|
|
768
|
+
*/
|
|
769
|
+
startDiProjectDiTaskRuntimeWithBody: typeof startDiProjectDiTaskRuntimeWithBody;
|
|
770
|
+
/**
|
|
771
|
+
* Start a data task on a data integration project.
|
|
772
|
+
*
|
|
773
|
+
* @param projectId Identifier of the data project.
|
|
774
|
+
* @param dataTaskId Identifier of the data task.
|
|
775
|
+
* @throws StartDiProjectDiTaskRuntimeHttpError
|
|
776
|
+
*/
|
|
777
|
+
startDiProjectDiTaskRuntime: typeof startDiProjectDiTaskRuntime;
|
|
778
|
+
/**
|
|
779
|
+
* Stop a data task on a data integration project.
|
|
780
|
+
*
|
|
781
|
+
* @param projectId Identifier of the data project.
|
|
782
|
+
* @param dataTaskId Identifier of the data task.
|
|
783
|
+
* @throws StopDiProjectDiTaskRuntimeHttpError
|
|
784
|
+
*/
|
|
785
|
+
stopDiProjectDiTaskRuntime: typeof stopDiProjectDiTaskRuntime;
|
|
786
|
+
/**
|
|
787
|
+
* Get the current runtime state of a data task
|
|
788
|
+
*
|
|
789
|
+
* @param projectId Identifier of the data project.
|
|
790
|
+
* @param dataTaskId Identifier of the data task.
|
|
791
|
+
* @throws GetDiProjectDiTaskRuntimeStateHttpError
|
|
792
|
+
*/
|
|
793
|
+
getDiProjectDiTaskRuntimeState: typeof getDiProjectDiTaskRuntimeState;
|
|
794
|
+
/**
|
|
795
|
+
* Returns dataset-level runtime state for a data task
|
|
796
|
+
*
|
|
797
|
+
* @param projectId Identifier of the data project.
|
|
798
|
+
* @param dataTaskId Identifier of the data task.
|
|
799
|
+
* @throws GetDiProjectDiTaskRuntimeStateDatasetsHttpError
|
|
800
|
+
*/
|
|
801
|
+
getDiProjectDiTaskRuntimeStateDatasets: typeof getDiProjectDiTaskRuntimeStateDatasets;
|
|
802
|
+
/**
|
|
803
|
+
* Clears the cache for di-projects api requests.
|
|
804
|
+
*/
|
|
805
|
+
clearCache: typeof clearCache;
|
|
806
|
+
};
|
|
807
|
+
/**
|
|
808
|
+
* Functions for the di-projects api
|
|
809
|
+
*/
|
|
810
|
+
declare const diProjectsExport: DiProjectsAPI;
|
|
811
|
+
//#endregion
|
|
812
|
+
export { AsyncActionDetails, AsyncActionError, AsyncActionRsp, AsyncActionTaskProgress, AsyncActionType, AsyncCallStatus, CreateDiProjectHttpError, CreateDiProjectHttpResponse, CreateDiProjectReq, DataTaskDatasetState, DataTaskInstanceState, DataTaskItemRsp, DataTaskRuntimeState, DataTaskType, DiProjectItemRsp, DiProjectOperationSelectedTask, DiProjectsAPI, Error, ErrorSource, Errors, ExportDiProjectHttpError, ExportDiProjectHttpResponse, ExportDiProjectReq, GetDiExportProjectVariablesRsp, GetDiProjectDiTaskHttpError, GetDiProjectDiTaskHttpResponse, GetDiProjectDiTaskRuntimeStateDatasetsHttpError, GetDiProjectDiTaskRuntimeStateDatasetsHttpResponse, GetDiProjectDiTaskRuntimeStateHttpError, GetDiProjectDiTaskRuntimeStateHttpResponse, GetDiProjectDiTasksHttpError, GetDiProjectDiTasksHttpResponse, GetDiProjectExportVariablesHttpError, GetDiProjectExportVariablesHttpResponse, GetDiProjectHttpError, GetDiProjectHttpResponse, GetDiProjectsHttpError, GetDiProjectsHttpResponse, ImportDiProjectHttpError, ImportDiProjectHttpResponse, ImportDiProjectRsp, ListDataTasksRsp, ListDiProjectsRsp, PrepareDiProjectDiTaskHttpError, PrepareDiProjectDiTaskHttpResponse, PrepareDiProjectHttpError, PrepareDiProjectHttpResponse, PrepareProjectReq, PrepareTaskReq, ReloadDiTaskReq, ReloadRequestResponse, RequestReloadDiProjectDiTaskHttpError, RequestReloadDiProjectDiTaskHttpResponse, SetDiProjectExportVariablesHttpError, SetDiProjectExportVariablesHttpResponse, StartDiProjectDiTaskRuntimeHttpError, StartDiProjectDiTaskRuntimeHttpResponse, StartDiProjectDiTaskRuntimeWithBodyHttpError, StartDiProjectDiTaskRuntimeWithBodyHttpResponse, StartTaskReq, StopDiProjectDiTaskRuntimeHttpError, StopDiProjectDiTaskRuntimeHttpResponse, TaskSelectionList, UpdateDiExportProjectVariablesReq, UpdateDiExportProjectVariablesRsp, ValidateDiProjectDiTaskHttpError, ValidateDiProjectDiTaskHttpResponse, ValidateDiProjectHttpError, ValidateDiProjectHttpResponse, ValidateProjectReq, ValidateTaskReq, clearCache, createDiProject, diProjectsExport as default, exportDiProject, getDiProject, getDiProjectDiTask, getDiProjectDiTaskRuntimeState, getDiProjectDiTaskRuntimeStateDatasets, getDiProjectDiTasks, getDiProjectExportVariables, getDiProjects, importDiProject, prepareDiProject, prepareDiProjectDiTask, requestReloadDiProjectDiTask, setDiProjectExportVariables, startDiProjectDiTaskRuntime, startDiProjectDiTaskRuntimeWithBody, stopDiProjectDiTaskRuntime, validateDiProject, validateDiProjectDiTask };
|