@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
|
@@ -1,580 +0,0 @@
|
|
|
1
|
-
import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
|
|
2
|
-
|
|
3
|
-
//#region src/public/rest/direct-access-agents.d.ts
|
|
4
|
-
type CancelBenchmarkResponse = {
|
|
5
|
-
message?: string;
|
|
6
|
-
statusUrl?: LinkResponseObject;
|
|
7
|
-
};
|
|
8
|
-
type ConfigurationLineBase = ConfigurationLineNumeric | ConfigurationLineString;
|
|
9
|
-
type ConfigurationLineNumeric = {
|
|
10
|
-
allowMultipleValues?: boolean;
|
|
11
|
-
apiActions?: ("Read" | "Write")[];
|
|
12
|
-
applyWithoutRestart?: boolean;
|
|
13
|
-
connector?: string;
|
|
14
|
-
defaultValue?: string;
|
|
15
|
-
description?: string;
|
|
16
|
-
displayName?: string;
|
|
17
|
-
name?: string;
|
|
18
|
-
pendingApplication?: boolean;
|
|
19
|
-
pendingValue?: string;
|
|
20
|
-
permittedRangeEnd?: number;
|
|
21
|
-
permittedRangeStart?: number;
|
|
22
|
-
uiActions?: ("Read" | "Write")[];
|
|
23
|
-
value?: string;
|
|
24
|
-
};
|
|
25
|
-
type ConfigurationLineString = {
|
|
26
|
-
allowMultipleValues?: boolean;
|
|
27
|
-
apiActions?: ("Read" | "Write")[];
|
|
28
|
-
applyWithoutRestart?: boolean;
|
|
29
|
-
connector?: string;
|
|
30
|
-
defaultValue?: string;
|
|
31
|
-
description?: string;
|
|
32
|
-
displayName?: string;
|
|
33
|
-
name?: string;
|
|
34
|
-
pendingApplication?: boolean;
|
|
35
|
-
pendingValue?: string;
|
|
36
|
-
permittedValues?: string[];
|
|
37
|
-
uiActions?: ("Read" | "Write")[];
|
|
38
|
-
value?: string;
|
|
39
|
-
};
|
|
40
|
-
type ConfigurationResponse = {
|
|
41
|
-
connectorAgentSettings?: ConfigurationLineBase[];
|
|
42
|
-
connectors?: ConnectorSettings[];
|
|
43
|
-
dcaasSettings?: ConfigurationLineBase[];
|
|
44
|
-
};
|
|
45
|
-
type ConnectorFlatFileConfigurationResponse = {
|
|
46
|
-
errorMessage?: ErrorResponse;
|
|
47
|
-
result?: string[];
|
|
48
|
-
};
|
|
49
|
-
type ConnectorSettings = {
|
|
50
|
-
connectorName?: string;
|
|
51
|
-
settings?: ConfigurationLineBase[];
|
|
52
|
-
};
|
|
53
|
-
type ErrorMessage = {
|
|
54
|
-
code?: string;
|
|
55
|
-
detail?: string;
|
|
56
|
-
title?: string;
|
|
57
|
-
};
|
|
58
|
-
type ErrorResponse = {
|
|
59
|
-
errors?: ErrorMessage[];
|
|
60
|
-
readonly hasErrors?: boolean;
|
|
61
|
-
traceId?: string;
|
|
62
|
-
};
|
|
63
|
-
type FileConnectorAllowedPath = {
|
|
64
|
-
/** The Path property in the File connector allowed paths file. */
|
|
65
|
-
path: string;
|
|
66
|
-
/** The Spaces property in the Odbc custom type mappings file. */
|
|
67
|
-
spaces?: string[];
|
|
68
|
-
};
|
|
69
|
-
type FileConnectorAllowedPathsResponse = {
|
|
70
|
-
errorMessage?: ErrorResponse;
|
|
71
|
-
result?: FileConnectorAllowedPath[];
|
|
72
|
-
};
|
|
73
|
-
type GetBenchmarkStatusResponse = {
|
|
74
|
-
/** The ISO 8601 formatted timestamp when the benchmark task completed or was cancelled */
|
|
75
|
-
benchmarkEndTime?: string;
|
|
76
|
-
/** The benchmark ID */
|
|
77
|
-
benchmarkId?: string;
|
|
78
|
-
/** The ISO 8601 formatted timestamp when the benchmark task started execution */
|
|
79
|
-
benchmarkStartTime?: string;
|
|
80
|
-
results?: GetBenchmarkStatusResults;
|
|
81
|
-
/** The benchmark status */
|
|
82
|
-
status?: string;
|
|
83
|
-
/** Additional details about the benchmark status */
|
|
84
|
-
statusMessage?: string;
|
|
85
|
-
/** The total bytes requested to be transferred during the benchmark */
|
|
86
|
-
totalBytesRequested?: number;
|
|
87
|
-
};
|
|
88
|
-
type GetBenchmarkStatusResults = {
|
|
89
|
-
/** The ISO 8601 formatted timestamp when data transmission completed */
|
|
90
|
-
dataTransmissionEndTime?: string;
|
|
91
|
-
/** The ISO 8601 formatted timestamp when data transmission start */
|
|
92
|
-
dataTransmissionStartTime?: string;
|
|
93
|
-
/** The latency in ms measured during data transmission */
|
|
94
|
-
latency?: number;
|
|
95
|
-
/** The data throughput in KB/s measured during data transmission */
|
|
96
|
-
throughput?: number;
|
|
97
|
-
/** The total number of bytes successfully transferred during data transmission */
|
|
98
|
-
totalBytesTransferred?: number;
|
|
99
|
-
};
|
|
100
|
-
type LinkResponseObject = {
|
|
101
|
-
/** The URL to the related resource */
|
|
102
|
-
href?: string;
|
|
103
|
-
};
|
|
104
|
-
type OdbcCustomDataType = {
|
|
105
|
-
/** The IsBit property in the ODBC custom data type mapping file. */
|
|
106
|
-
bit?: boolean;
|
|
107
|
-
/** The Identifier property in the ODBC custom data type mapping file. */
|
|
108
|
-
id: string;
|
|
109
|
-
/** The NativeDataType property in the ODBC custom data type mapping file. */
|
|
110
|
-
nativeDataType: string;
|
|
111
|
-
/** The QlikDataType property in the ODBC custom data type mapping file. */
|
|
112
|
-
qlikDataType: string;
|
|
113
|
-
/** The Size property in the ODBC custom data type mapping file. */
|
|
114
|
-
size?: number;
|
|
115
|
-
};
|
|
116
|
-
type OdbcCustomDataTypeResponse = {
|
|
117
|
-
errorMessage?: ErrorResponse;
|
|
118
|
-
result?: OdbcCustomDataType[];
|
|
119
|
-
};
|
|
120
|
-
type Operation = {
|
|
121
|
-
op: "add" | "replace" | "remove";
|
|
122
|
-
path: "AGENT_LOG_LEVEL" | "AGENT_HEALTH_FAIL_MINUTES_LIMIT" | "AGENT_LOG_OPTIONS" | "EXTEND_FIRST_REQUEST_TIMEOUT" | "RELOAD_CACHE_MEMORY_MB" | "DCAAS_LOG_LEVEL" | "ODBC_LOG_LEVEL" | "ODBC_MAX_PROCESS_COUNT" | "ODBC_PROCESS_ISOLATION_MODE" | "ODBC_RELOAD_SESSION_LIFE" | "SAPBW_LOG_LEVEL" | "SAPBW_MAX_PROCESS_COUNT" | "SAPBW_PROCESS_ISOLATION_MODE" | "SAPSQL_LOG_LEVEL" | "SAPSQL_MAX_PROCESS_COUNT" | "SAPSQL_PROCESS_ISOLATION_MODE" | "SAPPACKAGE_LOG_LEVEL" | "SAPPACKAGE_MAX_PROCESS_COUNT" | "SAPPACKAGE_PROCESS_ISOLATION_MODE" | "FILE_LOG_LEVEL" | "FILE_MAX_PROCESS_COUNT" | "FILE_PROCESS_ISOLATION_MODE" | "REST_LOG_LEVEL" | "REST_MAX_PROCESS_COUNT" | "REST_PROCESS_ISOLATION_MODE" | "ODBC_TABLES_LIMIT_FOR_GENERICODBC" | "OVERRIDE_CHUNKS_CACHE_DIR" | "CHUNK_RECOVERY_RESUME_THRESHOLD_MINUTES" | "REST_ALLOW_LOCALHOST_CONNECTION" | "OPTIONAL_CAPABILITIES";
|
|
123
|
-
value: string;
|
|
124
|
-
};
|
|
125
|
-
type PatchOperationResponse = {
|
|
126
|
-
data?: PatchOperationValidationResult[];
|
|
127
|
-
errorMessage?: string;
|
|
128
|
-
failedPatchError?: ErrorResponse;
|
|
129
|
-
httpStatusCode?: number;
|
|
130
|
-
};
|
|
131
|
-
type PatchOperationValidationResult = {
|
|
132
|
-
operation?: Operation;
|
|
133
|
-
valid?: boolean;
|
|
134
|
-
validationResult?: string;
|
|
135
|
-
};
|
|
136
|
-
type RunBenchmarkResponse = {
|
|
137
|
-
benchmarkId?: string;
|
|
138
|
-
};
|
|
139
|
-
/**
|
|
140
|
-
* The request to update a connector flat file
|
|
141
|
-
*/
|
|
142
|
-
type UpdateConfigurationFlatFileRequest = {
|
|
143
|
-
contentsToSave?: string[];
|
|
144
|
-
};
|
|
145
|
-
type UpdateFileConnectorAllowedPathsRequest = {
|
|
146
|
-
fileConnectorAllowedPaths?: FileConnectorAllowedPath[];
|
|
147
|
-
};
|
|
148
|
-
type UpdateOdbcCustomTypeMappingsRequest = {
|
|
149
|
-
odbcCustomDataTypes?: OdbcCustomDataType[];
|
|
150
|
-
};
|
|
151
|
-
/**
|
|
152
|
-
* Restarts the specified agent. If a reload is in `RELOADING` status the `restart` action will be ignored. Use `force-restart` to restart the agent even if a reload is in `RELOADING` status. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
|
|
153
|
-
*
|
|
154
|
-
* @param agentId The agent ID
|
|
155
|
-
* @param agentAction The type of action to perform. Permitted values are `restart` (will not restart the agent if a reload is in `RELOADING` status) and `force-restart` (will restart the agent even if a reload is in `RELOADING` status).
|
|
156
|
-
* @throws RestartDirectAccessAgentHttpError
|
|
157
|
-
*/
|
|
158
|
-
declare function restartDirectAccessAgent(agentId: string, agentAction: string, options?: ApiCallOptions): Promise<RestartDirectAccessAgentHttpResponse>;
|
|
159
|
-
type RestartDirectAccessAgentHttpResponse = {
|
|
160
|
-
data: void;
|
|
161
|
-
headers: Headers;
|
|
162
|
-
status: 204;
|
|
163
|
-
};
|
|
164
|
-
type RestartDirectAccessAgentHttpError = {
|
|
165
|
-
data: ErrorResponse;
|
|
166
|
-
headers: Headers;
|
|
167
|
-
status: 400 | 403 | 404 | 409 | 500;
|
|
168
|
-
};
|
|
169
|
-
/**
|
|
170
|
-
* Starts a background benchmark task to measure the performance of a Direct Access agent. Use this endpoint to evaluate agent throughput and latency for capacity planning and performance optiization. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.8+.
|
|
171
|
-
*
|
|
172
|
-
* @param agentId The agent ID
|
|
173
|
-
* @param query an object with query parameters
|
|
174
|
-
* @throws CreateDirectAccessAgentBenchmarkHttpError
|
|
175
|
-
*/
|
|
176
|
-
declare function createDirectAccessAgentBenchmark(agentId: string, query: {
|
|
177
|
-
/** Forces the benchmark to start regardless of the state of the agent. Does not override QCS resource limits. Use with caution. */
|
|
178
|
-
force?: boolean;
|
|
179
|
-
/** The volume of data in GB to transfer during the throughput measurement part of the benchmark. */
|
|
180
|
-
gigaBytesToTransfer?: number;
|
|
181
|
-
}, options?: ApiCallOptions): Promise<CreateDirectAccessAgentBenchmarkHttpResponse>;
|
|
182
|
-
type CreateDirectAccessAgentBenchmarkHttpResponse = {
|
|
183
|
-
data: RunBenchmarkResponse;
|
|
184
|
-
headers: Headers;
|
|
185
|
-
status: 201;
|
|
186
|
-
};
|
|
187
|
-
type CreateDirectAccessAgentBenchmarkHttpError = {
|
|
188
|
-
data: ErrorResponse;
|
|
189
|
-
headers: Headers;
|
|
190
|
-
status: 403 | 404 | 500 | 501 | 503;
|
|
191
|
-
};
|
|
192
|
-
/**
|
|
193
|
-
* Retrieves the current status and progress of a running or completed benchmark task. Use this endpoint to monitor benchmark execution and retrieve performance metrics once the task is completed. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.8+.
|
|
194
|
-
*
|
|
195
|
-
* @param agentId The agent ID
|
|
196
|
-
* @param benchmarkId The benchmark ID
|
|
197
|
-
* @throws GetDirectAccessAgentBenchmarkHttpError
|
|
198
|
-
*/
|
|
199
|
-
declare function getDirectAccessAgentBenchmark(agentId: string, benchmarkId: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentBenchmarkHttpResponse>;
|
|
200
|
-
type GetDirectAccessAgentBenchmarkHttpResponse = {
|
|
201
|
-
data: GetBenchmarkStatusResponse;
|
|
202
|
-
headers: Headers;
|
|
203
|
-
status: 200;
|
|
204
|
-
};
|
|
205
|
-
type GetDirectAccessAgentBenchmarkHttpError = {
|
|
206
|
-
data: ErrorResponse;
|
|
207
|
-
headers: Headers;
|
|
208
|
-
status: 403 | 404 | 500 | 503;
|
|
209
|
-
};
|
|
210
|
-
/**
|
|
211
|
-
* Requests a cancellation on a running benchmark by id for the specified agent. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.8+.
|
|
212
|
-
*
|
|
213
|
-
* @param agentId The agent ID
|
|
214
|
-
* @param benchmarkId The benchmark ID
|
|
215
|
-
* @throws CreateDirectAccessAgentBenchmarkCancelHttpError
|
|
216
|
-
*/
|
|
217
|
-
declare function createDirectAccessAgentBenchmarkCancel(agentId: string, benchmarkId: string, options?: ApiCallOptions): Promise<CreateDirectAccessAgentBenchmarkCancelHttpResponse>;
|
|
218
|
-
type CreateDirectAccessAgentBenchmarkCancelHttpResponse = {
|
|
219
|
-
data: CancelBenchmarkResponse;
|
|
220
|
-
headers: Headers;
|
|
221
|
-
status: 202;
|
|
222
|
-
};
|
|
223
|
-
type CreateDirectAccessAgentBenchmarkCancelHttpError = {
|
|
224
|
-
data: ErrorResponse;
|
|
225
|
-
headers: Headers;
|
|
226
|
-
status: 403 | 404 | 500 | 503;
|
|
227
|
-
};
|
|
228
|
-
/**
|
|
229
|
-
* Retrieves the connector agent configuration from the specified agent. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
|
|
230
|
-
*
|
|
231
|
-
* @param agentId The agent ID
|
|
232
|
-
* @param query an object with query parameters
|
|
233
|
-
* @throws GetDirectAccessAgentConfigurationHttpError
|
|
234
|
-
*/
|
|
235
|
-
declare function getDirectAccessAgentConfiguration(agentId: string, query: {
|
|
236
|
-
/** Individual properties within the agent configuration */
|
|
237
|
-
queryProperties?: string[];
|
|
238
|
-
}, options?: ApiCallOptions): Promise<GetDirectAccessAgentConfigurationHttpResponse>;
|
|
239
|
-
type GetDirectAccessAgentConfigurationHttpResponse = {
|
|
240
|
-
data: ConfigurationResponse;
|
|
241
|
-
headers: Headers;
|
|
242
|
-
status: 200;
|
|
243
|
-
};
|
|
244
|
-
type GetDirectAccessAgentConfigurationHttpError = {
|
|
245
|
-
data: ErrorResponse;
|
|
246
|
-
headers: Headers;
|
|
247
|
-
status: 403 | 404;
|
|
248
|
-
};
|
|
249
|
-
/**
|
|
250
|
-
* Makes changes to the local agent configuration using JSON Patch. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
|
|
251
|
-
*
|
|
252
|
-
* @param agentId The agent ID
|
|
253
|
-
* @param body an object with the body content
|
|
254
|
-
* @throws PatchDirectAccessAgentConfigurationHttpError
|
|
255
|
-
*/
|
|
256
|
-
declare function patchDirectAccessAgentConfiguration(agentId: string, body: Operation[], options?: ApiCallOptions): Promise<PatchDirectAccessAgentConfigurationHttpResponse>;
|
|
257
|
-
type PatchDirectAccessAgentConfigurationHttpResponse = PatchDirectAccessAgentConfiguration204HttpResponse | PatchDirectAccessAgentConfiguration207HttpResponse;
|
|
258
|
-
type PatchDirectAccessAgentConfiguration204HttpResponse = {
|
|
259
|
-
data: void;
|
|
260
|
-
headers: Headers;
|
|
261
|
-
status: 204;
|
|
262
|
-
};
|
|
263
|
-
type PatchDirectAccessAgentConfiguration207HttpResponse = {
|
|
264
|
-
data: PatchOperationResponse;
|
|
265
|
-
headers: Headers;
|
|
266
|
-
status: 207;
|
|
267
|
-
};
|
|
268
|
-
type PatchDirectAccessAgentConfigurationHttpError = {
|
|
269
|
-
data: ErrorResponse;
|
|
270
|
-
headers: Headers;
|
|
271
|
-
status: 400 | 403 | 404 | 415;
|
|
272
|
-
};
|
|
273
|
-
/**
|
|
274
|
-
* Retrieves the allowed paths settings for the File Connector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.6+.
|
|
275
|
-
*
|
|
276
|
-
* @param agentId The agent ID
|
|
277
|
-
* @throws GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError
|
|
278
|
-
*/
|
|
279
|
-
declare function getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths(agentId: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse>;
|
|
280
|
-
type GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse = {
|
|
281
|
-
data: FileConnectorAllowedPathsResponse;
|
|
282
|
-
headers: Headers;
|
|
283
|
-
status: 200;
|
|
284
|
-
};
|
|
285
|
-
type GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError = {
|
|
286
|
-
data: ErrorResponse;
|
|
287
|
-
headers: Headers;
|
|
288
|
-
status: 404;
|
|
289
|
-
};
|
|
290
|
-
/**
|
|
291
|
-
* Completely replaces the contents of the allowed paths configuration file for the File Connector. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.6+.
|
|
292
|
-
*
|
|
293
|
-
* @param agentId The agent id
|
|
294
|
-
* @param body an object with the body content
|
|
295
|
-
* @throws PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError
|
|
296
|
-
*/
|
|
297
|
-
declare function putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths(agentId: string, body: UpdateFileConnectorAllowedPathsRequest, options?: ApiCallOptions): Promise<PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse>;
|
|
298
|
-
type PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse = {
|
|
299
|
-
data: void;
|
|
300
|
-
headers: Headers;
|
|
301
|
-
status: 204;
|
|
302
|
-
};
|
|
303
|
-
type PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError = {
|
|
304
|
-
data: ErrorResponse;
|
|
305
|
-
headers: Headers;
|
|
306
|
-
status: 400 | 404 | 409;
|
|
307
|
-
};
|
|
308
|
-
/**
|
|
309
|
-
* Retrieves the custom data type mapping settings for the Generic ODBC Connector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.5+.
|
|
310
|
-
*
|
|
311
|
-
* @param agentId The agent ID.
|
|
312
|
-
* @throws GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError
|
|
313
|
-
*/
|
|
314
|
-
declare function getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings(agentId: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse>;
|
|
315
|
-
type GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse = {
|
|
316
|
-
data: OdbcCustomDataTypeResponse;
|
|
317
|
-
headers: Headers;
|
|
318
|
-
status: 200;
|
|
319
|
-
};
|
|
320
|
-
type GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError = {
|
|
321
|
-
data: ErrorResponse;
|
|
322
|
-
headers: Headers;
|
|
323
|
-
status: 404;
|
|
324
|
-
};
|
|
325
|
-
/**
|
|
326
|
-
* Completely replaces the contents of the custom data type mapping configuration file for the Generic ODBC connector. Partial updates are not supported. There are property naming differences between the API and the file contents. Use the API property format when making changes. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.5+.
|
|
327
|
-
*
|
|
328
|
-
* @param agentId The agent ID.
|
|
329
|
-
* @param body an object with the body content
|
|
330
|
-
* @throws PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError
|
|
331
|
-
*/
|
|
332
|
-
declare function putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings(agentId: string, body: UpdateOdbcCustomTypeMappingsRequest, options?: ApiCallOptions): Promise<PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse>;
|
|
333
|
-
type PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse = {
|
|
334
|
-
data: void;
|
|
335
|
-
headers: Headers;
|
|
336
|
-
status: 204;
|
|
337
|
-
};
|
|
338
|
-
type PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError = {
|
|
339
|
-
data: ErrorResponse;
|
|
340
|
-
headers: Headers;
|
|
341
|
-
status: 400 | 404 | 409;
|
|
342
|
-
};
|
|
343
|
-
/**
|
|
344
|
-
* Retrieves the configuration files associated with the connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
345
|
-
*
|
|
346
|
-
* @param agentId The agent ID
|
|
347
|
-
* @param connectorType The connector to retrieve the list of files for
|
|
348
|
-
* @param query an object with query parameters
|
|
349
|
-
* @throws GetDirectAccessAgentConnectorFilesHttpError
|
|
350
|
-
*/
|
|
351
|
-
declare function getDirectAccessAgentConnectorFiles(agentId: string, connectorType: string, query: Record<string, unknown>, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorFilesHttpResponse>;
|
|
352
|
-
type GetDirectAccessAgentConnectorFilesHttpResponse = {
|
|
353
|
-
data: ConnectorFlatFileConfigurationResponse;
|
|
354
|
-
headers: Headers;
|
|
355
|
-
status: 200;
|
|
356
|
-
};
|
|
357
|
-
type GetDirectAccessAgentConnectorFilesHttpError = {
|
|
358
|
-
data: ErrorResponse;
|
|
359
|
-
headers: Headers;
|
|
360
|
-
status: 403 | 404;
|
|
361
|
-
};
|
|
362
|
-
/**
|
|
363
|
-
* Retrieves the configuration files associated with the connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
364
|
-
*
|
|
365
|
-
* @param agentId The agent ID
|
|
366
|
-
* @param connectorType The connector to retrieve the list of files for
|
|
367
|
-
* @throws GetDirectAccessAgentConnectorFilesWithoutQueryHttpError
|
|
368
|
-
*/
|
|
369
|
-
declare function getDirectAccessAgentConnectorFilesWithoutQuery(agentId: string, connectorType: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse>;
|
|
370
|
-
type GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse = {
|
|
371
|
-
data: ConnectorFlatFileConfigurationResponse;
|
|
372
|
-
headers: Headers;
|
|
373
|
-
status: 200;
|
|
374
|
-
};
|
|
375
|
-
type GetDirectAccessAgentConnectorFilesWithoutQueryHttpError = {
|
|
376
|
-
data: ErrorResponse;
|
|
377
|
-
headers: Headers;
|
|
378
|
-
status: 403 | 404;
|
|
379
|
-
};
|
|
380
|
-
/**
|
|
381
|
-
* Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
382
|
-
*
|
|
383
|
-
* @param agentId The agent ID
|
|
384
|
-
* @param connectorType The connector type to retrieve
|
|
385
|
-
* @param fileType The type of file to retrieve
|
|
386
|
-
* @throws GetDirectAccessAgentConnectorFileHttpError
|
|
387
|
-
*/
|
|
388
|
-
declare function getDirectAccessAgentConnectorFile(agentId: string, connectorType: string, fileType: string, options?: ApiCallOptions): Promise<GetDirectAccessAgentConnectorFileHttpResponse>;
|
|
389
|
-
type GetDirectAccessAgentConnectorFileHttpResponse = {
|
|
390
|
-
data: ConnectorFlatFileConfigurationResponse;
|
|
391
|
-
headers: Headers;
|
|
392
|
-
status: 200;
|
|
393
|
-
};
|
|
394
|
-
type GetDirectAccessAgentConnectorFileHttpError = {
|
|
395
|
-
data: ErrorResponse;
|
|
396
|
-
headers: Headers;
|
|
397
|
-
status: 403 | 404;
|
|
398
|
-
};
|
|
399
|
-
/**
|
|
400
|
-
* Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
401
|
-
*
|
|
402
|
-
* @param agentId The agent ID
|
|
403
|
-
* @param connectorType The connector type to update
|
|
404
|
-
* @param fileType The file type to update
|
|
405
|
-
* @param query an object with query parameters
|
|
406
|
-
* @param body an object with the body content
|
|
407
|
-
* @throws UpdateDirectAccessAgentConnectorFileHttpError
|
|
408
|
-
*/
|
|
409
|
-
declare function updateDirectAccessAgentConnectorFile(agentId: string, connectorType: string, fileType: string, query: Record<string, unknown>, body: UpdateConfigurationFlatFileRequest, options?: ApiCallOptions): Promise<UpdateDirectAccessAgentConnectorFileHttpResponse>;
|
|
410
|
-
type UpdateDirectAccessAgentConnectorFileHttpResponse = {
|
|
411
|
-
data: void;
|
|
412
|
-
headers: Headers;
|
|
413
|
-
status: 204;
|
|
414
|
-
};
|
|
415
|
-
type UpdateDirectAccessAgentConnectorFileHttpError = {
|
|
416
|
-
data: ErrorResponse;
|
|
417
|
-
headers: Headers;
|
|
418
|
-
status: 400 | 404 | 409;
|
|
419
|
-
};
|
|
420
|
-
/**
|
|
421
|
-
* Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
422
|
-
*
|
|
423
|
-
* @param agentId The agent ID
|
|
424
|
-
* @param connectorType The connector type to update
|
|
425
|
-
* @param fileType The file type to update
|
|
426
|
-
* @param body an object with the body content
|
|
427
|
-
* @throws UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError
|
|
428
|
-
*/
|
|
429
|
-
declare function updateDirectAccessAgentConnectorFileWithoutQuery(agentId: string, connectorType: string, fileType: string, body: UpdateConfigurationFlatFileRequest, options?: ApiCallOptions): Promise<UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse>;
|
|
430
|
-
type UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse = {
|
|
431
|
-
data: void;
|
|
432
|
-
headers: Headers;
|
|
433
|
-
status: 204;
|
|
434
|
-
};
|
|
435
|
-
type UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError = {
|
|
436
|
-
data: ErrorResponse;
|
|
437
|
-
headers: Headers;
|
|
438
|
-
status: 400 | 404 | 409;
|
|
439
|
-
};
|
|
440
|
-
/**
|
|
441
|
-
* Clears the cache for direct-access-agents api requests.
|
|
442
|
-
*/
|
|
443
|
-
declare function clearCache(): void;
|
|
444
|
-
type DirectAccessAgentsAPI = {
|
|
445
|
-
/**
|
|
446
|
-
* Restarts the specified agent. If a reload is in `RELOADING` status the `restart` action will be ignored. Use `force-restart` to restart the agent even if a reload is in `RELOADING` status. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
|
|
447
|
-
*
|
|
448
|
-
* @param agentId The agent ID
|
|
449
|
-
* @param agentAction The type of action to perform. Permitted values are `restart` (will not restart the agent if a reload is in `RELOADING` status) and `force-restart` (will restart the agent even if a reload is in `RELOADING` status).
|
|
450
|
-
* @throws RestartDirectAccessAgentHttpError
|
|
451
|
-
*/
|
|
452
|
-
restartDirectAccessAgent: typeof restartDirectAccessAgent;
|
|
453
|
-
/**
|
|
454
|
-
* Starts a background benchmark task to measure the performance of a Direct Access agent. Use this endpoint to evaluate agent throughput and latency for capacity planning and performance optiization. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.8+.
|
|
455
|
-
*
|
|
456
|
-
* @param agentId The agent ID
|
|
457
|
-
* @param query an object with query parameters
|
|
458
|
-
* @throws CreateDirectAccessAgentBenchmarkHttpError
|
|
459
|
-
*/
|
|
460
|
-
createDirectAccessAgentBenchmark: typeof createDirectAccessAgentBenchmark;
|
|
461
|
-
/**
|
|
462
|
-
* Retrieves the current status and progress of a running or completed benchmark task. Use this endpoint to monitor benchmark execution and retrieve performance metrics once the task is completed. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.8+.
|
|
463
|
-
*
|
|
464
|
-
* @param agentId The agent ID
|
|
465
|
-
* @param benchmarkId The benchmark ID
|
|
466
|
-
* @throws GetDirectAccessAgentBenchmarkHttpError
|
|
467
|
-
*/
|
|
468
|
-
getDirectAccessAgentBenchmark: typeof getDirectAccessAgentBenchmark;
|
|
469
|
-
/**
|
|
470
|
-
* Requests a cancellation on a running benchmark by id for the specified agent. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.8+.
|
|
471
|
-
*
|
|
472
|
-
* @param agentId The agent ID
|
|
473
|
-
* @param benchmarkId The benchmark ID
|
|
474
|
-
* @throws CreateDirectAccessAgentBenchmarkCancelHttpError
|
|
475
|
-
*/
|
|
476
|
-
createDirectAccessAgentBenchmarkCancel: typeof createDirectAccessAgentBenchmarkCancel;
|
|
477
|
-
/**
|
|
478
|
-
* Retrieves the connector agent configuration from the specified agent. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
|
|
479
|
-
*
|
|
480
|
-
* @param agentId The agent ID
|
|
481
|
-
* @param query an object with query parameters
|
|
482
|
-
* @throws GetDirectAccessAgentConfigurationHttpError
|
|
483
|
-
*/
|
|
484
|
-
getDirectAccessAgentConfiguration: typeof getDirectAccessAgentConfiguration;
|
|
485
|
-
/**
|
|
486
|
-
* Makes changes to the local agent configuration using JSON Patch. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.2+.
|
|
487
|
-
*
|
|
488
|
-
* @param agentId The agent ID
|
|
489
|
-
* @param body an object with the body content
|
|
490
|
-
* @throws PatchDirectAccessAgentConfigurationHttpError
|
|
491
|
-
*/
|
|
492
|
-
patchDirectAccessAgentConfiguration: typeof patchDirectAccessAgentConfiguration;
|
|
493
|
-
/**
|
|
494
|
-
* Retrieves the allowed paths settings for the File Connector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.6+.
|
|
495
|
-
*
|
|
496
|
-
* @param agentId The agent ID
|
|
497
|
-
* @throws GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError
|
|
498
|
-
*/
|
|
499
|
-
getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths: typeof getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths;
|
|
500
|
-
/**
|
|
501
|
-
* Completely replaces the contents of the allowed paths configuration file for the File Connector. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.6+.
|
|
502
|
-
*
|
|
503
|
-
* @param agentId The agent id
|
|
504
|
-
* @param body an object with the body content
|
|
505
|
-
* @throws PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError
|
|
506
|
-
*/
|
|
507
|
-
putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths: typeof putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths;
|
|
508
|
-
/**
|
|
509
|
-
* Retrieves the custom data type mapping settings for the Generic ODBC Connector. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.5+.
|
|
510
|
-
*
|
|
511
|
-
* @param agentId The agent ID.
|
|
512
|
-
* @throws GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError
|
|
513
|
-
*/
|
|
514
|
-
getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings: typeof getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings;
|
|
515
|
-
/**
|
|
516
|
-
* Completely replaces the contents of the custom data type mapping configuration file for the Generic ODBC connector. Partial updates are not supported. There are property naming differences between the API and the file contents. Use the API property format when making changes. Requestor must be assigned the `TenantAdmin` role. Available in Direct Access Gateway V1.7.5+.
|
|
517
|
-
*
|
|
518
|
-
* @param agentId The agent ID.
|
|
519
|
-
* @param body an object with the body content
|
|
520
|
-
* @throws PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError
|
|
521
|
-
*/
|
|
522
|
-
putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings: typeof putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings;
|
|
523
|
-
/**
|
|
524
|
-
* Retrieves the configuration files associated with the connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
525
|
-
*
|
|
526
|
-
* @param agentId The agent ID
|
|
527
|
-
* @param connectorType The connector to retrieve the list of files for
|
|
528
|
-
* @param query an object with query parameters
|
|
529
|
-
* @throws GetDirectAccessAgentConnectorFilesHttpError
|
|
530
|
-
*/
|
|
531
|
-
getDirectAccessAgentConnectorFiles: typeof getDirectAccessAgentConnectorFiles;
|
|
532
|
-
/**
|
|
533
|
-
* Retrieves the configuration files associated with the connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
534
|
-
*
|
|
535
|
-
* @param agentId The agent ID
|
|
536
|
-
* @param connectorType The connector to retrieve the list of files for
|
|
537
|
-
* @throws GetDirectAccessAgentConnectorFilesWithoutQueryHttpError
|
|
538
|
-
*/
|
|
539
|
-
getDirectAccessAgentConnectorFilesWithoutQuery: typeof getDirectAccessAgentConnectorFilesWithoutQuery;
|
|
540
|
-
/**
|
|
541
|
-
* Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
542
|
-
*
|
|
543
|
-
* @param agentId The agent ID
|
|
544
|
-
* @param connectorType The connector type to retrieve
|
|
545
|
-
* @param fileType The type of file to retrieve
|
|
546
|
-
* @throws GetDirectAccessAgentConnectorFileHttpError
|
|
547
|
-
*/
|
|
548
|
-
getDirectAccessAgentConnectorFile: typeof getDirectAccessAgentConnectorFile;
|
|
549
|
-
/**
|
|
550
|
-
* Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
551
|
-
*
|
|
552
|
-
* @param agentId The agent ID
|
|
553
|
-
* @param connectorType The connector type to update
|
|
554
|
-
* @param fileType The file type to update
|
|
555
|
-
* @param query an object with query parameters
|
|
556
|
-
* @param body an object with the body content
|
|
557
|
-
* @throws UpdateDirectAccessAgentConnectorFileHttpError
|
|
558
|
-
*/
|
|
559
|
-
updateDirectAccessAgentConnectorFile: typeof updateDirectAccessAgentConnectorFile;
|
|
560
|
-
/**
|
|
561
|
-
* Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the `TenantAdmin` role and needs to be either a Gateway's space owner or a member in the Gateway's space with `Can Consume Data` role. Available in Direct Access Gateway V1.7.4+.
|
|
562
|
-
*
|
|
563
|
-
* @param agentId The agent ID
|
|
564
|
-
* @param connectorType The connector type to update
|
|
565
|
-
* @param fileType The file type to update
|
|
566
|
-
* @param body an object with the body content
|
|
567
|
-
* @throws UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError
|
|
568
|
-
*/
|
|
569
|
-
updateDirectAccessAgentConnectorFileWithoutQuery: typeof updateDirectAccessAgentConnectorFileWithoutQuery;
|
|
570
|
-
/**
|
|
571
|
-
* Clears the cache for direct-access-agents api requests.
|
|
572
|
-
*/
|
|
573
|
-
clearCache: typeof clearCache;
|
|
574
|
-
};
|
|
575
|
-
/**
|
|
576
|
-
* Functions for the direct-access-agents api
|
|
577
|
-
*/
|
|
578
|
-
declare const directAccessAgentsExport: DirectAccessAgentsAPI;
|
|
579
|
-
//#endregion
|
|
580
|
-
export { UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError as $, GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse as A, PatchDirectAccessAgentConfigurationHttpResponse as B, GetDirectAccessAgentConnectorFileHttpError as C, GetDirectAccessAgentConnectorFilesWithoutQueryHttpError as D, GetDirectAccessAgentConnectorFilesHttpResponse as E, OdbcCustomDataTypeResponse as F, PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError as G, PatchOperationValidationResult as H, Operation as I, RestartDirectAccessAgentHttpResponse as J, PutDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse as K, PatchDirectAccessAgentConfiguration204HttpResponse as L, GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpResponse as M, LinkResponseObject as N, GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse as O, OdbcCustomDataType as P, UpdateDirectAccessAgentConnectorFileHttpResponse as Q, PatchDirectAccessAgentConfiguration207HttpResponse as R, GetDirectAccessAgentConfigurationHttpResponse as S, GetDirectAccessAgentConnectorFilesHttpError as T, PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError as U, PatchOperationResponse as V, PutDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpResponse as W, UpdateConfigurationFlatFileRequest as X, RunBenchmarkResponse as Y, UpdateDirectAccessAgentConnectorFileHttpError as Z, GetBenchmarkStatusResponse as _, restartDirectAccessAgent as _t, ConfigurationResponse as a, createDirectAccessAgentBenchmarkCancel as at, GetDirectAccessAgentBenchmarkHttpResponse as b, CreateDirectAccessAgentBenchmarkCancelHttpError as c, getDirectAccessAgentConfiguration as ct, CreateDirectAccessAgentBenchmarkHttpResponse as d, getDirectAccessAgentConnectorFilesWithoutQuery as dt, UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse as et, DirectAccessAgentsAPI as f, getDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths as ft, FileConnectorAllowedPathsResponse as g, putDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings as gt, FileConnectorAllowedPath as h, putDirectAccessAgentConnectorsFileConnectorFilesAllowedPaths as ht, ConfigurationLineString as i, createDirectAccessAgentBenchmark as it, GetDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappingsHttpError as j, GetDirectAccessAgentConnectorsFileConnectorFilesAllowedPathsHttpError as k, CreateDirectAccessAgentBenchmarkCancelHttpResponse as l, getDirectAccessAgentConnectorFile as lt, ErrorResponse as m, patchDirectAccessAgentConfiguration as mt, ConfigurationLineBase as n, UpdateOdbcCustomTypeMappingsRequest as nt, ConnectorFlatFileConfigurationResponse as o, directAccessAgentsExport as ot, ErrorMessage as p, getDirectAccessAgentConnectorsOdbcConnectorFilesCustomDataTypeMappings as pt, RestartDirectAccessAgentHttpError as q, ConfigurationLineNumeric as r, clearCache as rt, ConnectorSettings as s, getDirectAccessAgentBenchmark as st, CancelBenchmarkResponse as t, UpdateFileConnectorAllowedPathsRequest as tt, CreateDirectAccessAgentBenchmarkHttpError as u, getDirectAccessAgentConnectorFiles as ut, GetBenchmarkStatusResults as v, updateDirectAccessAgentConnectorFile as vt, GetDirectAccessAgentConnectorFileHttpResponse as w, GetDirectAccessAgentConfigurationHttpError as x, GetDirectAccessAgentBenchmarkHttpError as y, updateDirectAccessAgentConnectorFileWithoutQuery as yt, PatchDirectAccessAgentConfigurationHttpError as z };
|