@ibm-cloud/ibm_dph_services 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/dph/v1.d.ts +1517 -210
- package/dph/v1.js +1244 -179
- package/dph/v1.js.map +1 -1
- package/package.json +1 -1
package/dph/v1.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* (C) Copyright IBM Corp.
|
|
2
|
+
* (C) Copyright IBM Corp. 2025.
|
|
3
3
|
*
|
|
4
4
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
5
|
* you may not use this file except in compliance with the License.
|
|
@@ -14,12 +14,13 @@
|
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
16
|
/// <reference types="node" />
|
|
17
|
+
/// <reference types="node" />
|
|
17
18
|
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
|
|
18
19
|
import { BaseService, UserOptions } from 'ibm-cloud-sdk-core';
|
|
19
20
|
/**
|
|
20
21
|
* Data Product Hub API Service
|
|
21
22
|
*
|
|
22
|
-
* API Version: 1
|
|
23
|
+
* API Version: 1
|
|
23
24
|
*/
|
|
24
25
|
declare class DphV1 extends BaseService {
|
|
25
26
|
static DEFAULT_SERVICE_NAME: string;
|
|
@@ -112,19 +113,50 @@ declare class DphV1 extends BaseService {
|
|
|
112
113
|
* @returns {Promise<DphV1.Response<DphV1.EmptyObject>>}
|
|
113
114
|
*/
|
|
114
115
|
manageApiKeys(params?: DphV1.ManageApiKeysParams): Promise<DphV1.Response<DphV1.EmptyObject>>;
|
|
116
|
+
/*************************
|
|
117
|
+
* dataAssetVisualization
|
|
118
|
+
************************/
|
|
119
|
+
/**
|
|
120
|
+
* Create visualization asset and initialize profiling for the provided data assets.
|
|
121
|
+
*
|
|
122
|
+
* Use this API to create visualization asset and initialize profiling for the provided data assets<br/><br/>Provide
|
|
123
|
+
* the below required fields<br/><br/>Required fields:<br/><br/>- catalog_id<br/>- Collection of assetId with it's
|
|
124
|
+
* related asset id<br/><br/>.
|
|
125
|
+
*
|
|
126
|
+
* @param {Object} [params] - The parameters to send to the service.
|
|
127
|
+
* @param {DataAssetRelationship[]} [params.assets] - Data product hub asset and it's related part asset.
|
|
128
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
129
|
+
* @returns {Promise<DphV1.Response<DphV1.DataAssetVisualizationRes>>}
|
|
130
|
+
*/
|
|
131
|
+
createDataAssetVisualization(params?: DphV1.CreateDataAssetVisualizationParams): Promise<DphV1.Response<DphV1.DataAssetVisualizationRes>>;
|
|
132
|
+
/**
|
|
133
|
+
* Reinitiate visualization for an asset.
|
|
134
|
+
*
|
|
135
|
+
* Use this API to Reinitiate visualization for an asset which is in below scenarios<br/><br/>- Previous bucket got
|
|
136
|
+
* deleted and new bucket is created.<br/>- Data visualization attachment is missing in asset details.<br/>-
|
|
137
|
+
* Visualization asset reference is missing in related asset details.<br/><br/>.
|
|
138
|
+
*
|
|
139
|
+
* @param {Object} [params] - The parameters to send to the service.
|
|
140
|
+
* @param {DataAssetRelationship[]} [params.assets] - Data product hub asset and it's related part asset.
|
|
141
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
142
|
+
* @returns {Promise<DphV1.Response<DphV1.DataAssetVisualizationRes>>}
|
|
143
|
+
*/
|
|
144
|
+
reinitiateDataAssetVisualization(params?: DphV1.ReinitiateDataAssetVisualizationParams): Promise<DphV1.Response<DphV1.DataAssetVisualizationRes>>;
|
|
115
145
|
/*************************
|
|
116
146
|
* dataProducts
|
|
117
147
|
************************/
|
|
118
148
|
/**
|
|
149
|
+
* Retrieve a list of data products.
|
|
150
|
+
*
|
|
119
151
|
* Retrieve a list of data products.
|
|
120
152
|
*
|
|
121
153
|
* @param {Object} [params] - The parameters to send to the service.
|
|
122
154
|
* @param {number} [params.limit] - Limit the number of data products in the results. The maximum limit is 200.
|
|
123
155
|
* @param {string} [params.start] - Start token for pagination.
|
|
124
156
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
125
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
157
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductCollection>>}
|
|
126
158
|
*/
|
|
127
|
-
listDataProducts(params?: DphV1.ListDataProductsParams): Promise<DphV1.Response<DphV1.
|
|
159
|
+
listDataProducts(params?: DphV1.ListDataProductsParams): Promise<DphV1.Response<DphV1.DataProductCollection>>;
|
|
128
160
|
/**
|
|
129
161
|
* Create a new data product.
|
|
130
162
|
*
|
|
@@ -133,12 +165,16 @@ declare class DphV1 extends BaseService {
|
|
|
133
165
|
* default version **1.0.0** will be used.<br/><br/>The `domain` is optional.
|
|
134
166
|
*
|
|
135
167
|
* @param {Object} params - The parameters to send to the service.
|
|
136
|
-
* @param {
|
|
168
|
+
* @param {DataProductDraftPrototype[]} params.drafts - Collection of data products drafts to add to data product.
|
|
169
|
+
* @param {number} [params.limit] - Limit the number of data products in the results. The maximum limit is 200.
|
|
170
|
+
* @param {string} [params.start] - Start token for pagination.
|
|
137
171
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
138
172
|
* @returns {Promise<DphV1.Response<DphV1.DataProduct>>}
|
|
139
173
|
*/
|
|
140
174
|
createDataProduct(params: DphV1.CreateDataProductParams): Promise<DphV1.Response<DphV1.DataProduct>>;
|
|
141
175
|
/**
|
|
176
|
+
* Retrieve a data product identified by id.
|
|
177
|
+
*
|
|
142
178
|
* Retrieve a data product identified by id.
|
|
143
179
|
*
|
|
144
180
|
* @param {Object} params - The parameters to send to the service.
|
|
@@ -154,7 +190,8 @@ declare class DphV1 extends BaseService {
|
|
|
154
190
|
* Complete a contract document upload operation.
|
|
155
191
|
*
|
|
156
192
|
* After uploading a file to the provided signed URL, call this endpoint to mark the upload as complete. After the
|
|
157
|
-
* upload operation is marked as complete, the file is available to download.
|
|
193
|
+
* upload operation is marked as complete, the file is available to download. Use '-' for the `data_product_id` to
|
|
194
|
+
* skip specifying the data product ID explicitly.
|
|
158
195
|
* - After the upload is marked as complete, the returned URL is displayed in the "url" field. The signed URL is used
|
|
159
196
|
* to download the document.
|
|
160
197
|
* - Calling complete on referential documents results in an error.
|
|
@@ -172,6 +209,9 @@ declare class DphV1 extends BaseService {
|
|
|
172
209
|
/**
|
|
173
210
|
* Retrieve a list of data product drafts.
|
|
174
211
|
*
|
|
212
|
+
* Retrieve a list of data product drafts. Use '-' for the `data_product_id` to skip specifying the data product ID
|
|
213
|
+
* explicitly.
|
|
214
|
+
*
|
|
175
215
|
* @param {Object} params - The parameters to send to the service.
|
|
176
216
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
177
217
|
* @param {string} [params.assetContainerId] - Filter the list of data product drafts by container id.
|
|
@@ -183,6 +223,8 @@ declare class DphV1 extends BaseService {
|
|
|
183
223
|
*/
|
|
184
224
|
listDataProductDrafts(params: DphV1.ListDataProductDraftsParams): Promise<DphV1.Response<DphV1.DataProductDraftCollection>>;
|
|
185
225
|
/**
|
|
226
|
+
* Create a new draft of an existing data product.
|
|
227
|
+
*
|
|
186
228
|
* Create a new draft of an existing data product.
|
|
187
229
|
*
|
|
188
230
|
* @param {Object} params - The parameters to send to the service.
|
|
@@ -201,10 +243,7 @@ declare class DphV1 extends BaseService {
|
|
|
201
243
|
* @param {string[]} [params.tags] - Tags on the data product.
|
|
202
244
|
* @param {UseCase[]} [params.useCases] - A list of use cases associated with the data product version.
|
|
203
245
|
* @param {string[]} [params.types] - Types of parts on the data product.
|
|
204
|
-
* @param {
|
|
205
|
-
* product.
|
|
206
|
-
* @param {boolean} [params.isRestricted] - Indicates whether the data product is restricted or not. A restricted data
|
|
207
|
-
* product indicates that orders of the data product requires explicit approval before data is delivered.
|
|
246
|
+
* @param {ContractTerms[]} [params.contractTerms] - Contract terms binding various aspects of the data product.
|
|
208
247
|
* @param {Domain} [params.domain] - Domain that the data product version belongs to. If this is the first version of
|
|
209
248
|
* a data product, this field is required. If this is a new version of an existing data product, the domain will
|
|
210
249
|
* default to the domain of the previous version of the data product.
|
|
@@ -213,13 +252,23 @@ declare class DphV1 extends BaseService {
|
|
|
213
252
|
* version of an existing data product, the data product parts will default to the parts list from the previous
|
|
214
253
|
* version of the data product.
|
|
215
254
|
* @param {DataProductWorkflows} [params.workflows] - The workflows associated with the data product version.
|
|
255
|
+
* @param {boolean} [params.dataviewEnabled] - Indicates whether the dataView has enabled for data product.
|
|
256
|
+
* @param {string} [params.comments] - Comments by a producer that are provided either at the time of data product
|
|
257
|
+
* version creation or retiring.
|
|
258
|
+
* @param {AssetListAccessControl} [params.accessControl] - Access control object.
|
|
259
|
+
* @param {string} [params.lastUpdatedAt] - Timestamp of last asset update.
|
|
260
|
+
* @param {boolean} [params.isRestricted] - Indicates whether the data product is restricted or not. A restricted data
|
|
261
|
+
* product indicates that orders of the data product requires explicit approval before data is delivered.
|
|
216
262
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
217
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
263
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDraft>>}
|
|
218
264
|
*/
|
|
219
|
-
createDataProductDraft(params: DphV1.CreateDataProductDraftParams): Promise<DphV1.Response<DphV1.
|
|
265
|
+
createDataProductDraft(params: DphV1.CreateDataProductDraftParams): Promise<DphV1.Response<DphV1.DataProductDraft>>;
|
|
220
266
|
/**
|
|
221
267
|
* Upload a contract document to the data product draft contract terms.
|
|
222
268
|
*
|
|
269
|
+
* Upload a contract document to the data product draft identified by draft_id. Use '-' for the `data_product_id` to
|
|
270
|
+
* skip specifying the data product ID explicitly.
|
|
271
|
+
*
|
|
223
272
|
* - If the request object contains a "url" parameter, a referential document is created to store the provided url.
|
|
224
273
|
* - If the request object does not contain a "url" parameter, an attachment document is created, and a signed url
|
|
225
274
|
* will be returned in an "upload_url" parameter. The data product producer can upload the document using the provided
|
|
@@ -241,16 +290,22 @@ declare class DphV1 extends BaseService {
|
|
|
241
290
|
/**
|
|
242
291
|
* Get a draft of an existing data product.
|
|
243
292
|
*
|
|
293
|
+
* Get a draft of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID
|
|
294
|
+
* explicitly.
|
|
295
|
+
*
|
|
244
296
|
* @param {Object} params - The parameters to send to the service.
|
|
245
297
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
246
298
|
* @param {string} params.draftId - Data product draft id.
|
|
247
299
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
248
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
300
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDraft>>}
|
|
249
301
|
*/
|
|
250
|
-
getDataProductDraft(params: DphV1.GetDataProductDraftParams): Promise<DphV1.Response<DphV1.
|
|
302
|
+
getDataProductDraft(params: DphV1.GetDataProductDraftParams): Promise<DphV1.Response<DphV1.DataProductDraft>>;
|
|
251
303
|
/**
|
|
252
304
|
* Delete a data product draft identified by ID.
|
|
253
305
|
*
|
|
306
|
+
* Delete a data product draft identified by a valid ID. Use '-' for the `data_product_id` to skip specifying the data
|
|
307
|
+
* product ID explicitly.
|
|
308
|
+
*
|
|
254
309
|
* @param {Object} params - The parameters to send to the service.
|
|
255
310
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
256
311
|
* @param {string} params.draftId - Data product draft id.
|
|
@@ -261,10 +316,11 @@ declare class DphV1 extends BaseService {
|
|
|
261
316
|
/**
|
|
262
317
|
* Update the data product draft identified by ID.
|
|
263
318
|
*
|
|
264
|
-
* Use this API to update the properties of a data product draft identified by a valid ID
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
*
|
|
319
|
+
* Use this API to update the properties of a data product draft identified by a valid ID. Use '-' for the
|
|
320
|
+
* `data_product_id` to skip specifying the data product ID explicitly.<br/><br/>Specify patch operations using
|
|
321
|
+
* http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the properties of a
|
|
322
|
+
* data product<br/><br/>- Add/Remove parts from a data product (up to 20 parts)<br/><br/>- Add/Remove use cases from
|
|
323
|
+
* a data product<br/><br/>- Update the data product state<br/><br/>.
|
|
268
324
|
*
|
|
269
325
|
* @param {Object} params - The parameters to send to the service.
|
|
270
326
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -272,16 +328,17 @@ declare class DphV1 extends BaseService {
|
|
|
272
328
|
* @param {JsonPatchOperation[]} params.jsonPatchInstructions - A set of patch operations as defined in RFC 6902. See
|
|
273
329
|
* http://jsonpatch.com/ for more information.
|
|
274
330
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
275
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
331
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDraft>>}
|
|
276
332
|
*/
|
|
277
|
-
updateDataProductDraft(params: DphV1.UpdateDataProductDraftParams): Promise<DphV1.Response<DphV1.
|
|
333
|
+
updateDataProductDraft(params: DphV1.UpdateDataProductDraftParams): Promise<DphV1.Response<DphV1.DataProductDraft>>;
|
|
278
334
|
/**
|
|
279
335
|
* Get a contract document.
|
|
280
336
|
*
|
|
281
337
|
* If a document has a completed attachment, the response contains the `url` which can be used to download the
|
|
282
338
|
* attachment. If a document does not have a completed attachment, the response contains the `url` which was submitted
|
|
283
339
|
* at document creation. If a document has an attachment that is incomplete, an error is returned to prompt the user
|
|
284
|
-
* to upload the document file and complete it.
|
|
340
|
+
* to upload the document file and complete it. Use '-' for the `data_product_id` to skip specifying the data product
|
|
341
|
+
* ID explicitly.
|
|
285
342
|
*
|
|
286
343
|
* @param {Object} params - The parameters to send to the service.
|
|
287
344
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -295,7 +352,10 @@ declare class DphV1 extends BaseService {
|
|
|
295
352
|
/**
|
|
296
353
|
* Delete a contract document.
|
|
297
354
|
*
|
|
298
|
-
*
|
|
355
|
+
* Delete an existing contract document.
|
|
356
|
+
*
|
|
357
|
+
* Contract documents can only be deleted for data product versions that are in DRAFT state. Use '-' for the
|
|
358
|
+
* `data_product_id` to skip specifying the data product ID explicitly.
|
|
299
359
|
*
|
|
300
360
|
* @param {Object} params - The parameters to send to the service.
|
|
301
361
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -317,6 +377,7 @@ declare class DphV1 extends BaseService {
|
|
|
317
377
|
* - Update the url of document if it does not have an attachment.
|
|
318
378
|
* - Update the type of the document.
|
|
319
379
|
* <br/><br/>Contract terms documents can only be updated if the associated data product version is in DRAFT state.
|
|
380
|
+
* Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.
|
|
320
381
|
*
|
|
321
382
|
* @param {Object} params - The parameters to send to the service.
|
|
322
383
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -329,38 +390,111 @@ declare class DphV1 extends BaseService {
|
|
|
329
390
|
* @returns {Promise<DphV1.Response<DphV1.ContractTermsDocument>>}
|
|
330
391
|
*/
|
|
331
392
|
updateDraftContractTermsDocument(params: DphV1.UpdateDraftContractTermsDocumentParams): Promise<DphV1.Response<DphV1.ContractTermsDocument>>;
|
|
393
|
+
/**
|
|
394
|
+
* Retrieve a data product contract terms identified by id.
|
|
395
|
+
*
|
|
396
|
+
* Retrieve a data product contract terms identified by id.
|
|
397
|
+
*
|
|
398
|
+
* @param {Object} params - The parameters to send to the service.
|
|
399
|
+
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
400
|
+
* @param {string} params.draftId - Data product draft id.
|
|
401
|
+
* @param {string} params.contractTermsId - Contract terms id.
|
|
402
|
+
* @param {string} [params.accept] - The type of the response: application/odcs+yaml or application/json.
|
|
403
|
+
* @param {boolean} [params.includeContractDocuments] - Set to false to exclude external contract documents (e.g.,
|
|
404
|
+
* Terms and Conditions URLs) from the response. By default, these are included.
|
|
405
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
406
|
+
* @returns {Promise<DphV1.Response<NodeJS.ReadableStream>>}
|
|
407
|
+
*/
|
|
408
|
+
getDataProductDraftContractTerms(params: DphV1.GetDataProductDraftContractTermsParams): Promise<DphV1.Response<NodeJS.ReadableStream>>;
|
|
409
|
+
/**
|
|
410
|
+
* Update a data product contract terms identified by id.
|
|
411
|
+
*
|
|
412
|
+
* Update a data product contract terms identified by id.
|
|
413
|
+
*
|
|
414
|
+
* @param {Object} params - The parameters to send to the service.
|
|
415
|
+
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
416
|
+
* @param {string} params.draftId - Data product draft id.
|
|
417
|
+
* @param {string} params.contractTermsId - Contract terms id.
|
|
418
|
+
* @param {AssetReference} [params.asset] - The reference schema for a asset in a container.
|
|
419
|
+
* @param {string} [params.id] - ID of the contract terms.
|
|
420
|
+
* @param {ContractTermsDocument[]} [params.documents] - Collection of contract terms documents.
|
|
421
|
+
* @param {string} [params.errorMsg] - An error message, if existing, relating to the contract terms.
|
|
422
|
+
* @param {Overview} [params.overview] - Overview details of a data contract.
|
|
423
|
+
* @param {Description} [params.description] - Description details of a data contract.
|
|
424
|
+
* @param {ContractTemplateOrganization[]} [params.organization] - List of sub domains to be added within a domain.
|
|
425
|
+
* @param {Roles[]} [params.roles] - List of roles associated with the contract.
|
|
426
|
+
* @param {Pricing} [params.price] - Represents the pricing details of the contract.
|
|
427
|
+
* @param {ContractTemplateSLA[]} [params.sla] - Service Level Agreement details.
|
|
428
|
+
* @param {ContractTemplateSupportAndCommunication[]} [params.supportAndCommunication] - Support and communication
|
|
429
|
+
* details for the contract.
|
|
430
|
+
* @param {ContractTemplateCustomProperty[]} [params.customProperties] - Custom properties that are not part of the
|
|
431
|
+
* standard contract.
|
|
432
|
+
* @param {ContractTest} [params.contractTest] - Contains the contract test status and related metadata.
|
|
433
|
+
* @param {ContractSchema[]} [params.schema] - Schema details of the data asset.
|
|
434
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
435
|
+
* @returns {Promise<DphV1.Response<DphV1.ContractTerms>>}
|
|
436
|
+
*/
|
|
437
|
+
replaceDataProductDraftContractTerms(params: DphV1.ReplaceDataProductDraftContractTermsParams): Promise<DphV1.Response<DphV1.ContractTerms>>;
|
|
438
|
+
/**
|
|
439
|
+
* Update a contract terms property.
|
|
440
|
+
*
|
|
441
|
+
* Use this API to update the properties of a contract terms that is identified by a valid ID.
|
|
442
|
+
*
|
|
443
|
+
* Specify patch operations using http://jsonpatch.com/ syntax.
|
|
444
|
+
*
|
|
445
|
+
* Supported patch operations include:
|
|
446
|
+
* - Update the contract terms properties.
|
|
447
|
+
* <br/><br/>Contract terms can only be updated if the associated data product version is in DRAFT state.
|
|
448
|
+
*
|
|
449
|
+
* @param {Object} params - The parameters to send to the service.
|
|
450
|
+
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
451
|
+
* @param {string} params.draftId - Data product draft id.
|
|
452
|
+
* @param {string} params.contractTermsId - Contract terms id.
|
|
453
|
+
* @param {JsonPatchOperation[]} params.jsonPatchInstructions - A set of patch operations as defined in RFC 6902. See
|
|
454
|
+
* http://jsonpatch.com/ for more information.
|
|
455
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
456
|
+
* @returns {Promise<DphV1.Response<DphV1.ContractTerms>>}
|
|
457
|
+
*/
|
|
458
|
+
updateDataProductDraftContractTerms(params: DphV1.UpdateDataProductDraftContractTermsParams): Promise<DphV1.Response<DphV1.ContractTerms>>;
|
|
332
459
|
/**
|
|
333
460
|
* Publish a draft of an existing data product.
|
|
334
461
|
*
|
|
462
|
+
* Publish a draft of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product
|
|
463
|
+
* ID explicitly.
|
|
464
|
+
*
|
|
335
465
|
* @param {Object} params - The parameters to send to the service.
|
|
336
466
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
337
467
|
* @param {string} params.draftId - Data product draft id.
|
|
338
468
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
339
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
469
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductRelease>>}
|
|
340
470
|
*/
|
|
341
|
-
publishDataProductDraft(params: DphV1.PublishDataProductDraftParams): Promise<DphV1.Response<DphV1.
|
|
471
|
+
publishDataProductDraft(params: DphV1.PublishDataProductDraftParams): Promise<DphV1.Response<DphV1.DataProductRelease>>;
|
|
342
472
|
/*************************
|
|
343
473
|
* dataProductReleases
|
|
344
474
|
************************/
|
|
345
475
|
/**
|
|
346
476
|
* Get a release of an existing data product.
|
|
347
477
|
*
|
|
478
|
+
* Get a release of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID
|
|
479
|
+
* explicitly.
|
|
480
|
+
*
|
|
348
481
|
* @param {Object} params - The parameters to send to the service.
|
|
349
482
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
350
483
|
* @param {string} params.releaseId - Data product release id.
|
|
351
484
|
* @param {boolean} [params.checkCallerApproval] - If the value is true, then it will be verfied whether the caller is
|
|
352
485
|
* present in the data access request pre-approved user list.
|
|
353
486
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
354
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
487
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductRelease>>}
|
|
355
488
|
*/
|
|
356
|
-
getDataProductRelease(params: DphV1.GetDataProductReleaseParams): Promise<DphV1.Response<DphV1.
|
|
489
|
+
getDataProductRelease(params: DphV1.GetDataProductReleaseParams): Promise<DphV1.Response<DphV1.DataProductRelease>>;
|
|
357
490
|
/**
|
|
358
491
|
* Update the data product release identified by ID.
|
|
359
492
|
*
|
|
360
|
-
* Use this API to update the properties of a data product release identified by a valid ID
|
|
361
|
-
*
|
|
362
|
-
*
|
|
363
|
-
*
|
|
493
|
+
* Use this API to update the properties of a data product release identified by a valid ID. Use '-' for the
|
|
494
|
+
* `data_product_id` to skip specifying the data product ID explicitly.<br/><br/>Specify patch operations using
|
|
495
|
+
* http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the properties of a
|
|
496
|
+
* data product<br/><br/>- Add/remove parts from a data product (up to 20 parts)<br/><br/>- Add/remove use cases from
|
|
497
|
+
* a data product<br/><br/>.
|
|
364
498
|
*
|
|
365
499
|
* @param {Object} params - The parameters to send to the service.
|
|
366
500
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -368,16 +502,17 @@ declare class DphV1 extends BaseService {
|
|
|
368
502
|
* @param {JsonPatchOperation[]} params.jsonPatchInstructions - A set of patch operations as defined in RFC 6902. See
|
|
369
503
|
* http://jsonpatch.com/ for more information.
|
|
370
504
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
371
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
505
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductRelease>>}
|
|
372
506
|
*/
|
|
373
|
-
updateDataProductRelease(params: DphV1.UpdateDataProductReleaseParams): Promise<DphV1.Response<DphV1.
|
|
507
|
+
updateDataProductRelease(params: DphV1.UpdateDataProductReleaseParams): Promise<DphV1.Response<DphV1.DataProductRelease>>;
|
|
374
508
|
/**
|
|
375
509
|
* Get a contract document.
|
|
376
510
|
*
|
|
377
511
|
* If the document has a completed attachment, the response contains the `url` to download the attachment.<br/><br/>
|
|
378
512
|
* If the document does not have an attachment, the response contains the `url` which was submitted at document
|
|
379
513
|
* creation.<br/><br/> If the document has an incomplete attachment, an error is returned to prompt the user to upload
|
|
380
|
-
* the document file to complete the attachment.
|
|
514
|
+
* the document file to complete the attachment. Use '-' for the `data_product_id` to skip specifying the data product
|
|
515
|
+
* ID explicitly.
|
|
381
516
|
*
|
|
382
517
|
* @param {Object} params - The parameters to send to the service.
|
|
383
518
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -391,6 +526,9 @@ declare class DphV1 extends BaseService {
|
|
|
391
526
|
/**
|
|
392
527
|
* Retrieve a list of data product releases.
|
|
393
528
|
*
|
|
529
|
+
* Retrieve a list of data product releases. Use '-' for the `data_product_id` to skip specifying the data product ID
|
|
530
|
+
* explicitly.
|
|
531
|
+
*
|
|
394
532
|
* @param {Object} params - The parameters to send to the service.
|
|
395
533
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
396
534
|
* @param {string} [params.assetContainerId] - Filter the list of data product releases by container id.
|
|
@@ -406,13 +544,222 @@ declare class DphV1 extends BaseService {
|
|
|
406
544
|
/**
|
|
407
545
|
* Retire a release of an existing data product.
|
|
408
546
|
*
|
|
547
|
+
* Retire a release of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product
|
|
548
|
+
* ID explicitly.
|
|
549
|
+
*
|
|
409
550
|
* @param {Object} params - The parameters to send to the service.
|
|
410
551
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
411
552
|
* @param {string} params.releaseId - Data product release id.
|
|
553
|
+
* @param {boolean} [params.revokeAccess] - Revoke's Access from all the Subscriptions of the Data Product. No user's
|
|
554
|
+
* can able to see the subscribed assets anymore.
|
|
555
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
556
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductRelease>>}
|
|
557
|
+
*/
|
|
558
|
+
retireDataProductRelease(params: DphV1.RetireDataProductReleaseParams): Promise<DphV1.Response<DphV1.DataProductRelease>>;
|
|
559
|
+
/*************************
|
|
560
|
+
* dataProductContractTemplates
|
|
561
|
+
************************/
|
|
562
|
+
/**
|
|
563
|
+
* Retrieve a list of data product contract templates.
|
|
564
|
+
*
|
|
565
|
+
* Retrieve a list of data product contract templates.
|
|
566
|
+
*
|
|
567
|
+
* @param {Object} [params] - The parameters to send to the service.
|
|
568
|
+
* @param {string} [params.containerId] - Container ID of the data product catalog. If not supplied, the data product
|
|
569
|
+
* catalog is looked up by using the uid of the default data product catalog.
|
|
570
|
+
* @param {string} [params.contractTemplateName] - Name of the data product contract template. If not supplied, the
|
|
571
|
+
* data product templates within the catalog will returned.
|
|
572
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
573
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductContractTemplateCollection>>}
|
|
574
|
+
*/
|
|
575
|
+
listDataProductContractTemplate(params?: DphV1.ListDataProductContractTemplateParams): Promise<DphV1.Response<DphV1.DataProductContractTemplateCollection>>;
|
|
576
|
+
/**
|
|
577
|
+
* Create new data product contract template.
|
|
578
|
+
*
|
|
579
|
+
* Create new data product contract template.
|
|
580
|
+
*
|
|
581
|
+
* @param {Object} params - The parameters to send to the service.
|
|
582
|
+
* @param {ContainerReference} params.container - Container reference.
|
|
583
|
+
* @param {string} [params.id] - The identifier of the data product contract template.
|
|
584
|
+
* @param {string} [params.name] - The name of the contract template.
|
|
585
|
+
* @param {ErrorMessage} [params.error] - Contains the code and details.
|
|
586
|
+
* @param {ContractTerms} [params.contractTerms] - Defines the complete structure of a contract terms.
|
|
587
|
+
* @param {string} [params.containerId] - Container ID of the data product catalog. If not supplied, the data product
|
|
588
|
+
* catalog is looked up by using the uid of the default data product catalog.
|
|
589
|
+
* @param {string} [params.contractTemplateName] - Name of the data product contract template. If not supplied, the
|
|
590
|
+
* data product templates within the catalog will returned.
|
|
591
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
592
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductContractTemplate>>}
|
|
593
|
+
*/
|
|
594
|
+
createContractTemplate(params: DphV1.CreateContractTemplateParams): Promise<DphV1.Response<DphV1.DataProductContractTemplate>>;
|
|
595
|
+
/**
|
|
596
|
+
* Retrieve a data product contract template identified by id.
|
|
597
|
+
*
|
|
598
|
+
* Retrieve a data product contract template identified by id.
|
|
599
|
+
*
|
|
600
|
+
* @param {Object} params - The parameters to send to the service.
|
|
601
|
+
* @param {string} params.contractTemplateId - Data Product Contract Template id.
|
|
602
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
603
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
604
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductContractTemplate>>}
|
|
605
|
+
*/
|
|
606
|
+
getContractTemplate(params: DphV1.GetContractTemplateParams): Promise<DphV1.Response<DphV1.DataProductContractTemplate>>;
|
|
607
|
+
/**
|
|
608
|
+
* Delete a data product contract template identified by id.
|
|
609
|
+
*
|
|
610
|
+
* Delete a data product contract template identified by id.
|
|
611
|
+
*
|
|
612
|
+
* @param {Object} params - The parameters to send to the service.
|
|
613
|
+
* @param {string} params.contractTemplateId - Data Product Contract Template id.
|
|
614
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
615
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
616
|
+
* @returns {Promise<DphV1.Response<DphV1.EmptyObject>>}
|
|
617
|
+
*/
|
|
618
|
+
deleteDataProductContractTemplate(params: DphV1.DeleteDataProductContractTemplateParams): Promise<DphV1.Response<DphV1.EmptyObject>>;
|
|
619
|
+
/**
|
|
620
|
+
* Update the data product contract template identified by ID.
|
|
621
|
+
*
|
|
622
|
+
* Use this API to update the properties of a data product contract template identified by a valid
|
|
623
|
+
* ID.<br/><br/>Specify patch operations using http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations
|
|
624
|
+
* include:<br/><br/>- Update the name of a data product contract template<br/><br/>- Update the contract terms of
|
|
625
|
+
* data product contract template<br/><br/>.
|
|
626
|
+
*
|
|
627
|
+
* @param {Object} params - The parameters to send to the service.
|
|
628
|
+
* @param {string} params.contractTemplateId - Data Product Contract Template id.
|
|
629
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
630
|
+
* @param {JsonPatchOperation[]} params.jsonPatchInstructions - A set of patch operations as defined in RFC 6902. See
|
|
631
|
+
* http://jsonpatch.com/ for more information.
|
|
632
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
633
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductContractTemplate>>}
|
|
634
|
+
*/
|
|
635
|
+
updateDataProductContractTemplate(params: DphV1.UpdateDataProductContractTemplateParams): Promise<DphV1.Response<DphV1.DataProductContractTemplate>>;
|
|
636
|
+
/*************************
|
|
637
|
+
* dataProductDomains
|
|
638
|
+
************************/
|
|
639
|
+
/**
|
|
640
|
+
* Retrieve a list of data product domains.
|
|
641
|
+
*
|
|
642
|
+
* Retrieve a list of data product domains.
|
|
643
|
+
*
|
|
644
|
+
* @param {Object} [params] - The parameters to send to the service.
|
|
645
|
+
* @param {string} [params.containerId] - Container ID of the data product catalog. If not supplied, the data product
|
|
646
|
+
* catalog is looked up by using the uid of the default data product catalog.
|
|
647
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
648
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDomainCollection>>}
|
|
649
|
+
*/
|
|
650
|
+
listDataProductDomains(params?: DphV1.ListDataProductDomainsParams): Promise<DphV1.Response<DphV1.DataProductDomainCollection>>;
|
|
651
|
+
/**
|
|
652
|
+
* Create new data product domain.
|
|
653
|
+
*
|
|
654
|
+
* Create new data product domain.
|
|
655
|
+
*
|
|
656
|
+
* @param {Object} params - The parameters to send to the service.
|
|
657
|
+
* @param {ContainerReference} params.container - Container reference.
|
|
658
|
+
* @param {string} [params.trace] - The id to trace the failed domain creations.
|
|
659
|
+
* @param {ErrorModelResource[]} [params.errors] - Set of errors on the sub domain creation.
|
|
660
|
+
* @param {string} [params.name] - The name of the data product domain.
|
|
661
|
+
* @param {string} [params.description] - The description of the data product domain.
|
|
662
|
+
* @param {string} [params.id] - The identifier of the data product domain.
|
|
663
|
+
* @param {MemberRolesSchema} [params.memberRoles] - Member roles of a corresponding asset.
|
|
664
|
+
* @param {PropertiesSchema} [params.properties] - Properties of the corresponding asset.
|
|
665
|
+
* @param {InitializeSubDomain[]} [params.subDomains] - List of sub domains to be added within a domain.
|
|
666
|
+
* @param {string} [params.containerId] - Container ID of the data product catalog. If not supplied, the data product
|
|
667
|
+
* catalog is looked up by using the uid of the default data product catalog.
|
|
412
668
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
413
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
669
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDomain>>}
|
|
414
670
|
*/
|
|
415
|
-
|
|
671
|
+
createDataProductDomain(params: DphV1.CreateDataProductDomainParams): Promise<DphV1.Response<DphV1.DataProductDomain>>;
|
|
672
|
+
/**
|
|
673
|
+
* Create data product subdomains for a specific domain identified by id.
|
|
674
|
+
*
|
|
675
|
+
* Create data product subdomains for a specific domain identified by id.
|
|
676
|
+
*
|
|
677
|
+
* @param {Object} params - The parameters to send to the service.
|
|
678
|
+
* @param {string} params.domainId - Domain id.
|
|
679
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
680
|
+
* @param {string} [params.name] - The name of the data product subdomain.
|
|
681
|
+
* @param {string} [params.id] - The identifier of the data product subdomain.
|
|
682
|
+
* @param {string} [params.description] - The description of the data product subdomain.
|
|
683
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
684
|
+
* @returns {Promise<DphV1.Response<DphV1.InitializeSubDomain>>}
|
|
685
|
+
*/
|
|
686
|
+
createDataProductSubdomain(params: DphV1.CreateDataProductSubdomainParams): Promise<DphV1.Response<DphV1.InitializeSubDomain>>;
|
|
687
|
+
/**
|
|
688
|
+
* Retrieve a data product domain or subdomain identified by id.
|
|
689
|
+
*
|
|
690
|
+
* Retrieve a data product domain or subdomain identified by id.
|
|
691
|
+
*
|
|
692
|
+
* @param {Object} params - The parameters to send to the service.
|
|
693
|
+
* @param {string} params.domainId - Domain id.
|
|
694
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
695
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDomain>>}
|
|
696
|
+
*/
|
|
697
|
+
getDomain(params: DphV1.GetDomainParams): Promise<DphV1.Response<DphV1.DataProductDomain>>;
|
|
698
|
+
/**
|
|
699
|
+
* Delete a data product domain identified by id.
|
|
700
|
+
*
|
|
701
|
+
* Delete a data product domain identified by id.
|
|
702
|
+
*
|
|
703
|
+
* @param {Object} params - The parameters to send to the service.
|
|
704
|
+
* @param {string} params.domainId - Domain id.
|
|
705
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
706
|
+
* @returns {Promise<DphV1.Response<DphV1.EmptyObject>>}
|
|
707
|
+
*/
|
|
708
|
+
deleteDomain(params: DphV1.DeleteDomainParams): Promise<DphV1.Response<DphV1.EmptyObject>>;
|
|
709
|
+
/**
|
|
710
|
+
* Update the data product domain identified by ID.
|
|
711
|
+
*
|
|
712
|
+
* Use this API to update the properties of a data product domain identified by a valid ID.<br/><br/>Specify patch
|
|
713
|
+
* operations using http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the
|
|
714
|
+
* name of a data product domain<br/><br/>- Update the description of a data product domain<br/><br/>- Update the rov
|
|
715
|
+
* of a data product domain<br/><br/>.
|
|
716
|
+
*
|
|
717
|
+
* @param {Object} params - The parameters to send to the service.
|
|
718
|
+
* @param {string} params.domainId - Domain id.
|
|
719
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
720
|
+
* @param {JsonPatchOperation[]} params.jsonPatchInstructions - A set of patch operations as defined in RFC 6902. See
|
|
721
|
+
* http://jsonpatch.com/ for more information.
|
|
722
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
723
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDomain>>}
|
|
724
|
+
*/
|
|
725
|
+
updateDataProductDomain(params: DphV1.UpdateDataProductDomainParams): Promise<DphV1.Response<DphV1.DataProductDomain>>;
|
|
726
|
+
/**
|
|
727
|
+
* Retrieve all data products in a domain specified by id or any of it's subdomains.
|
|
728
|
+
*
|
|
729
|
+
* Retrieve all the data products tagged to the domain identified by id or any of it's subdomains.
|
|
730
|
+
*
|
|
731
|
+
* @param {Object} params - The parameters to send to the service.
|
|
732
|
+
* @param {string} params.domainId - Domain id.
|
|
733
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
734
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
735
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductVersionCollection>>}
|
|
736
|
+
*/
|
|
737
|
+
getDataProductByDomain(params: DphV1.GetDataProductByDomainParams): Promise<DphV1.Response<DphV1.DataProductVersionCollection>>;
|
|
738
|
+
/*************************
|
|
739
|
+
* bucketServices
|
|
740
|
+
************************/
|
|
741
|
+
/**
|
|
742
|
+
* Create a new Bucket.
|
|
743
|
+
*
|
|
744
|
+
* Use this API to create a new S3 Bucket on an AWS Hosting.
|
|
745
|
+
*
|
|
746
|
+
* @param {Object} params - The parameters to send to the service.
|
|
747
|
+
* @param {boolean} params.isShared - Flag to specify whether the bucket is dedicated or shared.
|
|
748
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
749
|
+
* @returns {Promise<DphV1.Response<DphV1.BucketResponse>>}
|
|
750
|
+
*/
|
|
751
|
+
createS3Bucket(params: DphV1.CreateS3BucketParams): Promise<DphV1.Response<DphV1.BucketResponse>>;
|
|
752
|
+
/**
|
|
753
|
+
* Validate the Bucket Existence.
|
|
754
|
+
*
|
|
755
|
+
* Use this API to validate the bucket existence on an AWS hosting.
|
|
756
|
+
*
|
|
757
|
+
* @param {Object} params - The parameters to send to the service.
|
|
758
|
+
* @param {string} params.bucketName - Name of the bucket to validate.
|
|
759
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
760
|
+
* @returns {Promise<DphV1.Response<DphV1.BucketValidationResponse>>}
|
|
761
|
+
*/
|
|
762
|
+
getS3BucketValidation(params: DphV1.GetS3BucketValidationParams): Promise<DphV1.Response<DphV1.BucketValidationResponse>>;
|
|
416
763
|
}
|
|
417
764
|
/*************************
|
|
418
765
|
* interfaces
|
|
@@ -467,14 +814,25 @@ declare namespace DphV1 {
|
|
|
467
814
|
WORKFLOWS = "workflows",
|
|
468
815
|
PROJECT = "project",
|
|
469
816
|
CATALOG_CONFIGURATIONS = "catalog_configurations",
|
|
470
|
-
FUNCTIONAL_ADMIN_USER_GROUP = "functional_admin_user_group"
|
|
471
|
-
ACCOUNT_OWNER_INTO_CATALOG_MEMBERS = "account_owner_into_catalog_members"
|
|
817
|
+
FUNCTIONAL_ADMIN_USER_GROUP = "functional_admin_user_group"
|
|
472
818
|
}
|
|
473
819
|
}
|
|
474
820
|
/** Parameters for the `manageApiKeys` operation. */
|
|
475
821
|
interface ManageApiKeysParams {
|
|
476
822
|
headers?: OutgoingHttpHeaders;
|
|
477
823
|
}
|
|
824
|
+
/** Parameters for the `createDataAssetVisualization` operation. */
|
|
825
|
+
interface CreateDataAssetVisualizationParams {
|
|
826
|
+
/** Data product hub asset and it's related part asset. */
|
|
827
|
+
assets?: DataAssetRelationship[];
|
|
828
|
+
headers?: OutgoingHttpHeaders;
|
|
829
|
+
}
|
|
830
|
+
/** Parameters for the `reinitiateDataAssetVisualization` operation. */
|
|
831
|
+
interface ReinitiateDataAssetVisualizationParams {
|
|
832
|
+
/** Data product hub asset and it's related part asset. */
|
|
833
|
+
assets?: DataAssetRelationship[];
|
|
834
|
+
headers?: OutgoingHttpHeaders;
|
|
835
|
+
}
|
|
478
836
|
/** Parameters for the `listDataProducts` operation. */
|
|
479
837
|
interface ListDataProductsParams {
|
|
480
838
|
/** Limit the number of data products in the results. The maximum limit is 200. */
|
|
@@ -486,7 +844,11 @@ declare namespace DphV1 {
|
|
|
486
844
|
/** Parameters for the `createDataProduct` operation. */
|
|
487
845
|
interface CreateDataProductParams {
|
|
488
846
|
/** Collection of data products drafts to add to data product. */
|
|
489
|
-
drafts:
|
|
847
|
+
drafts: DataProductDraftPrototype[];
|
|
848
|
+
/** Limit the number of data products in the results. The maximum limit is 200. */
|
|
849
|
+
limit?: number;
|
|
850
|
+
/** Start token for pagination. */
|
|
851
|
+
start?: string;
|
|
490
852
|
headers?: OutgoingHttpHeaders;
|
|
491
853
|
}
|
|
492
854
|
/** Parameters for the `getDataProduct` operation. */
|
|
@@ -552,11 +914,7 @@ declare namespace DphV1 {
|
|
|
552
914
|
/** Types of parts on the data product. */
|
|
553
915
|
types?: CreateDataProductDraftConstants.Types[] | string[];
|
|
554
916
|
/** Contract terms binding various aspects of the data product. */
|
|
555
|
-
contractTerms?:
|
|
556
|
-
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
557
|
-
* the data product requires explicit approval before data is delivered.
|
|
558
|
-
*/
|
|
559
|
-
isRestricted?: boolean;
|
|
917
|
+
contractTerms?: ContractTerms[];
|
|
560
918
|
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
561
919
|
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
562
920
|
* previous version of the data product.
|
|
@@ -569,6 +927,18 @@ declare namespace DphV1 {
|
|
|
569
927
|
partsOut?: DataProductPart[];
|
|
570
928
|
/** The workflows associated with the data product version. */
|
|
571
929
|
workflows?: DataProductWorkflows;
|
|
930
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
931
|
+
dataviewEnabled?: boolean;
|
|
932
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
933
|
+
comments?: string;
|
|
934
|
+
/** Access control object. */
|
|
935
|
+
accessControl?: AssetListAccessControl;
|
|
936
|
+
/** Timestamp of last asset update. */
|
|
937
|
+
lastUpdatedAt?: string;
|
|
938
|
+
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
939
|
+
* the data product requires explicit approval before data is delivered.
|
|
940
|
+
*/
|
|
941
|
+
isRestricted?: boolean;
|
|
572
942
|
headers?: OutgoingHttpHeaders;
|
|
573
943
|
}
|
|
574
944
|
/** Constants for the `createDataProductDraft` operation. */
|
|
@@ -673,6 +1043,80 @@ declare namespace DphV1 {
|
|
|
673
1043
|
jsonPatchInstructions: JsonPatchOperation[];
|
|
674
1044
|
headers?: OutgoingHttpHeaders;
|
|
675
1045
|
}
|
|
1046
|
+
/** Parameters for the `getDataProductDraftContractTerms` operation. */
|
|
1047
|
+
interface GetDataProductDraftContractTermsParams {
|
|
1048
|
+
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
1049
|
+
dataProductId: string;
|
|
1050
|
+
/** Data product draft id. */
|
|
1051
|
+
draftId: string;
|
|
1052
|
+
/** Contract terms id. */
|
|
1053
|
+
contractTermsId: string;
|
|
1054
|
+
/** The type of the response: application/odcs+yaml or application/json. */
|
|
1055
|
+
accept?: GetDataProductDraftContractTermsConstants.Accept | string;
|
|
1056
|
+
/** Set to false to exclude external contract documents (e.g., Terms and Conditions URLs) from the response. By
|
|
1057
|
+
* default, these are included.
|
|
1058
|
+
*/
|
|
1059
|
+
includeContractDocuments?: boolean;
|
|
1060
|
+
headers?: OutgoingHttpHeaders;
|
|
1061
|
+
}
|
|
1062
|
+
/** Constants for the `getDataProductDraftContractTerms` operation. */
|
|
1063
|
+
namespace GetDataProductDraftContractTermsConstants {
|
|
1064
|
+
/** The type of the response: application/odcs+yaml or application/json. */
|
|
1065
|
+
enum Accept {
|
|
1066
|
+
APPLICATION_ODCS_YAML = "application/odcs+yaml",
|
|
1067
|
+
APPLICATION_JSON = "application/json"
|
|
1068
|
+
}
|
|
1069
|
+
}
|
|
1070
|
+
/** Parameters for the `replaceDataProductDraftContractTerms` operation. */
|
|
1071
|
+
interface ReplaceDataProductDraftContractTermsParams {
|
|
1072
|
+
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
1073
|
+
dataProductId: string;
|
|
1074
|
+
/** Data product draft id. */
|
|
1075
|
+
draftId: string;
|
|
1076
|
+
/** Contract terms id. */
|
|
1077
|
+
contractTermsId: string;
|
|
1078
|
+
/** The reference schema for a asset in a container. */
|
|
1079
|
+
asset?: AssetReference;
|
|
1080
|
+
/** ID of the contract terms. */
|
|
1081
|
+
id?: string;
|
|
1082
|
+
/** Collection of contract terms documents. */
|
|
1083
|
+
documents?: ContractTermsDocument[];
|
|
1084
|
+
/** An error message, if existing, relating to the contract terms. */
|
|
1085
|
+
errorMsg?: string;
|
|
1086
|
+
/** Overview details of a data contract. */
|
|
1087
|
+
overview?: Overview;
|
|
1088
|
+
/** Description details of a data contract. */
|
|
1089
|
+
description?: Description;
|
|
1090
|
+
/** List of sub domains to be added within a domain. */
|
|
1091
|
+
organization?: ContractTemplateOrganization[];
|
|
1092
|
+
/** List of roles associated with the contract. */
|
|
1093
|
+
roles?: Roles[];
|
|
1094
|
+
/** Represents the pricing details of the contract. */
|
|
1095
|
+
price?: Pricing;
|
|
1096
|
+
/** Service Level Agreement details. */
|
|
1097
|
+
sla?: ContractTemplateSLA[];
|
|
1098
|
+
/** Support and communication details for the contract. */
|
|
1099
|
+
supportAndCommunication?: ContractTemplateSupportAndCommunication[];
|
|
1100
|
+
/** Custom properties that are not part of the standard contract. */
|
|
1101
|
+
customProperties?: ContractTemplateCustomProperty[];
|
|
1102
|
+
/** Contains the contract test status and related metadata. */
|
|
1103
|
+
contractTest?: ContractTest;
|
|
1104
|
+
/** Schema details of the data asset. */
|
|
1105
|
+
schema?: ContractSchema[];
|
|
1106
|
+
headers?: OutgoingHttpHeaders;
|
|
1107
|
+
}
|
|
1108
|
+
/** Parameters for the `updateDataProductDraftContractTerms` operation. */
|
|
1109
|
+
interface UpdateDataProductDraftContractTermsParams {
|
|
1110
|
+
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
1111
|
+
dataProductId: string;
|
|
1112
|
+
/** Data product draft id. */
|
|
1113
|
+
draftId: string;
|
|
1114
|
+
/** Contract terms id. */
|
|
1115
|
+
contractTermsId: string;
|
|
1116
|
+
/** A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information. */
|
|
1117
|
+
jsonPatchInstructions: JsonPatchOperation[];
|
|
1118
|
+
headers?: OutgoingHttpHeaders;
|
|
1119
|
+
}
|
|
676
1120
|
/** Parameters for the `publishDataProductDraft` operation. */
|
|
677
1121
|
interface PublishDataProductDraftParams {
|
|
678
1122
|
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
@@ -747,41 +1191,229 @@ declare namespace DphV1 {
|
|
|
747
1191
|
dataProductId: string;
|
|
748
1192
|
/** Data product release id. */
|
|
749
1193
|
releaseId: string;
|
|
1194
|
+
/** Revoke's Access from all the Subscriptions of the Data Product. No user's can able to see the subscribed
|
|
1195
|
+
* assets anymore.
|
|
1196
|
+
*/
|
|
1197
|
+
revokeAccess?: boolean;
|
|
750
1198
|
headers?: OutgoingHttpHeaders;
|
|
751
1199
|
}
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
1200
|
+
/** Parameters for the `listDataProductContractTemplate` operation. */
|
|
1201
|
+
interface ListDataProductContractTemplateParams {
|
|
1202
|
+
/** Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using
|
|
1203
|
+
* the uid of the default data product catalog.
|
|
1204
|
+
*/
|
|
1205
|
+
containerId?: string;
|
|
1206
|
+
/** Name of the data product contract template. If not supplied, the data product templates within the catalog
|
|
1207
|
+
* will returned.
|
|
1208
|
+
*/
|
|
1209
|
+
contractTemplateName?: string;
|
|
1210
|
+
headers?: OutgoingHttpHeaders;
|
|
1211
|
+
}
|
|
1212
|
+
/** Parameters for the `createContractTemplate` operation. */
|
|
1213
|
+
interface CreateContractTemplateParams {
|
|
761
1214
|
/** Container reference. */
|
|
762
1215
|
container: ContainerReference;
|
|
763
|
-
/** The
|
|
764
|
-
type?: string;
|
|
765
|
-
}
|
|
766
|
-
/**
|
|
767
|
-
* New asset input properties.
|
|
768
|
-
*/
|
|
769
|
-
interface AssetPrototype {
|
|
770
|
-
/** The unique identifier of the asset. */
|
|
1216
|
+
/** The identifier of the data product contract template. */
|
|
771
1217
|
id?: string;
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
1218
|
+
/** The name of the contract template. */
|
|
1219
|
+
name?: string;
|
|
1220
|
+
/** Contains the code and details. */
|
|
1221
|
+
error?: ErrorMessage;
|
|
1222
|
+
/** Defines the complete structure of a contract terms. */
|
|
1223
|
+
contractTerms?: ContractTerms;
|
|
1224
|
+
/** Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using
|
|
1225
|
+
* the uid of the default data product catalog.
|
|
1226
|
+
*/
|
|
1227
|
+
containerId?: string;
|
|
1228
|
+
/** Name of the data product contract template. If not supplied, the data product templates within the catalog
|
|
1229
|
+
* will returned.
|
|
1230
|
+
*/
|
|
1231
|
+
contractTemplateName?: string;
|
|
1232
|
+
headers?: OutgoingHttpHeaders;
|
|
1233
|
+
}
|
|
1234
|
+
/** Parameters for the `getContractTemplate` operation. */
|
|
1235
|
+
interface GetContractTemplateParams {
|
|
1236
|
+
/** Data Product Contract Template id. */
|
|
1237
|
+
contractTemplateId: string;
|
|
1238
|
+
/** Container ID of the data product catalog. */
|
|
1239
|
+
containerId: string;
|
|
1240
|
+
headers?: OutgoingHttpHeaders;
|
|
1241
|
+
}
|
|
1242
|
+
/** Parameters for the `deleteDataProductContractTemplate` operation. */
|
|
1243
|
+
interface DeleteDataProductContractTemplateParams {
|
|
1244
|
+
/** Data Product Contract Template id. */
|
|
1245
|
+
contractTemplateId: string;
|
|
1246
|
+
/** Container ID of the data product catalog. */
|
|
1247
|
+
containerId: string;
|
|
1248
|
+
headers?: OutgoingHttpHeaders;
|
|
1249
|
+
}
|
|
1250
|
+
/** Parameters for the `updateDataProductContractTemplate` operation. */
|
|
1251
|
+
interface UpdateDataProductContractTemplateParams {
|
|
1252
|
+
/** Data Product Contract Template id. */
|
|
1253
|
+
contractTemplateId: string;
|
|
1254
|
+
/** Container ID of the data product catalog. */
|
|
1255
|
+
containerId: string;
|
|
1256
|
+
/** A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information. */
|
|
1257
|
+
jsonPatchInstructions: JsonPatchOperation[];
|
|
1258
|
+
headers?: OutgoingHttpHeaders;
|
|
1259
|
+
}
|
|
1260
|
+
/** Parameters for the `listDataProductDomains` operation. */
|
|
1261
|
+
interface ListDataProductDomainsParams {
|
|
1262
|
+
/** Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using
|
|
1263
|
+
* the uid of the default data product catalog.
|
|
1264
|
+
*/
|
|
1265
|
+
containerId?: string;
|
|
1266
|
+
headers?: OutgoingHttpHeaders;
|
|
1267
|
+
}
|
|
1268
|
+
/** Parameters for the `createDataProductDomain` operation. */
|
|
1269
|
+
interface CreateDataProductDomainParams {
|
|
1270
|
+
/** Container reference. */
|
|
1271
|
+
container: ContainerReference;
|
|
1272
|
+
/** The id to trace the failed domain creations. */
|
|
1273
|
+
trace?: string;
|
|
1274
|
+
/** Set of errors on the sub domain creation. */
|
|
1275
|
+
errors?: ErrorModelResource[];
|
|
1276
|
+
/** The name of the data product domain. */
|
|
1277
|
+
name?: string;
|
|
1278
|
+
/** The description of the data product domain. */
|
|
1279
|
+
description?: string;
|
|
1280
|
+
/** The identifier of the data product domain. */
|
|
1281
|
+
id?: string;
|
|
1282
|
+
/** Member roles of a corresponding asset. */
|
|
1283
|
+
memberRoles?: MemberRolesSchema;
|
|
1284
|
+
/** Properties of the corresponding asset. */
|
|
1285
|
+
properties?: PropertiesSchema;
|
|
1286
|
+
/** List of sub domains to be added within a domain. */
|
|
1287
|
+
subDomains?: InitializeSubDomain[];
|
|
1288
|
+
/** Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using
|
|
1289
|
+
* the uid of the default data product catalog.
|
|
1290
|
+
*/
|
|
1291
|
+
containerId?: string;
|
|
1292
|
+
headers?: OutgoingHttpHeaders;
|
|
1293
|
+
}
|
|
1294
|
+
/** Parameters for the `createDataProductSubdomain` operation. */
|
|
1295
|
+
interface CreateDataProductSubdomainParams {
|
|
1296
|
+
/** Domain id. */
|
|
1297
|
+
domainId: string;
|
|
1298
|
+
/** Container ID of the data product catalog. */
|
|
1299
|
+
containerId: string;
|
|
1300
|
+
/** The name of the data product subdomain. */
|
|
1301
|
+
name?: string;
|
|
1302
|
+
/** The identifier of the data product subdomain. */
|
|
1303
|
+
id?: string;
|
|
1304
|
+
/** The description of the data product subdomain. */
|
|
1305
|
+
description?: string;
|
|
1306
|
+
headers?: OutgoingHttpHeaders;
|
|
1307
|
+
}
|
|
1308
|
+
/** Parameters for the `getDomain` operation. */
|
|
1309
|
+
interface GetDomainParams {
|
|
1310
|
+
/** Domain id. */
|
|
1311
|
+
domainId: string;
|
|
1312
|
+
headers?: OutgoingHttpHeaders;
|
|
1313
|
+
}
|
|
1314
|
+
/** Parameters for the `deleteDomain` operation. */
|
|
1315
|
+
interface DeleteDomainParams {
|
|
1316
|
+
/** Domain id. */
|
|
1317
|
+
domainId: string;
|
|
1318
|
+
headers?: OutgoingHttpHeaders;
|
|
1319
|
+
}
|
|
1320
|
+
/** Parameters for the `updateDataProductDomain` operation. */
|
|
1321
|
+
interface UpdateDataProductDomainParams {
|
|
1322
|
+
/** Domain id. */
|
|
1323
|
+
domainId: string;
|
|
1324
|
+
/** Container ID of the data product catalog. */
|
|
1325
|
+
containerId: string;
|
|
1326
|
+
/** A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information. */
|
|
1327
|
+
jsonPatchInstructions: JsonPatchOperation[];
|
|
1328
|
+
headers?: OutgoingHttpHeaders;
|
|
1329
|
+
}
|
|
1330
|
+
/** Parameters for the `getDataProductByDomain` operation. */
|
|
1331
|
+
interface GetDataProductByDomainParams {
|
|
1332
|
+
/** Domain id. */
|
|
1333
|
+
domainId: string;
|
|
1334
|
+
/** Container ID of the data product catalog. */
|
|
1335
|
+
containerId: string;
|
|
1336
|
+
headers?: OutgoingHttpHeaders;
|
|
1337
|
+
}
|
|
1338
|
+
/** Parameters for the `createS3Bucket` operation. */
|
|
1339
|
+
interface CreateS3BucketParams {
|
|
1340
|
+
/** Flag to specify whether the bucket is dedicated or shared. */
|
|
1341
|
+
isShared: boolean;
|
|
1342
|
+
headers?: OutgoingHttpHeaders;
|
|
1343
|
+
}
|
|
1344
|
+
/** Parameters for the `getS3BucketValidation` operation. */
|
|
1345
|
+
interface GetS3BucketValidationParams {
|
|
1346
|
+
/** Name of the bucket to validate. */
|
|
1347
|
+
bucketName: string;
|
|
1348
|
+
headers?: OutgoingHttpHeaders;
|
|
1349
|
+
}
|
|
1350
|
+
/*************************
|
|
1351
|
+
* model interfaces
|
|
1352
|
+
************************/
|
|
1353
|
+
/**
|
|
1354
|
+
* Access control object.
|
|
1355
|
+
*/
|
|
1356
|
+
interface AssetListAccessControl {
|
|
1357
|
+
/** The owner of the asset. */
|
|
1358
|
+
owner?: string;
|
|
1359
|
+
}
|
|
1360
|
+
/**
|
|
1361
|
+
* The asset represented in this part.
|
|
1362
|
+
*/
|
|
1363
|
+
interface AssetPartReference {
|
|
1364
|
+
/** The unique identifier of the asset. */
|
|
1365
|
+
id?: string;
|
|
1366
|
+
/** Asset name. */
|
|
1367
|
+
name?: string;
|
|
1368
|
+
/** Container reference. */
|
|
1369
|
+
container: ContainerReference;
|
|
1370
|
+
/** The type of the asset. */
|
|
1371
|
+
type?: string;
|
|
1372
|
+
}
|
|
1373
|
+
/**
|
|
1374
|
+
* New asset input properties.
|
|
1375
|
+
*/
|
|
1376
|
+
interface AssetPrototype {
|
|
778
1377
|
/** The unique identifier of the asset. */
|
|
779
1378
|
id?: string;
|
|
1379
|
+
/** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
|
|
1380
|
+
container: ContainerIdentity;
|
|
1381
|
+
}
|
|
1382
|
+
/**
|
|
1383
|
+
* The reference schema for a asset in a container.
|
|
1384
|
+
*/
|
|
1385
|
+
interface AssetReference {
|
|
1386
|
+
/** The unique identifier of the asset. */
|
|
1387
|
+
id?: string;
|
|
1388
|
+
/** Asset name. */
|
|
1389
|
+
name?: string;
|
|
780
1390
|
/** Container reference. */
|
|
781
1391
|
container: ContainerReference;
|
|
782
1392
|
}
|
|
783
1393
|
/**
|
|
784
|
-
*
|
|
1394
|
+
* BucketResponse to hold the Bucket response data.
|
|
1395
|
+
*/
|
|
1396
|
+
interface BucketResponse {
|
|
1397
|
+
/** Name of the Bucket. */
|
|
1398
|
+
bucket_name?: string;
|
|
1399
|
+
/** Location of the Bucket stored. */
|
|
1400
|
+
bucket_location?: string;
|
|
1401
|
+
/** Role ARN. */
|
|
1402
|
+
role_arn?: string;
|
|
1403
|
+
/** Bucket Type. */
|
|
1404
|
+
bucket_type?: string;
|
|
1405
|
+
/** Is Shared Bucket. */
|
|
1406
|
+
shared?: boolean;
|
|
1407
|
+
}
|
|
1408
|
+
/**
|
|
1409
|
+
* BucketValidationResponse to hold the bucket validation data.
|
|
1410
|
+
*/
|
|
1411
|
+
interface BucketValidationResponse {
|
|
1412
|
+
/** Flag of bucket existence. */
|
|
1413
|
+
bucket_exists?: boolean;
|
|
1414
|
+
}
|
|
1415
|
+
/**
|
|
1416
|
+
* The identity schema for a IBM knowledge catalog container (catalog/project/space).
|
|
785
1417
|
*/
|
|
786
1418
|
interface ContainerIdentity {
|
|
787
1419
|
/** Container identifier. */
|
|
@@ -805,6 +1437,125 @@ declare namespace DphV1 {
|
|
|
805
1437
|
}
|
|
806
1438
|
}
|
|
807
1439
|
}
|
|
1440
|
+
/**
|
|
1441
|
+
* Schema definition of the data asset.
|
|
1442
|
+
*/
|
|
1443
|
+
interface ContractSchema {
|
|
1444
|
+
/** Name of the schema or data asset part. */
|
|
1445
|
+
name?: string;
|
|
1446
|
+
/** Description of the schema. */
|
|
1447
|
+
description?: string;
|
|
1448
|
+
/** MIME type or physical type. */
|
|
1449
|
+
physical_type?: string;
|
|
1450
|
+
/** List of properties. */
|
|
1451
|
+
properties?: ContractSchemaProperty[];
|
|
1452
|
+
}
|
|
1453
|
+
/**
|
|
1454
|
+
* Defines a property inside the schema.
|
|
1455
|
+
*/
|
|
1456
|
+
interface ContractSchemaProperty {
|
|
1457
|
+
/** Property name. */
|
|
1458
|
+
name: string;
|
|
1459
|
+
/** Detailed type definition of a schema property. */
|
|
1460
|
+
type?: ContractSchemaPropertyType;
|
|
1461
|
+
}
|
|
1462
|
+
/**
|
|
1463
|
+
* Detailed type definition of a schema property.
|
|
1464
|
+
*/
|
|
1465
|
+
interface ContractSchemaPropertyType {
|
|
1466
|
+
/** Type of the field. */
|
|
1467
|
+
type?: string;
|
|
1468
|
+
/** Length of the field as string. */
|
|
1469
|
+
length?: string;
|
|
1470
|
+
/** Scale of the field as string. */
|
|
1471
|
+
scale?: string;
|
|
1472
|
+
/** Is field nullable? true/false as string. */
|
|
1473
|
+
nullable?: string;
|
|
1474
|
+
/** Is field signed? true/false as string. */
|
|
1475
|
+
signed?: string;
|
|
1476
|
+
/** Native type of the field. */
|
|
1477
|
+
native_type?: string;
|
|
1478
|
+
}
|
|
1479
|
+
/**
|
|
1480
|
+
* Represents a custom property within the contract.
|
|
1481
|
+
*/
|
|
1482
|
+
interface ContractTemplateCustomProperty {
|
|
1483
|
+
/** The name of the key. Names should be in camel case–the same as if they were permanent properties in the
|
|
1484
|
+
* contract.
|
|
1485
|
+
*/
|
|
1486
|
+
key: string;
|
|
1487
|
+
/** The value of the key. */
|
|
1488
|
+
value: string;
|
|
1489
|
+
}
|
|
1490
|
+
/**
|
|
1491
|
+
* Represents a user and their role in the contract.
|
|
1492
|
+
*/
|
|
1493
|
+
interface ContractTemplateOrganization {
|
|
1494
|
+
/** The user ID associated with the contract. */
|
|
1495
|
+
user_id: string;
|
|
1496
|
+
/** The role of the user in the contract. */
|
|
1497
|
+
role: string;
|
|
1498
|
+
}
|
|
1499
|
+
/**
|
|
1500
|
+
* Represents the SLA details of the contract.
|
|
1501
|
+
*/
|
|
1502
|
+
interface ContractTemplateSLA {
|
|
1503
|
+
/** The default SLA element. */
|
|
1504
|
+
default_element?: string;
|
|
1505
|
+
/** List of SLA properties and their values. */
|
|
1506
|
+
properties?: ContractTemplateSLAProperty[];
|
|
1507
|
+
}
|
|
1508
|
+
/**
|
|
1509
|
+
* Represents an SLA property and its value.
|
|
1510
|
+
*/
|
|
1511
|
+
interface ContractTemplateSLAProperty {
|
|
1512
|
+
/** The SLA property name. */
|
|
1513
|
+
property: string;
|
|
1514
|
+
/** The value associated with the SLA property. */
|
|
1515
|
+
value: string;
|
|
1516
|
+
}
|
|
1517
|
+
/**
|
|
1518
|
+
* Represents a support and communication channel for the contract.
|
|
1519
|
+
*/
|
|
1520
|
+
interface ContractTemplateSupportAndCommunication {
|
|
1521
|
+
/** The communication channel. */
|
|
1522
|
+
channel: string;
|
|
1523
|
+
/** The URL associated with the communication channel. */
|
|
1524
|
+
url: string;
|
|
1525
|
+
}
|
|
1526
|
+
/**
|
|
1527
|
+
* Defines the complete structure of a contract terms.
|
|
1528
|
+
*/
|
|
1529
|
+
interface ContractTerms {
|
|
1530
|
+
/** The reference schema for a asset in a container. */
|
|
1531
|
+
asset?: AssetReference;
|
|
1532
|
+
/** ID of the contract terms. */
|
|
1533
|
+
id?: string;
|
|
1534
|
+
/** Collection of contract terms documents. */
|
|
1535
|
+
documents?: ContractTermsDocument[];
|
|
1536
|
+
/** An error message, if existing, relating to the contract terms. */
|
|
1537
|
+
error_msg?: string;
|
|
1538
|
+
/** Overview details of a data contract. */
|
|
1539
|
+
overview?: Overview;
|
|
1540
|
+
/** Description details of a data contract. */
|
|
1541
|
+
description?: Description;
|
|
1542
|
+
/** List of sub domains to be added within a domain. */
|
|
1543
|
+
organization?: ContractTemplateOrganization[];
|
|
1544
|
+
/** List of roles associated with the contract. */
|
|
1545
|
+
roles?: Roles[];
|
|
1546
|
+
/** Represents the pricing details of the contract. */
|
|
1547
|
+
price?: Pricing;
|
|
1548
|
+
/** Service Level Agreement details. */
|
|
1549
|
+
sla?: ContractTemplateSLA[];
|
|
1550
|
+
/** Support and communication details for the contract. */
|
|
1551
|
+
support_and_communication?: ContractTemplateSupportAndCommunication[];
|
|
1552
|
+
/** Custom properties that are not part of the standard contract. */
|
|
1553
|
+
custom_properties?: ContractTemplateCustomProperty[];
|
|
1554
|
+
/** Contains the contract test status and related metadata. */
|
|
1555
|
+
contract_test?: ContractTest;
|
|
1556
|
+
/** Schema details of the data asset. */
|
|
1557
|
+
schema?: ContractSchema[];
|
|
1558
|
+
}
|
|
808
1559
|
/**
|
|
809
1560
|
* Standard contract terms document, which is used for get and list contract terms responses.
|
|
810
1561
|
*/
|
|
@@ -832,57 +1583,408 @@ declare namespace DphV1 {
|
|
|
832
1583
|
}
|
|
833
1584
|
}
|
|
834
1585
|
/**
|
|
835
|
-
* Attachment associated witht the document.
|
|
836
|
-
*/
|
|
837
|
-
interface ContractTermsDocumentAttachment {
|
|
838
|
-
/** Id representing the corresponding attachment. */
|
|
839
|
-
id?: string;
|
|
840
|
-
}
|
|
841
|
-
/**
|
|
842
|
-
*
|
|
1586
|
+
* Attachment associated witht the document.
|
|
1587
|
+
*/
|
|
1588
|
+
interface ContractTermsDocumentAttachment {
|
|
1589
|
+
/** Id representing the corresponding attachment. */
|
|
1590
|
+
id?: string;
|
|
1591
|
+
}
|
|
1592
|
+
/**
|
|
1593
|
+
* List of links to sources that provide more details on the dataset.
|
|
1594
|
+
*/
|
|
1595
|
+
interface ContractTermsMoreInfo {
|
|
1596
|
+
/** Type of Source Link. */
|
|
1597
|
+
type: string;
|
|
1598
|
+
/** Link to source that provide more details on the dataset. */
|
|
1599
|
+
url: string;
|
|
1600
|
+
}
|
|
1601
|
+
/**
|
|
1602
|
+
* Contains the contract test status and related metadata.
|
|
1603
|
+
*/
|
|
1604
|
+
interface ContractTest {
|
|
1605
|
+
/** Status of the contract test (pass or fail). */
|
|
1606
|
+
status: ContractTest.Constants.Status | string;
|
|
1607
|
+
/** Timestamp of when the contract was last tested. */
|
|
1608
|
+
last_tested_time: string;
|
|
1609
|
+
/** Optional message or details about the contract test. */
|
|
1610
|
+
message?: string;
|
|
1611
|
+
}
|
|
1612
|
+
namespace ContractTest {
|
|
1613
|
+
namespace Constants {
|
|
1614
|
+
/** Status of the contract test (pass or fail). */
|
|
1615
|
+
enum Status {
|
|
1616
|
+
PASS = "pass",
|
|
1617
|
+
FAIL = "fail"
|
|
1618
|
+
}
|
|
1619
|
+
}
|
|
1620
|
+
}
|
|
1621
|
+
/**
|
|
1622
|
+
* Data members for visualization process.
|
|
1623
|
+
*/
|
|
1624
|
+
interface DataAssetRelationship {
|
|
1625
|
+
/** Data members for visualization. */
|
|
1626
|
+
visualization?: Visualization;
|
|
1627
|
+
/** The reference schema for a asset in a container. */
|
|
1628
|
+
asset: AssetReference;
|
|
1629
|
+
/** The reference schema for a asset in a container. */
|
|
1630
|
+
related_asset: AssetReference;
|
|
1631
|
+
/** Contains the code and details. */
|
|
1632
|
+
error?: ErrorMessage;
|
|
1633
|
+
}
|
|
1634
|
+
/**
|
|
1635
|
+
* Data relationships for the visualization process response.
|
|
1636
|
+
*/
|
|
1637
|
+
interface DataAssetVisualizationRes {
|
|
1638
|
+
/** Data asset Ids and their related asset Ids. */
|
|
1639
|
+
results?: DataAssetRelationship[];
|
|
1640
|
+
}
|
|
1641
|
+
/**
|
|
1642
|
+
* Data Product.
|
|
1643
|
+
*/
|
|
1644
|
+
interface DataProduct {
|
|
1645
|
+
/** Data product identifier. */
|
|
1646
|
+
id: string;
|
|
1647
|
+
/** A data product draft version object. */
|
|
1648
|
+
release?: DataProductDraftVersionRelease;
|
|
1649
|
+
/** Container reference. */
|
|
1650
|
+
container: ContainerReference;
|
|
1651
|
+
/** Data product name. */
|
|
1652
|
+
name?: string;
|
|
1653
|
+
/** Summary of Data Product Version object. */
|
|
1654
|
+
latest_release?: DataProductVersionSummary;
|
|
1655
|
+
/** List of draft summaries of this data product. */
|
|
1656
|
+
drafts?: DataProductVersionSummary[];
|
|
1657
|
+
}
|
|
1658
|
+
/**
|
|
1659
|
+
* A collection of data product summaries.
|
|
1660
|
+
*/
|
|
1661
|
+
interface DataProductCollection {
|
|
1662
|
+
/** Set a limit on the number of results returned. */
|
|
1663
|
+
limit: number;
|
|
1664
|
+
/** First page in the collection. */
|
|
1665
|
+
first: FirstPage;
|
|
1666
|
+
/** Next page in the collection. */
|
|
1667
|
+
next?: NextPage;
|
|
1668
|
+
/** Indicates the total number of results returned. */
|
|
1669
|
+
total_results?: number;
|
|
1670
|
+
/** Collection of data product summaries. */
|
|
1671
|
+
data_products: DataProductSummary[];
|
|
1672
|
+
}
|
|
1673
|
+
/**
|
|
1674
|
+
* Defines the complete structure of a contract template.
|
|
1675
|
+
*/
|
|
1676
|
+
interface DataProductContractTemplate {
|
|
1677
|
+
/** Container reference. */
|
|
1678
|
+
container: ContainerReference;
|
|
1679
|
+
/** The identifier of the data product contract template. */
|
|
1680
|
+
id?: string;
|
|
1681
|
+
/** The name of the contract template. */
|
|
1682
|
+
name?: string;
|
|
1683
|
+
/** Contains the code and details. */
|
|
1684
|
+
error?: ErrorMessage;
|
|
1685
|
+
/** Defines the complete structure of a contract terms. */
|
|
1686
|
+
contract_terms?: ContractTerms;
|
|
1687
|
+
}
|
|
1688
|
+
/**
|
|
1689
|
+
* A collection of data product contract templates.
|
|
1690
|
+
*/
|
|
1691
|
+
interface DataProductContractTemplateCollection {
|
|
1692
|
+
/** Collection of data product contract templates. */
|
|
1693
|
+
contract_templates: DataProductContractTemplate[];
|
|
1694
|
+
}
|
|
1695
|
+
/**
|
|
1696
|
+
* A custom workflow definition to be used to create a workflow to approve a data product subscription.
|
|
1697
|
+
*/
|
|
1698
|
+
interface DataProductCustomWorkflowDefinition {
|
|
1699
|
+
/** ID of a workflow definition. */
|
|
1700
|
+
id?: string;
|
|
1701
|
+
}
|
|
1702
|
+
/**
|
|
1703
|
+
* The data product domain.
|
|
1704
|
+
*/
|
|
1705
|
+
interface DataProductDomain {
|
|
1706
|
+
/** Container reference. */
|
|
1707
|
+
container: ContainerReference;
|
|
1708
|
+
/** The id to trace the failed domain creations. */
|
|
1709
|
+
trace?: string;
|
|
1710
|
+
/** Set of errors on the sub domain creation. */
|
|
1711
|
+
errors?: ErrorModelResource[];
|
|
1712
|
+
/** The name of the data product domain. */
|
|
1713
|
+
name?: string;
|
|
1714
|
+
/** The description of the data product domain. */
|
|
1715
|
+
description?: string;
|
|
1716
|
+
/** The identifier of the data product domain. */
|
|
1717
|
+
id?: string;
|
|
1718
|
+
/** Member roles of a corresponding asset. */
|
|
1719
|
+
member_roles?: MemberRolesSchema;
|
|
1720
|
+
/** Properties of the corresponding asset. */
|
|
1721
|
+
properties?: PropertiesSchema;
|
|
1722
|
+
/** List of sub domains to be added within a domain. */
|
|
1723
|
+
sub_domains?: InitializeSubDomain[];
|
|
1724
|
+
}
|
|
1725
|
+
/**
|
|
1726
|
+
* A collection of data product domains.
|
|
1727
|
+
*/
|
|
1728
|
+
interface DataProductDomainCollection {
|
|
1729
|
+
/** Collection of data product domains. */
|
|
1730
|
+
domains: DataProductDomain[];
|
|
1731
|
+
}
|
|
1732
|
+
/**
|
|
1733
|
+
* Data Product version draft.
|
|
1734
|
+
*/
|
|
1735
|
+
interface DataProductDraft {
|
|
1736
|
+
/** The data product version number. */
|
|
1737
|
+
version: string;
|
|
1738
|
+
/** The state of the data product version. */
|
|
1739
|
+
state: DataProductDraft.Constants.State | string;
|
|
1740
|
+
/** Data product reference. */
|
|
1741
|
+
data_product: DataProductDraftDataProduct;
|
|
1742
|
+
/** The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or
|
|
1743
|
+
* periods. Names are mutable and reusable.
|
|
1744
|
+
*/
|
|
1745
|
+
name: string;
|
|
1746
|
+
/** The description of the data product version. */
|
|
1747
|
+
description: string;
|
|
1748
|
+
/** Tags on the data product. */
|
|
1749
|
+
tags: string[];
|
|
1750
|
+
/** A list of use cases associated with the data product version. */
|
|
1751
|
+
use_cases?: UseCase[];
|
|
1752
|
+
/** Types of parts on the data product. */
|
|
1753
|
+
types: DataProductDraft.Constants.Types[] | string[];
|
|
1754
|
+
/** Contract terms binding various aspects of the data product. */
|
|
1755
|
+
contract_terms: ContractTerms[];
|
|
1756
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
1757
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
1758
|
+
* previous version of the data product.
|
|
1759
|
+
*/
|
|
1760
|
+
domain: Domain;
|
|
1761
|
+
/** The outgoing parts of this data product version to be delivered to consumers. If this is the first version
|
|
1762
|
+
* of a data product, this field defaults to an empty list. If this is a new version of an existing data product,
|
|
1763
|
+
* the data product parts will default to the parts list from the previous version of the data product.
|
|
1764
|
+
*/
|
|
1765
|
+
parts_out: DataProductPart[];
|
|
1766
|
+
/** The workflows associated with the data product version. */
|
|
1767
|
+
workflows?: DataProductWorkflows;
|
|
1768
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
1769
|
+
dataview_enabled?: boolean;
|
|
1770
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
1771
|
+
comments?: string;
|
|
1772
|
+
/** Access control object. */
|
|
1773
|
+
access_control?: AssetListAccessControl;
|
|
1774
|
+
/** Timestamp of last asset update. */
|
|
1775
|
+
last_updated_at?: string;
|
|
1776
|
+
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
1777
|
+
* the data product requires explicit approval before data is delivered.
|
|
1778
|
+
*/
|
|
1779
|
+
is_restricted: boolean;
|
|
1780
|
+
/** The identifier of the data product version. */
|
|
1781
|
+
id: string;
|
|
1782
|
+
/** The reference schema for a asset in a container. */
|
|
1783
|
+
asset: AssetReference;
|
|
1784
|
+
/** The user who published this data product version. */
|
|
1785
|
+
published_by?: string;
|
|
1786
|
+
/** The time when this data product version was published. */
|
|
1787
|
+
published_at?: string;
|
|
1788
|
+
/** The creator of this data product version. */
|
|
1789
|
+
created_by: string;
|
|
1790
|
+
/** The time when this data product version was created. */
|
|
1791
|
+
created_at: string;
|
|
1792
|
+
/** Metadata properties on data products. */
|
|
1793
|
+
properties?: JsonObject;
|
|
1794
|
+
/** Errors encountered during the visualization creation process. */
|
|
1795
|
+
visualization_errors?: DataAssetRelationship[];
|
|
1796
|
+
}
|
|
1797
|
+
namespace DataProductDraft {
|
|
1798
|
+
namespace Constants {
|
|
1799
|
+
/** The state of the data product version. */
|
|
1800
|
+
enum State {
|
|
1801
|
+
DRAFT = "draft",
|
|
1802
|
+
AVAILABLE = "available",
|
|
1803
|
+
RETIRED = "retired"
|
|
1804
|
+
}
|
|
1805
|
+
/** Types of parts on the data product. */
|
|
1806
|
+
enum Types {
|
|
1807
|
+
DATA = "data",
|
|
1808
|
+
CODE = "code"
|
|
1809
|
+
}
|
|
1810
|
+
}
|
|
1811
|
+
}
|
|
1812
|
+
/**
|
|
1813
|
+
* A collection of data product draft summaries.
|
|
1814
|
+
*/
|
|
1815
|
+
interface DataProductDraftCollection {
|
|
1816
|
+
/** Set a limit on the number of results returned. */
|
|
1817
|
+
limit: number;
|
|
1818
|
+
/** First page in the collection. */
|
|
1819
|
+
first: FirstPage;
|
|
1820
|
+
/** Next page in the collection. */
|
|
1821
|
+
next?: NextPage;
|
|
1822
|
+
/** Indicates the total number of results returned. */
|
|
1823
|
+
total_results?: number;
|
|
1824
|
+
/** Collection of data product drafts. */
|
|
1825
|
+
drafts: DataProductDraftSummary[];
|
|
1826
|
+
}
|
|
1827
|
+
/**
|
|
1828
|
+
* Data product reference.
|
|
1829
|
+
*/
|
|
1830
|
+
interface DataProductDraftDataProduct {
|
|
1831
|
+
/** Data product identifier. */
|
|
1832
|
+
id: string;
|
|
1833
|
+
/** A data product draft version object. */
|
|
1834
|
+
release?: DataProductDraftVersionRelease;
|
|
1835
|
+
/** Container reference. */
|
|
1836
|
+
container: ContainerReference;
|
|
1837
|
+
}
|
|
1838
|
+
/**
|
|
1839
|
+
* New data product version input properties.
|
|
1840
|
+
*/
|
|
1841
|
+
interface DataProductDraftPrototype {
|
|
1842
|
+
/** The data product version number. */
|
|
1843
|
+
version?: string;
|
|
1844
|
+
/** The state of the data product version. If not specified, the data product version will be created in `draft`
|
|
1845
|
+
* state.
|
|
1846
|
+
*/
|
|
1847
|
+
state?: DataProductDraftPrototype.Constants.State | string;
|
|
1848
|
+
/** Data product identifier. */
|
|
1849
|
+
data_product?: DataProductIdentity;
|
|
1850
|
+
/** The name that refers to the new data product version. If this is a new data product, this value must be
|
|
1851
|
+
* specified. If this is a new version of an existing data product, the name will default to the name of the
|
|
1852
|
+
* previous data product version. A name can contain letters, numbers, understores, dashes, spaces or periods. A
|
|
1853
|
+
* name must contain at least one non-space character.
|
|
1854
|
+
*/
|
|
1855
|
+
name?: string;
|
|
1856
|
+
/** Description of the data product version. If this is a new version of an existing data product, the
|
|
1857
|
+
* description will default to the description of the previous version of the data product.
|
|
1858
|
+
*/
|
|
1859
|
+
description?: string;
|
|
1860
|
+
/** Tags on the data product. */
|
|
1861
|
+
tags?: string[];
|
|
1862
|
+
/** A list of use cases associated with the data product version. */
|
|
1863
|
+
use_cases?: UseCase[];
|
|
1864
|
+
/** Types of parts on the data product. */
|
|
1865
|
+
types?: DataProductDraftPrototype.Constants.Types[] | string[];
|
|
1866
|
+
/** Contract terms binding various aspects of the data product. */
|
|
1867
|
+
contract_terms?: ContractTerms[];
|
|
1868
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
1869
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
1870
|
+
* previous version of the data product.
|
|
1871
|
+
*/
|
|
1872
|
+
domain?: Domain;
|
|
1873
|
+
/** The outgoing parts of this data product version to be delivered to consumers. If this is the first version
|
|
1874
|
+
* of a data product, this field defaults to an empty list. If this is a new version of an existing data product,
|
|
1875
|
+
* the data product parts will default to the parts list from the previous version of the data product.
|
|
1876
|
+
*/
|
|
1877
|
+
parts_out?: DataProductPart[];
|
|
1878
|
+
/** The workflows associated with the data product version. */
|
|
1879
|
+
workflows?: DataProductWorkflows;
|
|
1880
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
1881
|
+
dataview_enabled?: boolean;
|
|
1882
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
1883
|
+
comments?: string;
|
|
1884
|
+
/** Access control object. */
|
|
1885
|
+
access_control?: AssetListAccessControl;
|
|
1886
|
+
/** Timestamp of last asset update. */
|
|
1887
|
+
last_updated_at?: string;
|
|
1888
|
+
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
1889
|
+
* the data product requires explicit approval before data is delivered.
|
|
1890
|
+
*/
|
|
1891
|
+
is_restricted?: boolean;
|
|
1892
|
+
/** New asset input properties. */
|
|
1893
|
+
asset: AssetPrototype;
|
|
1894
|
+
}
|
|
1895
|
+
namespace DataProductDraftPrototype {
|
|
1896
|
+
namespace Constants {
|
|
1897
|
+
/** The state of the data product version. If not specified, the data product version will be created in `draft` state. */
|
|
1898
|
+
enum State {
|
|
1899
|
+
DRAFT = "draft",
|
|
1900
|
+
AVAILABLE = "available",
|
|
1901
|
+
RETIRED = "retired"
|
|
1902
|
+
}
|
|
1903
|
+
/** Types of parts on the data product. */
|
|
1904
|
+
enum Types {
|
|
1905
|
+
DATA = "data",
|
|
1906
|
+
CODE = "code"
|
|
1907
|
+
}
|
|
1908
|
+
}
|
|
1909
|
+
}
|
|
1910
|
+
/**
|
|
1911
|
+
* Summary of Data Product Version object.
|
|
1912
|
+
*/
|
|
1913
|
+
interface DataProductDraftSummary {
|
|
1914
|
+
/** The data product version number. */
|
|
1915
|
+
version: string;
|
|
1916
|
+
/** The state of the data product version. */
|
|
1917
|
+
state: DataProductDraftSummary.Constants.State | string;
|
|
1918
|
+
/** Data product reference. */
|
|
1919
|
+
data_product: DataProductDraftSummaryDataProduct;
|
|
1920
|
+
/** The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or
|
|
1921
|
+
* periods. Names are mutable and reusable.
|
|
1922
|
+
*/
|
|
1923
|
+
name: string;
|
|
1924
|
+
/** The description of the data product version. */
|
|
1925
|
+
description: string;
|
|
1926
|
+
/** Tags on the data product. */
|
|
1927
|
+
tags: string[];
|
|
1928
|
+
/** A list of use cases associated with the data product version. */
|
|
1929
|
+
use_cases?: UseCase[];
|
|
1930
|
+
/** Types of parts on the data product. */
|
|
1931
|
+
types: DataProductDraftSummary.Constants.Types[] | string[];
|
|
1932
|
+
/** Contract terms binding various aspects of the data product. */
|
|
1933
|
+
contract_terms: ContractTerms[];
|
|
1934
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
1935
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
1936
|
+
* previous version of the data product.
|
|
1937
|
+
*/
|
|
1938
|
+
domain: Domain;
|
|
1939
|
+
/** The outgoing parts of this data product version to be delivered to consumers. If this is the first version
|
|
1940
|
+
* of a data product, this field defaults to an empty list. If this is a new version of an existing data product,
|
|
1941
|
+
* the data product parts will default to the parts list from the previous version of the data product.
|
|
1942
|
+
*/
|
|
1943
|
+
parts_out: DataProductPart[];
|
|
1944
|
+
/** The workflows associated with the data product version. */
|
|
1945
|
+
workflows?: DataProductWorkflows;
|
|
1946
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
1947
|
+
dataview_enabled?: boolean;
|
|
1948
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
1949
|
+
comments?: string;
|
|
1950
|
+
/** Access control object. */
|
|
1951
|
+
access_control?: AssetListAccessControl;
|
|
1952
|
+
/** Timestamp of last asset update. */
|
|
1953
|
+
last_updated_at?: string;
|
|
1954
|
+
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
1955
|
+
* the data product requires explicit approval before data is delivered.
|
|
1956
|
+
*/
|
|
1957
|
+
is_restricted: boolean;
|
|
1958
|
+
/** The identifier of the data product version. */
|
|
1959
|
+
id: string;
|
|
1960
|
+
/** The reference schema for a asset in a container. */
|
|
1961
|
+
asset: AssetReference;
|
|
1962
|
+
}
|
|
1963
|
+
namespace DataProductDraftSummary {
|
|
1964
|
+
namespace Constants {
|
|
1965
|
+
/** The state of the data product version. */
|
|
1966
|
+
enum State {
|
|
1967
|
+
DRAFT = "draft",
|
|
1968
|
+
AVAILABLE = "available",
|
|
1969
|
+
RETIRED = "retired"
|
|
1970
|
+
}
|
|
1971
|
+
/** Types of parts on the data product. */
|
|
1972
|
+
enum Types {
|
|
1973
|
+
DATA = "data",
|
|
1974
|
+
CODE = "code"
|
|
1975
|
+
}
|
|
1976
|
+
}
|
|
1977
|
+
}
|
|
1978
|
+
/**
|
|
1979
|
+
* Data product reference.
|
|
843
1980
|
*/
|
|
844
|
-
interface
|
|
1981
|
+
interface DataProductDraftSummaryDataProduct {
|
|
845
1982
|
/** Data product identifier. */
|
|
846
1983
|
id: string;
|
|
847
1984
|
/** A data product draft version object. */
|
|
848
1985
|
release?: DataProductDraftVersionRelease;
|
|
849
1986
|
/** Container reference. */
|
|
850
1987
|
container: ContainerReference;
|
|
851
|
-
/** Summary of Data Product Version object. */
|
|
852
|
-
latest_release?: DataProductVersionSummary;
|
|
853
|
-
/** List of draft summaries of this data product. */
|
|
854
|
-
drafts?: DataProductVersionSummary[];
|
|
855
|
-
}
|
|
856
|
-
/**
|
|
857
|
-
* DataProductContractTerms.
|
|
858
|
-
*/
|
|
859
|
-
interface DataProductContractTerms {
|
|
860
|
-
asset?: AssetReference;
|
|
861
|
-
/** ID of the contract terms. */
|
|
862
|
-
id?: string;
|
|
863
|
-
/** Collection of contract terms documents. */
|
|
864
|
-
documents?: ContractTermsDocument[];
|
|
865
|
-
error_msg?: string;
|
|
866
|
-
}
|
|
867
|
-
/**
|
|
868
|
-
* A custom workflow definition to be used to create a workflow to approve a data product subscription.
|
|
869
|
-
*/
|
|
870
|
-
interface DataProductCustomWorkflowDefinition {
|
|
871
|
-
/** ID of a workflow definition. */
|
|
872
|
-
id?: string;
|
|
873
|
-
}
|
|
874
|
-
/**
|
|
875
|
-
* A collection of data product draft summaries.
|
|
876
|
-
*/
|
|
877
|
-
interface DataProductDraftCollection {
|
|
878
|
-
/** Set a limit on the number of results returned. */
|
|
879
|
-
limit: number;
|
|
880
|
-
/** First page in the collection. */
|
|
881
|
-
first: FirstPage;
|
|
882
|
-
/** Next page in the collection. */
|
|
883
|
-
next?: NextPage;
|
|
884
|
-
/** Collection of data product drafts. */
|
|
885
|
-
drafts: DataProductVersionSummary[];
|
|
886
1988
|
}
|
|
887
1989
|
/**
|
|
888
1990
|
* A data product draft version object.
|
|
@@ -921,52 +2023,15 @@ declare namespace DphV1 {
|
|
|
921
2023
|
delivery_methods?: DeliveryMethod[];
|
|
922
2024
|
}
|
|
923
2025
|
/**
|
|
924
|
-
*
|
|
925
|
-
*/
|
|
926
|
-
interface DataProductReleaseCollection {
|
|
927
|
-
/** Set a limit on the number of results returned. */
|
|
928
|
-
limit: number;
|
|
929
|
-
/** First page in the collection. */
|
|
930
|
-
first: FirstPage;
|
|
931
|
-
/** Next page in the collection. */
|
|
932
|
-
next?: NextPage;
|
|
933
|
-
/** Collection of data product releases. */
|
|
934
|
-
releases: DataProductVersionSummary[];
|
|
935
|
-
}
|
|
936
|
-
/**
|
|
937
|
-
* Data Product Summary.
|
|
938
|
-
*/
|
|
939
|
-
interface DataProductSummary {
|
|
940
|
-
/** Data product identifier. */
|
|
941
|
-
id: string;
|
|
942
|
-
/** A data product draft version object. */
|
|
943
|
-
release?: DataProductDraftVersionRelease;
|
|
944
|
-
/** Container reference. */
|
|
945
|
-
container: ContainerReference;
|
|
946
|
-
}
|
|
947
|
-
/**
|
|
948
|
-
* A collection of data product summaries.
|
|
949
|
-
*/
|
|
950
|
-
interface DataProductSummaryCollection {
|
|
951
|
-
/** Set a limit on the number of results returned. */
|
|
952
|
-
limit: number;
|
|
953
|
-
/** First page in the collection. */
|
|
954
|
-
first: FirstPage;
|
|
955
|
-
/** Next page in the collection. */
|
|
956
|
-
next?: NextPage;
|
|
957
|
-
/** Collection of data product summaries. */
|
|
958
|
-
data_products: DataProductSummary[];
|
|
959
|
-
}
|
|
960
|
-
/**
|
|
961
|
-
* Data Product version.
|
|
2026
|
+
* Data Product version release.
|
|
962
2027
|
*/
|
|
963
|
-
interface
|
|
2028
|
+
interface DataProductRelease {
|
|
964
2029
|
/** The data product version number. */
|
|
965
2030
|
version: string;
|
|
966
2031
|
/** The state of the data product version. */
|
|
967
|
-
state:
|
|
2032
|
+
state: DataProductRelease.Constants.State | string;
|
|
968
2033
|
/** Data product reference. */
|
|
969
|
-
data_product:
|
|
2034
|
+
data_product: DataProductReleaseDataProduct;
|
|
970
2035
|
/** The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or
|
|
971
2036
|
* periods. Names are mutable and reusable.
|
|
972
2037
|
*/
|
|
@@ -976,25 +2041,39 @@ declare namespace DphV1 {
|
|
|
976
2041
|
/** Tags on the data product. */
|
|
977
2042
|
tags: string[];
|
|
978
2043
|
/** A list of use cases associated with the data product version. */
|
|
979
|
-
use_cases
|
|
2044
|
+
use_cases?: UseCase[];
|
|
980
2045
|
/** Types of parts on the data product. */
|
|
981
|
-
types:
|
|
2046
|
+
types: DataProductRelease.Constants.Types[] | string[];
|
|
982
2047
|
/** Contract terms binding various aspects of the data product. */
|
|
983
|
-
contract_terms:
|
|
2048
|
+
contract_terms: ContractTerms[];
|
|
2049
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
2050
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
2051
|
+
* previous version of the data product.
|
|
2052
|
+
*/
|
|
2053
|
+
domain: Domain;
|
|
2054
|
+
/** The outgoing parts of this data product version to be delivered to consumers. If this is the first version
|
|
2055
|
+
* of a data product, this field defaults to an empty list. If this is a new version of an existing data product,
|
|
2056
|
+
* the data product parts will default to the parts list from the previous version of the data product.
|
|
2057
|
+
*/
|
|
2058
|
+
parts_out: DataProductPart[];
|
|
2059
|
+
/** The workflows associated with the data product version. */
|
|
2060
|
+
workflows?: DataProductWorkflows;
|
|
2061
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
2062
|
+
dataview_enabled?: boolean;
|
|
2063
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
2064
|
+
comments?: string;
|
|
2065
|
+
/** Access control object. */
|
|
2066
|
+
access_control?: AssetListAccessControl;
|
|
2067
|
+
/** Timestamp of last asset update. */
|
|
2068
|
+
last_updated_at?: string;
|
|
984
2069
|
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
985
2070
|
* the data product requires explicit approval before data is delivered.
|
|
986
2071
|
*/
|
|
987
2072
|
is_restricted: boolean;
|
|
988
2073
|
/** The identifier of the data product version. */
|
|
989
2074
|
id: string;
|
|
2075
|
+
/** The reference schema for a asset in a container. */
|
|
990
2076
|
asset: AssetReference;
|
|
991
|
-
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
992
|
-
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
993
|
-
* previous version of the data product.
|
|
994
|
-
*/
|
|
995
|
-
domain: Domain;
|
|
996
|
-
/** Outgoing parts of a data product used to deliver the data product to consumers. */
|
|
997
|
-
parts_out: DataProductPart[];
|
|
998
2077
|
/** The user who published this data product version. */
|
|
999
2078
|
published_by?: string;
|
|
1000
2079
|
/** The time when this data product version was published. */
|
|
@@ -1003,12 +2082,12 @@ declare namespace DphV1 {
|
|
|
1003
2082
|
created_by: string;
|
|
1004
2083
|
/** The time when this data product version was created. */
|
|
1005
2084
|
created_at: string;
|
|
1006
|
-
/** The workflows associated with the data product version. */
|
|
1007
|
-
workflows?: DataProductWorkflows;
|
|
1008
2085
|
/** Metadata properties on data products. */
|
|
1009
2086
|
properties?: JsonObject;
|
|
2087
|
+
/** Errors encountered during the visualization creation process. */
|
|
2088
|
+
visualization_errors?: DataAssetRelationship[];
|
|
1010
2089
|
}
|
|
1011
|
-
namespace
|
|
2090
|
+
namespace DataProductRelease {
|
|
1012
2091
|
namespace Constants {
|
|
1013
2092
|
/** The state of the data product version. */
|
|
1014
2093
|
enum State {
|
|
@@ -1023,10 +2102,25 @@ declare namespace DphV1 {
|
|
|
1023
2102
|
}
|
|
1024
2103
|
}
|
|
1025
2104
|
}
|
|
2105
|
+
/**
|
|
2106
|
+
* A collection of data product release summaries.
|
|
2107
|
+
*/
|
|
2108
|
+
interface DataProductReleaseCollection {
|
|
2109
|
+
/** Set a limit on the number of results returned. */
|
|
2110
|
+
limit: number;
|
|
2111
|
+
/** First page in the collection. */
|
|
2112
|
+
first: FirstPage;
|
|
2113
|
+
/** Next page in the collection. */
|
|
2114
|
+
next?: NextPage;
|
|
2115
|
+
/** Indicates the total number of results returned. */
|
|
2116
|
+
total_results?: number;
|
|
2117
|
+
/** Collection of data product releases. */
|
|
2118
|
+
releases: DataProductReleaseSummary[];
|
|
2119
|
+
}
|
|
1026
2120
|
/**
|
|
1027
2121
|
* Data product reference.
|
|
1028
2122
|
*/
|
|
1029
|
-
interface
|
|
2123
|
+
interface DataProductReleaseDataProduct {
|
|
1030
2124
|
/** Data product identifier. */
|
|
1031
2125
|
id: string;
|
|
1032
2126
|
/** A data product draft version object. */
|
|
@@ -1035,41 +2129,29 @@ declare namespace DphV1 {
|
|
|
1035
2129
|
container: ContainerReference;
|
|
1036
2130
|
}
|
|
1037
2131
|
/**
|
|
1038
|
-
*
|
|
2132
|
+
* Summary of Data Product Version object.
|
|
1039
2133
|
*/
|
|
1040
|
-
interface
|
|
2134
|
+
interface DataProductReleaseSummary {
|
|
1041
2135
|
/** The data product version number. */
|
|
1042
|
-
version
|
|
1043
|
-
/** The state of the data product version.
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
/**
|
|
1048
|
-
|
|
1049
|
-
/** The name that refers to the new data product version. If this is a new data product, this value must be
|
|
1050
|
-
* specified. If this is a new version of an existing data product, the name will default to the name of the
|
|
1051
|
-
* previous data product version. A name can contain letters, numbers, understores, dashes, spaces or periods. A
|
|
1052
|
-
* name must contain at least one non-space character.
|
|
1053
|
-
*/
|
|
1054
|
-
name?: string;
|
|
1055
|
-
/** Description of the data product version. If this is a new version of an existing data product, the
|
|
1056
|
-
* description will default to the description of the previous version of the data product.
|
|
2136
|
+
version: string;
|
|
2137
|
+
/** The state of the data product version. */
|
|
2138
|
+
state: DataProductReleaseSummary.Constants.State | string;
|
|
2139
|
+
/** Data product reference. */
|
|
2140
|
+
data_product: DataProductReleaseSummaryDataProduct;
|
|
2141
|
+
/** The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or
|
|
2142
|
+
* periods. Names are mutable and reusable.
|
|
1057
2143
|
*/
|
|
1058
|
-
|
|
2144
|
+
name: string;
|
|
2145
|
+
/** The description of the data product version. */
|
|
2146
|
+
description: string;
|
|
1059
2147
|
/** Tags on the data product. */
|
|
1060
2148
|
tags?: string[];
|
|
1061
2149
|
/** A list of use cases associated with the data product version. */
|
|
1062
2150
|
use_cases?: UseCase[];
|
|
1063
2151
|
/** Types of parts on the data product. */
|
|
1064
|
-
types
|
|
2152
|
+
types: DataProductReleaseSummary.Constants.Types[] | string[];
|
|
1065
2153
|
/** Contract terms binding various aspects of the data product. */
|
|
1066
|
-
contract_terms
|
|
1067
|
-
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
1068
|
-
* the data product requires explicit approval before data is delivered.
|
|
1069
|
-
*/
|
|
1070
|
-
is_restricted?: boolean;
|
|
1071
|
-
/** New asset input properties. */
|
|
1072
|
-
asset: AssetPrototype;
|
|
2154
|
+
contract_terms: ContractTerms[];
|
|
1073
2155
|
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
1074
2156
|
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
1075
2157
|
* previous version of the data product.
|
|
@@ -1082,10 +2164,26 @@ declare namespace DphV1 {
|
|
|
1082
2164
|
parts_out?: DataProductPart[];
|
|
1083
2165
|
/** The workflows associated with the data product version. */
|
|
1084
2166
|
workflows?: DataProductWorkflows;
|
|
2167
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
2168
|
+
dataview_enabled?: boolean;
|
|
2169
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
2170
|
+
comments?: string;
|
|
2171
|
+
/** Access control object. */
|
|
2172
|
+
access_control?: AssetListAccessControl;
|
|
2173
|
+
/** Timestamp of last asset update. */
|
|
2174
|
+
last_updated_at?: string;
|
|
2175
|
+
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
2176
|
+
* the data product requires explicit approval before data is delivered.
|
|
2177
|
+
*/
|
|
2178
|
+
is_restricted: boolean;
|
|
2179
|
+
/** The identifier of the data product version. */
|
|
2180
|
+
id: string;
|
|
2181
|
+
/** The reference schema for a asset in a container. */
|
|
2182
|
+
asset: AssetReference;
|
|
1085
2183
|
}
|
|
1086
|
-
namespace
|
|
2184
|
+
namespace DataProductReleaseSummary {
|
|
1087
2185
|
namespace Constants {
|
|
1088
|
-
/** The state of the data product version.
|
|
2186
|
+
/** The state of the data product version. */
|
|
1089
2187
|
enum State {
|
|
1090
2188
|
DRAFT = "draft",
|
|
1091
2189
|
AVAILABLE = "available",
|
|
@@ -1098,6 +2196,45 @@ declare namespace DphV1 {
|
|
|
1098
2196
|
}
|
|
1099
2197
|
}
|
|
1100
2198
|
}
|
|
2199
|
+
/**
|
|
2200
|
+
* Data product reference.
|
|
2201
|
+
*/
|
|
2202
|
+
interface DataProductReleaseSummaryDataProduct {
|
|
2203
|
+
/** Data product identifier. */
|
|
2204
|
+
id: string;
|
|
2205
|
+
/** A data product draft version object. */
|
|
2206
|
+
release?: DataProductDraftVersionRelease;
|
|
2207
|
+
/** Container reference. */
|
|
2208
|
+
container: ContainerReference;
|
|
2209
|
+
}
|
|
2210
|
+
/**
|
|
2211
|
+
* Data Product Summary.
|
|
2212
|
+
*/
|
|
2213
|
+
interface DataProductSummary {
|
|
2214
|
+
/** Data product identifier. */
|
|
2215
|
+
id: string;
|
|
2216
|
+
/** A data product draft version object. */
|
|
2217
|
+
release?: DataProductDraftVersionRelease;
|
|
2218
|
+
/** Container reference. */
|
|
2219
|
+
container: ContainerReference;
|
|
2220
|
+
/** Data product name. */
|
|
2221
|
+
name?: string;
|
|
2222
|
+
}
|
|
2223
|
+
/**
|
|
2224
|
+
* A collection of data product version summaries.
|
|
2225
|
+
*/
|
|
2226
|
+
interface DataProductVersionCollection {
|
|
2227
|
+
/** Set a limit on the number of results returned. */
|
|
2228
|
+
limit: number;
|
|
2229
|
+
/** First page in the collection. */
|
|
2230
|
+
first: FirstPage;
|
|
2231
|
+
/** Next page in the collection. */
|
|
2232
|
+
next?: NextPage;
|
|
2233
|
+
/** Indicates the total number of results returned. */
|
|
2234
|
+
total_results?: number;
|
|
2235
|
+
/** Collection of data product versions. */
|
|
2236
|
+
data_product_versions: DataProductVersionSummary[];
|
|
2237
|
+
}
|
|
1101
2238
|
/**
|
|
1102
2239
|
* Summary of Data Product Version object.
|
|
1103
2240
|
*/
|
|
@@ -1115,19 +2252,40 @@ declare namespace DphV1 {
|
|
|
1115
2252
|
/** The description of the data product version. */
|
|
1116
2253
|
description: string;
|
|
1117
2254
|
/** Tags on the data product. */
|
|
1118
|
-
tags
|
|
2255
|
+
tags?: string[];
|
|
1119
2256
|
/** A list of use cases associated with the data product version. */
|
|
1120
|
-
use_cases
|
|
2257
|
+
use_cases?: UseCase[];
|
|
1121
2258
|
/** Types of parts on the data product. */
|
|
1122
2259
|
types: DataProductVersionSummary.Constants.Types[] | string[];
|
|
1123
2260
|
/** Contract terms binding various aspects of the data product. */
|
|
1124
|
-
contract_terms:
|
|
2261
|
+
contract_terms: ContractTerms[];
|
|
2262
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
2263
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
2264
|
+
* previous version of the data product.
|
|
2265
|
+
*/
|
|
2266
|
+
domain?: Domain;
|
|
2267
|
+
/** The outgoing parts of this data product version to be delivered to consumers. If this is the first version
|
|
2268
|
+
* of a data product, this field defaults to an empty list. If this is a new version of an existing data product,
|
|
2269
|
+
* the data product parts will default to the parts list from the previous version of the data product.
|
|
2270
|
+
*/
|
|
2271
|
+
parts_out?: DataProductPart[];
|
|
2272
|
+
/** The workflows associated with the data product version. */
|
|
2273
|
+
workflows?: DataProductWorkflows;
|
|
2274
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
2275
|
+
dataview_enabled?: boolean;
|
|
2276
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
2277
|
+
comments?: string;
|
|
2278
|
+
/** Access control object. */
|
|
2279
|
+
access_control?: AssetListAccessControl;
|
|
2280
|
+
/** Timestamp of last asset update. */
|
|
2281
|
+
last_updated_at?: string;
|
|
1125
2282
|
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
1126
2283
|
* the data product requires explicit approval before data is delivered.
|
|
1127
2284
|
*/
|
|
1128
2285
|
is_restricted: boolean;
|
|
1129
2286
|
/** The identifier of the data product version. */
|
|
1130
2287
|
id: string;
|
|
2288
|
+
/** The reference schema for a asset in a container. */
|
|
1131
2289
|
asset: AssetReference;
|
|
1132
2290
|
}
|
|
1133
2291
|
namespace DataProductVersionSummary {
|
|
@@ -1171,6 +2329,30 @@ declare namespace DphV1 {
|
|
|
1171
2329
|
id: string;
|
|
1172
2330
|
/** Container reference. */
|
|
1173
2331
|
container: ContainerReference;
|
|
2332
|
+
/** The propertiess of the delivery method. */
|
|
2333
|
+
getproperties?: DeliveryMethodPropertiesModel;
|
|
2334
|
+
}
|
|
2335
|
+
/**
|
|
2336
|
+
* The propertiess of the delivery method.
|
|
2337
|
+
*/
|
|
2338
|
+
interface DeliveryMethodPropertiesModel {
|
|
2339
|
+
/** Parameters for delivery that are set by a data product producer. */
|
|
2340
|
+
producer_input?: ProducerInputModel;
|
|
2341
|
+
}
|
|
2342
|
+
/**
|
|
2343
|
+
* Description details of a data contract.
|
|
2344
|
+
*/
|
|
2345
|
+
interface Description {
|
|
2346
|
+
/** Intended purpose for the provided data. */
|
|
2347
|
+
purpose?: string;
|
|
2348
|
+
/** Technical, compliance, and legal limitations for data use. */
|
|
2349
|
+
limitations?: string;
|
|
2350
|
+
/** Recommended usage of the data. */
|
|
2351
|
+
usage?: string;
|
|
2352
|
+
/** List of links to sources that provide more details on the dataset. */
|
|
2353
|
+
more_info?: ContractTermsMoreInfo[];
|
|
2354
|
+
/** Custom properties that are not part of the standard. */
|
|
2355
|
+
custom_properties?: string;
|
|
1174
2356
|
}
|
|
1175
2357
|
/**
|
|
1176
2358
|
* Domain that the data product version belongs to. If this is the first version of a data product, this field is
|
|
@@ -1185,16 +2367,59 @@ declare namespace DphV1 {
|
|
|
1185
2367
|
/** Container reference. */
|
|
1186
2368
|
container?: ContainerReference;
|
|
1187
2369
|
}
|
|
2370
|
+
/**
|
|
2371
|
+
* Engine details as defined by the data product producer.
|
|
2372
|
+
*/
|
|
2373
|
+
interface EngineDetailsModel {
|
|
2374
|
+
/** The name of the engine defined by the data product producer. */
|
|
2375
|
+
display_name?: string;
|
|
2376
|
+
/** The id of the engine defined by the data product producer. */
|
|
2377
|
+
engine_id?: string;
|
|
2378
|
+
/** The port of the engine defined by the data product producer. */
|
|
2379
|
+
engine_port?: string;
|
|
2380
|
+
/** The host of the engine defined by the data product producer. */
|
|
2381
|
+
engine_host?: string;
|
|
2382
|
+
/** The list of associated catalogs. */
|
|
2383
|
+
associated_catalogs?: string[];
|
|
2384
|
+
}
|
|
2385
|
+
/**
|
|
2386
|
+
* Detailed error information.
|
|
2387
|
+
*/
|
|
2388
|
+
interface ErrorExtraResource {
|
|
2389
|
+
/** Error id. */
|
|
2390
|
+
id?: string;
|
|
2391
|
+
/** Timestamp of the error. */
|
|
2392
|
+
timestamp?: string;
|
|
2393
|
+
/** Environment where the error occurred. */
|
|
2394
|
+
environment_name?: string;
|
|
2395
|
+
/** Http status code. */
|
|
2396
|
+
http_status?: number;
|
|
2397
|
+
/** Source cluster of the error. */
|
|
2398
|
+
source_cluster?: number;
|
|
2399
|
+
/** Source component of the error. */
|
|
2400
|
+
source_component?: number;
|
|
2401
|
+
/** Transaction id of the request. */
|
|
2402
|
+
transaction_id?: number;
|
|
2403
|
+
}
|
|
2404
|
+
/**
|
|
2405
|
+
* Contains the code and details.
|
|
2406
|
+
*/
|
|
2407
|
+
interface ErrorMessage {
|
|
2408
|
+
/** The error code. */
|
|
2409
|
+
code: string;
|
|
2410
|
+
/** The error details. */
|
|
2411
|
+
message: string;
|
|
2412
|
+
}
|
|
1188
2413
|
/**
|
|
1189
2414
|
* Detailed error information.
|
|
1190
2415
|
*/
|
|
1191
2416
|
interface ErrorModelResource {
|
|
1192
2417
|
/** Error code. */
|
|
1193
|
-
code
|
|
2418
|
+
code: ErrorModelResource.Constants.Code | string;
|
|
1194
2419
|
/** Error message. */
|
|
1195
2420
|
message?: string;
|
|
1196
|
-
/**
|
|
1197
|
-
extra?:
|
|
2421
|
+
/** Detailed error information. */
|
|
2422
|
+
extra?: ErrorExtraResource;
|
|
1198
2423
|
/** More info message. */
|
|
1199
2424
|
more_info?: string;
|
|
1200
2425
|
}
|
|
@@ -1231,7 +2456,8 @@ declare namespace DphV1 {
|
|
|
1231
2456
|
ENTITLEMENT_ENFORCEMENT = "entitlement_enforcement",
|
|
1232
2457
|
DELETED = "deleted",
|
|
1233
2458
|
NOT_IMPLEMENTED = "not_implemented",
|
|
1234
|
-
FEATURE_NOT_ENABLED = "feature_not_enabled"
|
|
2459
|
+
FEATURE_NOT_ENABLED = "feature_not_enabled",
|
|
2460
|
+
MISSING_ASSET_DETAILS = "missing_asset_details"
|
|
1235
2461
|
}
|
|
1236
2462
|
}
|
|
1237
2463
|
}
|
|
@@ -1251,7 +2477,7 @@ declare namespace DphV1 {
|
|
|
1251
2477
|
/** Link to monitor the status of the initialize operation. */
|
|
1252
2478
|
href?: string;
|
|
1253
2479
|
/** Status of the initialize operation. */
|
|
1254
|
-
status
|
|
2480
|
+
status: InitializeResource.Constants.Status | string;
|
|
1255
2481
|
/** The id to trace the failed initialization operation. */
|
|
1256
2482
|
trace?: string;
|
|
1257
2483
|
/** Set of errors on the latest initialization request. */
|
|
@@ -1276,6 +2502,17 @@ declare namespace DphV1 {
|
|
|
1276
2502
|
}
|
|
1277
2503
|
}
|
|
1278
2504
|
}
|
|
2505
|
+
/**
|
|
2506
|
+
* The subdomain for a data product domain.
|
|
2507
|
+
*/
|
|
2508
|
+
interface InitializeSubDomain {
|
|
2509
|
+
/** The name of the data product subdomain. */
|
|
2510
|
+
name?: string;
|
|
2511
|
+
/** The identifier of the data product subdomain. */
|
|
2512
|
+
id?: string;
|
|
2513
|
+
/** The description of the data product subdomain. */
|
|
2514
|
+
description?: string;
|
|
2515
|
+
}
|
|
1279
2516
|
/**
|
|
1280
2517
|
* List of options successfully initialized.
|
|
1281
2518
|
*/
|
|
@@ -1311,6 +2548,15 @@ declare namespace DphV1 {
|
|
|
1311
2548
|
}
|
|
1312
2549
|
}
|
|
1313
2550
|
}
|
|
2551
|
+
/**
|
|
2552
|
+
* Member roles of a corresponding asset.
|
|
2553
|
+
*/
|
|
2554
|
+
interface MemberRolesSchema {
|
|
2555
|
+
/** User id. */
|
|
2556
|
+
user_iam_id?: string;
|
|
2557
|
+
/** Roles of the given user. */
|
|
2558
|
+
roles?: string[];
|
|
2559
|
+
}
|
|
1314
2560
|
/**
|
|
1315
2561
|
* Next page in the collection.
|
|
1316
2562
|
*/
|
|
@@ -1320,6 +2566,51 @@ declare namespace DphV1 {
|
|
|
1320
2566
|
/** Start token for pagination to the next page in the collection. */
|
|
1321
2567
|
start: string;
|
|
1322
2568
|
}
|
|
2569
|
+
/**
|
|
2570
|
+
* Overview details of a data contract.
|
|
2571
|
+
*/
|
|
2572
|
+
interface Overview {
|
|
2573
|
+
/** The API version of the contract. */
|
|
2574
|
+
api_version?: string;
|
|
2575
|
+
/** The kind of contract. */
|
|
2576
|
+
kind?: string;
|
|
2577
|
+
/** The name of the contract. */
|
|
2578
|
+
name?: string;
|
|
2579
|
+
/** The version of the contract. */
|
|
2580
|
+
version: string;
|
|
2581
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
2582
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
2583
|
+
* previous version of the data product.
|
|
2584
|
+
*/
|
|
2585
|
+
domain: Domain;
|
|
2586
|
+
/** Additional information links about the contract. */
|
|
2587
|
+
more_info?: string;
|
|
2588
|
+
}
|
|
2589
|
+
/**
|
|
2590
|
+
* Represents the pricing details of the contract.
|
|
2591
|
+
*/
|
|
2592
|
+
interface Pricing {
|
|
2593
|
+
/** The amount for the contract pricing. */
|
|
2594
|
+
amount?: string;
|
|
2595
|
+
/** The currency for the pricing amount. */
|
|
2596
|
+
currency?: string;
|
|
2597
|
+
/** The unit associated with the pricing. */
|
|
2598
|
+
unit?: string;
|
|
2599
|
+
}
|
|
2600
|
+
/**
|
|
2601
|
+
* Parameters for delivery that are set by a data product producer.
|
|
2602
|
+
*/
|
|
2603
|
+
interface ProducerInputModel {
|
|
2604
|
+
/** Engine details as defined by the data product producer. */
|
|
2605
|
+
engine_details?: EngineDetailsModel;
|
|
2606
|
+
}
|
|
2607
|
+
/**
|
|
2608
|
+
* Properties of the corresponding asset.
|
|
2609
|
+
*/
|
|
2610
|
+
interface PropertiesSchema {
|
|
2611
|
+
/** Value of the property object. */
|
|
2612
|
+
value?: string;
|
|
2613
|
+
}
|
|
1323
2614
|
/**
|
|
1324
2615
|
* Resource defining provided workflow definitions.
|
|
1325
2616
|
*/
|
|
@@ -1336,6 +2627,13 @@ declare namespace DphV1 {
|
|
|
1336
2627
|
/** Reference to a workflow definition. */
|
|
1337
2628
|
definition?: WorkflowDefinitionReference;
|
|
1338
2629
|
}
|
|
2630
|
+
/**
|
|
2631
|
+
* Represents a role associated with the contract.
|
|
2632
|
+
*/
|
|
2633
|
+
interface Roles {
|
|
2634
|
+
/** The role associated with the contract. */
|
|
2635
|
+
role?: string;
|
|
2636
|
+
}
|
|
1339
2637
|
/**
|
|
1340
2638
|
* Service id credentials.
|
|
1341
2639
|
*/
|
|
@@ -1356,6 +2654,15 @@ declare namespace DphV1 {
|
|
|
1356
2654
|
/** Container reference. */
|
|
1357
2655
|
container?: ContainerReference;
|
|
1358
2656
|
}
|
|
2657
|
+
/**
|
|
2658
|
+
* Data members for visualization.
|
|
2659
|
+
*/
|
|
2660
|
+
interface Visualization {
|
|
2661
|
+
/** Visualization identifier. */
|
|
2662
|
+
id?: string;
|
|
2663
|
+
/** Visualization name. */
|
|
2664
|
+
name?: string;
|
|
2665
|
+
}
|
|
1359
2666
|
/**
|
|
1360
2667
|
* Reference to a workflow definition.
|
|
1361
2668
|
*/
|
|
@@ -1423,14 +2730,14 @@ declare namespace DphV1 {
|
|
|
1423
2730
|
hasNext(): boolean;
|
|
1424
2731
|
/**
|
|
1425
2732
|
* Returns the next page of results by invoking listDataProductDrafts().
|
|
1426
|
-
* @returns {Promise<DphV1.
|
|
2733
|
+
* @returns {Promise<DphV1.DataProductDraftSummary[]>}
|
|
1427
2734
|
*/
|
|
1428
|
-
getNext(): Promise<DphV1.
|
|
2735
|
+
getNext(): Promise<DphV1.DataProductDraftSummary[]>;
|
|
1429
2736
|
/**
|
|
1430
2737
|
* Returns all results by invoking listDataProductDrafts() repeatedly until all pages of results have been retrieved.
|
|
1431
|
-
* @returns {Promise<DphV1.
|
|
2738
|
+
* @returns {Promise<DphV1.DataProductDraftSummary[]>}
|
|
1432
2739
|
*/
|
|
1433
|
-
getAll(): Promise<DphV1.
|
|
2740
|
+
getAll(): Promise<DphV1.DataProductDraftSummary[]>;
|
|
1434
2741
|
}
|
|
1435
2742
|
/**
|
|
1436
2743
|
* DataProductReleasesPager can be used to simplify the use of listDataProductReleases().
|
|
@@ -1456,14 +2763,14 @@ declare namespace DphV1 {
|
|
|
1456
2763
|
hasNext(): boolean;
|
|
1457
2764
|
/**
|
|
1458
2765
|
* Returns the next page of results by invoking listDataProductReleases().
|
|
1459
|
-
* @returns {Promise<DphV1.
|
|
2766
|
+
* @returns {Promise<DphV1.DataProductReleaseSummary[]>}
|
|
1460
2767
|
*/
|
|
1461
|
-
getNext(): Promise<DphV1.
|
|
2768
|
+
getNext(): Promise<DphV1.DataProductReleaseSummary[]>;
|
|
1462
2769
|
/**
|
|
1463
2770
|
* Returns all results by invoking listDataProductReleases() repeatedly until all pages of results have been retrieved.
|
|
1464
|
-
* @returns {Promise<DphV1.
|
|
2771
|
+
* @returns {Promise<DphV1.DataProductReleaseSummary[]>}
|
|
1465
2772
|
*/
|
|
1466
|
-
getAll(): Promise<DphV1.
|
|
2773
|
+
getAll(): Promise<DphV1.DataProductReleaseSummary[]>;
|
|
1467
2774
|
}
|
|
1468
2775
|
}
|
|
1469
2776
|
export = DphV1;
|