/**
* (C) Copyright IBM Corp. 2025.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
///
///
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
import { AbortSignal, BaseService, UserOptions } from 'ibm-cloud-sdk-core';
/**
* This is the Public API for IBM watsonx.data
*
* API Version: 2.0.0
*/
declare class WatsonxDataV2 extends BaseService {
static DEFAULT_SERVICE_URL: string;
static DEFAULT_SERVICE_NAME: string;
/*************************
* Factory method
************************/
/**
* Constructs an instance of WatsonxDataV2 with passed in options and external configuration.
*
* @param {UserOptions} [options] - The parameters to send to the service.
* @param {string} [options.serviceName] - The name of the service to configure
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service
* @param {string} [options.serviceUrl] - The base URL for the service
* @returns {WatsonxDataV2}
*/
static newInstance(options: UserOptions): WatsonxDataV2;
/**
* Construct a WatsonxDataV2 object.
*
* @param {Object} options - Options for the service.
* @param {string} [options.serviceUrl] - The base URL for the service
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
* @param {Authenticator} options.authenticator - The Authenticator object used to authenticate requests to the service
* @constructor
* @returns {WatsonxDataV2}
*/
constructor(options: UserOptions);
/*************************
* buckets
************************/
/**
* Get bucket registrations.
*
* Get list of registered buckets.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listBucketRegistrations(params?: WatsonxDataV2.ListBucketRegistrationsParams): Promise>;
/**
* Register bucket.
*
* Register a new bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketType - bucket type.
* @param {string} params.description - bucket description.
* @param {string} params.managedBy - managed by.
* @param {BucketCatalog} [params.associatedCatalog] - bucket catalog.
* @param {BucketDetails} [params.bucketDetails] - bucket details.
* @param {string} [params.bucketDisplayName] - bucket display name.
* @param {string} [params.region] - region where the bucket is located.
* @param {StorageDetails} [params.storageDetails] - storage details.
* @param {string[]} [params.tags] - tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createBucketRegistration(params: WatsonxDataV2.CreateBucketRegistrationParams): Promise>;
/**
* Get bucket.
*
* Get a registered bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBucketRegistration(params: WatsonxDataV2.GetBucketRegistrationParams): Promise>;
/**
* Deregister Bucket.
*
* Deregister a bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteBucketRegistration(params: WatsonxDataV2.DeleteBucketRegistrationParams): Promise>;
/**
* Update bucket.
*
* Update bucket details & credentials.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {BucketDetails} [params.bucketDetails] - bucket details.
* @param {string} [params.bucketDisplayName] - bucket display name.
* @param {string} [params.description] - modified description.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateBucketRegistration(params: WatsonxDataV2.UpdateBucketRegistrationParams): Promise>;
/**
* Activate Bucket.
*
* Activate a registered bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createActivateBucket(params: WatsonxDataV2.CreateActivateBucketParams): Promise>;
/**
* Add bucket catalog.
*
* Add bucket catalog.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.basePath] - catalog base path.
* @param {string} [params.catalogName] - catalog name.
* @param {string[]} [params.catalogTags] - catalog tags.
* @param {string} [params.catalogType] - catalog type.
* @param {string} [params.authInstanceId] - watsonx.data instance ID.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
addBucketCatalog(params: WatsonxDataV2.AddBucketCatalogParams): Promise>;
/**
* Deactivate Bucket.
*
* Deactivate a bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteDeactivateBucket(params: WatsonxDataV2.DeleteDeactivateBucketParams): Promise>;
/**
* List bucket objects.
*
* Fetch all objects from a given bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.authInstanceId] - CRN.
* @param {string} [params.path] - path.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listBucketObjects(params: WatsonxDataV2.ListBucketObjectsParams): Promise>;
/**
* Get bucket object properties.
*
* Get bucket object properties.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {Path[]} [params.paths] - bucket object size.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBucketObjectProperties(params: WatsonxDataV2.GetBucketObjectPropertiesParams): Promise>;
/**
* Add/Create HDFS storage.
*
* Add or create a new HDFS database.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketDisplayName - Bucket display name.
* @param {string} params.bucketType - Bucket type.
* @param {string} params.hmsThriftUri - HMS Thrift URI.
* @param {number} params.hmsThriftPort - HMS Thrift Port.
* @param {string} params.coreSite - contents of core-site.xml file.
* @param {string} params.hdfsSite - contents of hdfs-site.xml file.
* @param {string} params.kerberos - Kerberos Flag.
* @param {string} params.catalogName - Catalog name.
* @param {string} params.catalogType - Catalog type.
* @param {string} [params.krb5Config] - Kerberos config file.
* @param {NodeJS.ReadableStream | Buffer} [params.hiveKeytab] - Hive keytab file.
* @param {string} [params.hiveKeytabContentType] - The content type of hiveKeytab.
* @param {NodeJS.ReadableStream | Buffer} [params.hdfsKeytab] - HDFS keytab file.
* @param {string} [params.hdfsKeytabContentType] - The content type of hdfsKeytab.
* @param {string} [params.hiveServerPrincipal] - Hive server principal.
* @param {string} [params.hiveClientPrincipal] - Hive client principal.
* @param {string} [params.hdfsPrincipal] - HDFS principal.
* @param {string} [params.description] - Database description.
* @param {string} [params.createdOn] - Created on.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createHdfsStorage(params: WatsonxDataV2.CreateHdfsStorageParams): Promise>;
/*************************
* databases
************************/
/**
* Get databases.
*
* Get list of databases.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listDatabaseRegistrations(params?: WatsonxDataV2.ListDatabaseRegistrationsParams): Promise>;
/**
* Add/Create database.
*
* Add or create a new database.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.databaseDisplayName - Database display name.
* @param {string} params.databaseType - Connector type.
* @param {DatabaseCatalog} [params.associatedCatalog] - database catalog.
* @param {string} [params.createdOn] - Created on.
* @param {DatabaseDetails} [params.databaseDetails] - database details.
* @param {DatabaseRegistrationPrototypeDatabasePropertiesItems[]} [params.databaseProperties] - This will hold all
* the properties for a custom database.
* @param {string} [params.description] - Database description.
* @param {string[]} [params.tags] - tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createDatabaseRegistration(params: WatsonxDataV2.CreateDatabaseRegistrationParams): Promise>;
/**
* Get database.
*
* Get a registered databases.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.databaseId - database id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getDatabase(params: WatsonxDataV2.GetDatabaseParams): Promise>;
/**
* Delete database.
*
* Delete a database.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.databaseId - database id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteDatabaseCatalog(params: WatsonxDataV2.DeleteDatabaseCatalogParams): Promise>;
/**
* Update database.
*
* Update database details.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.databaseId - database id.
* @param {DatabaseRegistrationPatchDatabaseDetails} [params.databaseDetails] - New database details.
* @param {string} [params.databaseDisplayName] - New database display name.
* @param {string} [params.description] - New database description.
* @param {string[]} [params.tags] - New tags.
* @param {DatabaseRegistrationPatchTopicsItems[]} [params.topics] - List of topics.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateDatabase(params: WatsonxDataV2.UpdateDatabaseParams): Promise>;
/*************************
* drivers
************************/
/**
* Get drivers.
*
* Get all driver details.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listDriverRegistration(params?: WatsonxDataV2.ListDriverRegistrationParams): Promise>;
/**
* Register driver.
*
* Register a new driver.
*
* @param {Object} params - The parameters to send to the service.
* @param {NodeJS.ReadableStream | Buffer} params.driver - Driver file to upload.
* @param {string} params.driverName - Driver name.
* @param {string} params.connectionType - Driver connection type.
* @param {string} [params.driverContentType] - The content type of driver.
* @param {string} [params.version] - Driver status.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createDriverRegistration(params: WatsonxDataV2.CreateDriverRegistrationParams): Promise>;
/**
* Delete driver.
*
* Delete a driver.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.driverId - Driver ID.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteDriverRegistration(params: WatsonxDataV2.DeleteDriverRegistrationParams): Promise>;
/**
* Disassociate engines from driver.
*
* Disassociate one or more engines from a driver.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.driverId - driver id.
* @param {string} params.engineIds - Engine id(s) to be disassociated from the driver, comma separated.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteDriverEngines(params: WatsonxDataV2.DeleteDriverEnginesParams): Promise>;
/**
* Associate engines to driver.
*
* Associate one or more engines to a driver.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.driverId - driver id.
* @param {string[]} [params.engines] - List of engine IDs.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateDriverEngines(params: WatsonxDataV2.UpdateDriverEnginesParams): Promise>;
/*************************
* otherEngines
************************/
/**
* List other engines.
*
* list all other engine details.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listOtherEngines(params?: WatsonxDataV2.ListOtherEnginesParams): Promise>;
/**
* Create other engine.
*
* Create a new engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {OtherEngineDetailsBody} params.engineDetails - External engine details.
* @param {string} params.engineDisplayName - engine display name.
* @param {string} [params.description] - engine description.
* @param {string} [params.origin] - Origin - created or registered.
* @param {string[]} [params.tags] - other engine tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createOtherEngine(params: WatsonxDataV2.CreateOtherEngineParams): Promise>;
/**
* Delete engine.
*
* Delete an engine from lakehouse.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteOtherEngine(params: WatsonxDataV2.DeleteOtherEngineParams): Promise>;
/*************************
* integrations
************************/
/**
* Get all existing Integrations.
*
* Get all existing Integrations.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {string} [params.secret] - API Authentication service token.
* @param {string} [params.serviceType] - service_type.
* @param {string[]} [params.state] - state.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listAllIntegrations(params?: WatsonxDataV2.ListAllIntegrationsParams): Promise>;
/**
* To register an integration.
*
* To register an integration.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.accessToken] - token for databand.
* @param {string} [params.apikey] - Integration APIKEY.
* @param {boolean} [params.crossAccountIntegration] - cross account integration enabler/disabler.
* @param {boolean} [params.enableDataPolicyWithinWxd] - data policy enabler with wxd for ranger.
* @param {string} [params.ikcUserAccountId] - token for ikc.
* @param {string} [params.password] - Integration password.
* @param {string} [params.resource] - resouce for ranger.
* @param {string} [params.serviceType] - Integration type.
* @param {string[]} [params.storageCatalogs] - Comma separated list of bucket catalogs which have ikc enabled.
* @param {string} [params.url] - Integration Connection URL.
* @param {string} [params.username] - Integration username.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createIntegration(params?: WatsonxDataV2.CreateIntegrationParams): Promise>;
/**
* Get an Integration.
*
* Get an Integration.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.integrationId - integration_id.
* @param {string} [params.authInstanceId] - CRN.
* @param {string} [params.secret] - API Authentication service token.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getIntegrations(params: WatsonxDataV2.GetIntegrationsParams): Promise>;
/**
* Remove an Integration.
*
* Remove an Integration.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.integrationId - integration_id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteIntegration(params: WatsonxDataV2.DeleteIntegrationParams): Promise>;
/**
* Update an existing Integration.
*
* Update an existing Integration.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.integrationId - integration_id.
* @param {string} [params.accessToken] - token for databand.
* @param {string} [params.apikey] - Integration APIKEY.
* @param {boolean} [params.crossAccountIntegration] - cross account integration enabler/disabler.
* @param {boolean} [params.enableDataPolicyWithinWxd] - data policy enabler with wxd for ranger.
* @param {string} [params.ikcUserAccountId] - token for databand.
* @param {string} [params.password] - Integration password.
* @param {string} [params.resource] - resouce for ranger.
* @param {string} [params.state] - current state.
* @param {string[]} [params.storageCatalogs] - Comma separated list of bucket catalogs which have ikc enabled.
* @param {string} [params.url] - Integration Connection URL.
* @param {string} [params.username] - Integration username.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateIntegration(params: WatsonxDataV2.UpdateIntegrationParams): Promise>;
/*************************
* db2Engines
************************/
/**
* Get list of db2 engines.
*
* Get list of all db2 engines.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listDb2Engines(params?: WatsonxDataV2.ListDb2EnginesParams): Promise>;
/**
* Create db2 engine.
*
* Create a new db2 engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.origin - Origin - created or registered.
* @param {string} [params.description] - Engine description.
* @param {Db2EngineDetailsBody} [params.engineDetails] - External engine details.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createDb2Engine(params: WatsonxDataV2.CreateDb2EngineParams): Promise>;
/**
* Delete db2 engine.
*
* Delete a db2 engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteDb2Engine(params: WatsonxDataV2.DeleteDb2EngineParams): Promise>;
/**
* Update db2 engine.
*
* Update details of db2 engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.description] - Modified description.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateDb2Engine(params: WatsonxDataV2.UpdateDb2EngineParams): Promise>;
/*************************
* netezzaEngines
************************/
/**
* Get list of netezza engines.
*
* Get list of all netezza engines.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listNetezzaEngines(params?: WatsonxDataV2.ListNetezzaEnginesParams): Promise>;
/**
* Create netezza engine.
*
* Create a new netezza engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.origin - Origin - created or registered.
* @param {string} [params.description] - Engine description.
* @param {NetezzaEngineDetailsBody} [params.engineDetails] - External engine details.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createNetezzaEngine(params: WatsonxDataV2.CreateNetezzaEngineParams): Promise>;
/**
* Delete netezza engine.
*
* Delete a netezza engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteNetezzaEngine(params: WatsonxDataV2.DeleteNetezzaEngineParams): Promise>;
/**
* Update netezza engine.
*
* Update details of netezza engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.description] - Modified description.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateNetezzaEngine(params: WatsonxDataV2.UpdateNetezzaEngineParams): Promise>;
/*************************
* queries
************************/
/**
* Execute a query.
*
* Execute a query.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine name.
* @param {string} params.sqlString - query to be executed.
* @param {string} [params.catalogName] - Name of the catalog.
* @param {string} [params.schemaName] - Schema name.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createExecuteQuery(params: WatsonxDataV2.CreateExecuteQueryParams): Promise>;
/*************************
* instance
************************/
/**
* Get all instance details.
*
* Get all engine details.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listInstanceDetails(params?: WatsonxDataV2.ListInstanceDetailsParams): Promise>;
/**
* Get engines and services detail.
*
* Get engines and services detail.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.target - Target type (e.g., 'cpd', 'generic').
* @param {boolean} [params.internalHost] - Internal host.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listInstanceServiceDetails(params: WatsonxDataV2.ListInstanceServiceDetailsParams): Promise>;
/**
* Get services details.
*
* Get services details for a given engine or service type.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.target - Target type (e.g., 'cpd', 'generic').
* @param {string} params.engineOrServiceType - Type of engine or service (e.g., 'milvus', 'presto').
* @param {boolean} [params.internalHost] - Internal host.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getServicesDetails(params: WatsonxDataV2.GetServicesDetailsParams): Promise>;
/**
* Get Milvus service detail.
*
* Get Milvus service detail.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.target - Target type (e.g., 'cpd', 'generic').
* @param {string} params.engineOrServiceType - Type of engine or service (e.g., 'milvus', 'presto').
* @param {string} params.id - Service ID.
* @param {string} [params.database] - Database name in milvus.
* @param {boolean} [params.internalHost] - Internal host.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getServiceDetail(params: WatsonxDataV2.GetServiceDetailParams): Promise>;
/*************************
* prestissimoEngines
************************/
/**
* Get list of prestissimo engines.
*
* Get list of all prestissimo engines.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listPrestissimoEngines(params?: WatsonxDataV2.ListPrestissimoEnginesParams): Promise>;
/**
* Create prestissimo engine.
*
* Create a new prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.origin - Origin - created or registered.
* @param {string[]} [params.associatedCatalogs] - Associated catalogs.
* @param {string} [params.description] - Engine description.
* @param {PrestissimoEngineDetails} [params.engineDetails] - External engine details.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string} [params.region] - Region (cloud).
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.version] - Version like 0.278 for prestissimo or else.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createPrestissimoEngine(params: WatsonxDataV2.CreatePrestissimoEngineParams): Promise>;
/**
* Get prestissimo engine.
*
* Get details of one prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getPrestissimoEngine(params: WatsonxDataV2.GetPrestissimoEngineParams): Promise>;
/**
* Delete prestissimo engine.
*
* Delete a prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deletePrestissimoEngine(params: WatsonxDataV2.DeletePrestissimoEngineParams): Promise>;
/**
* Update prestissimo engine.
*
* Update details of prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.description] - Modified description.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {PrestissimoEngineEngineProperties} [params.engineProperties] - Engine properties.
* @param {string} [params.engineRestart] - Triggers engine restart if value is force.
* @param {RemoveEngineProperties} [params.removeEngineProperties] - RemoveEngine properties.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updatePrestissimoEngine(params: WatsonxDataV2.UpdatePrestissimoEngineParams): Promise>;
/**
* Get prestissimo engine catalogs.
*
* Get list of all catalogs attached a prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listPrestissimoEngineCatalogs(params: WatsonxDataV2.ListPrestissimoEngineCatalogsParams): Promise>;
/**
* Associate catalogs to a prestissimo engine.
*
* Associate one or more catalogs to a prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.catalogName] - catalog names.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createPrestissimoEngineCatalogs(params: WatsonxDataV2.CreatePrestissimoEngineCatalogsParams): Promise>;
/**
* Disassociate catalogs from a prestissimo engine.
*
* Disassociate one or more catalogs from a prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogNames - Catalog id(s) to be stopped, comma separated.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deletePrestissimoEngineCatalogs(params: WatsonxDataV2.DeletePrestissimoEngineCatalogsParams): Promise>;
/**
* Get prestissimo engine catalog.
*
* Get catalog attached to a prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogId - catalog id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getPrestissimoEngineCatalog(params: WatsonxDataV2.GetPrestissimoEngineCatalogParams): Promise>;
/**
* Pause prestissimo engine.
*
* Pause a running prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
pausePrestissimoEngine(params: WatsonxDataV2.PausePrestissimoEngineParams): Promise>;
/**
* Explain query.
*
* Explain a query statement.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine id.
* @param {string} params.statement - Presto query to determine explain plan.
* @param {string} [params.format] - Format.
* @param {string} [params.type] - Type.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
runPrestissimoExplainStatement(params: WatsonxDataV2.RunPrestissimoExplainStatementParams): Promise>;
/**
* Explain analyze.
*
* Return query metrics after query is complete.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine id.
* @param {string} params.statement - Presto query to show explain analyze.
* @param {boolean} [params.verbose] - Verbose.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
runPrestissimoExplainAnalyzeStatement(params: WatsonxDataV2.RunPrestissimoExplainAnalyzeStatementParams): Promise>;
/**
* Restart a prestissimo engine.
*
* Restart an existing prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
restartPrestissimoEngine(params: WatsonxDataV2.RestartPrestissimoEngineParams): Promise>;
/**
* Resume prestissimo engine.
*
* Resume a paused prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
resumePrestissimoEngine(params: WatsonxDataV2.ResumePrestissimoEngineParams): Promise>;
/**
* Scale a prestissimo engine.
*
* Scale an existing prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {PrestissimoNodeDescriptionBody} [params.coordinator] - coordinator/worker property settings.
* @param {PrestissimoNodeDescriptionBody} [params.worker] - coordinator/worker property settings.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
scalePrestissimoEngine(params: WatsonxDataV2.ScalePrestissimoEngineParams): Promise>;
/*************************
* prestoEngines
************************/
/**
* Get list of presto engines.
*
* Get list of all presto engines.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listPrestoEngines(params?: WatsonxDataV2.ListPrestoEnginesParams): Promise>;
/**
* Create presto engine.
*
* Create a new presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.origin - Origin - created or registered.
* @param {string[]} [params.associatedCatalogs] - Associated catalogs.
* @param {string} [params.description] - Engine description.
* @param {EngineDetailsBody} [params.engineDetails] - Node details.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string} [params.region] - Region (cloud).
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.version] - Version like 0.278 for presto or else.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createPrestoEngine(params: WatsonxDataV2.CreatePrestoEngineParams): Promise>;
/**
* Get presto engine.
*
* Get details of one presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getPrestoEngine(params: WatsonxDataV2.GetPrestoEngineParams): Promise>;
/**
* Delete presto engine.
*
* Delete a presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteEngine(params: WatsonxDataV2.DeleteEngineParams): Promise>;
/**
* Update presto engine.
*
* Update details of presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.description] - Modified description.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {PrestoEngineEngineProperties} [params.engineProperties] - Engine properties.
* @param {string} [params.engineRestart] - Triggers engine restart if value is force.
* @param {PrestoEnginePatchRemoveEngineProperties} [params.removeEngineProperties] - RemoveEngine properties.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updatePrestoEngine(params: WatsonxDataV2.UpdatePrestoEngineParams): Promise>;
/**
* Get presto engine catalogs.
*
* Get list of all catalogs attached to a presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listPrestoEngineCatalogs(params: WatsonxDataV2.ListPrestoEngineCatalogsParams): Promise>;
/**
* Associate catalogs to presto engine.
*
* Associate one or more catalogs to a presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.catalogName] - catalog names.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createPrestoEngineCatalogs(params: WatsonxDataV2.CreatePrestoEngineCatalogsParams): Promise>;
/**
* Disassociate catalogs from a presto engine.
*
* Disassociate one or more catalogs from a presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogNames - Catalog id(s) to be stopped, comma separated.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deletePrestoEngineCatalogs(params: WatsonxDataV2.DeletePrestoEngineCatalogsParams): Promise>;
/**
* Get presto engine catalog.
*
* Get catalog attached to presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogId - catalog id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getPrestoEngineCatalog(params: WatsonxDataV2.GetPrestoEngineCatalogParams): Promise>;
/**
* Pause presto engine.
*
* Pause a running presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
pausePrestoEngine(params: WatsonxDataV2.PausePrestoEngineParams): Promise>;
/**
* Explain presto query.
*
* Explain a query statement.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine id.
* @param {string} params.statement - Presto query to determine explain plan.
* @param {string} [params.format] - Format.
* @param {string} [params.type] - Type.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
runExplainStatement(params: WatsonxDataV2.RunExplainStatementParams): Promise>;
/**
* Explain presto analyze.
*
* Return query metrics after query is complete.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine id.
* @param {string} params.statement - Presto query to show explain analyze.
* @param {boolean} [params.verbose] - Verbose.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
runExplainAnalyzeStatement(params: WatsonxDataV2.RunExplainAnalyzeStatementParams): Promise>;
/**
* Restart a presto engine.
*
* Restart an existing presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
restartPrestoEngine(params: WatsonxDataV2.RestartPrestoEngineParams): Promise>;
/**
* Resume presto engine.
*
* Resume a paused presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
resumePrestoEngine(params: WatsonxDataV2.ResumePrestoEngineParams): Promise>;
/**
* Scale a presto engine.
*
* Scale an existing presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {NodeDescription} [params.coordinator] - NodeDescription.
* @param {NodeDescription} [params.worker] - NodeDescription.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
scalePrestoEngine(params: WatsonxDataV2.ScalePrestoEngineParams): Promise>;
/*************************
* semanticAutomationLayer
************************/
/**
* Get SAL Integrations.
*
* Get SAL Integration.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSalIntegration(params?: WatsonxDataV2.GetSalIntegrationParams): Promise>;
/**
* Create sal integration with wxd.
*
* Add or create a new sal integration.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.apikey - IAM apikey.
* @param {string} params.engineId - engine ID.
* @param {string} [params.storageResourceCrn] - COS storage resource crn.
* @param {string} [params.storageType] - COS storage type.
* @param {boolean} [params.trialPlan] - COS storage type.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createSalIntegration(params: WatsonxDataV2.CreateSalIntegrationParams): Promise>;
/**
* Delete sal-wxd integration.
*
* Delete a sal-wxd integration.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteSalIntegration(params?: WatsonxDataV2.DeleteSalIntegrationParams): Promise>;
/**
* Update sal-wxd integration.
*
* Update sal-wxd integration details.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.op] - op.
* @param {string} [params.path] - path.
* @param {string} [params.value] - path.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateSalIntegration(params?: WatsonxDataV2.UpdateSalIntegrationParams): Promise>;
/**
* Trigger enrichment jobs on schemas and tables.
*
* Trigger enrichment jobs on schemas and tables.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {EnrichmentObj} [params.enrichmentPrototype] - Encrichment api object.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createSalIntegrationEnrichment(params?: WatsonxDataV2.CreateSalIntegrationEnrichmentParams): Promise>;
/**
* Get semantic enrichment assets associated with the schema.
*
* Get semantic enrichment job runs associated with the schema.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.projectId] - enrichment project id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSalIntegrationEnrichmentAssets(params?: WatsonxDataV2.GetSalIntegrationEnrichmentAssetsParams): Promise>;
/**
* Get semantic enrichment data asset associated with the table.
*
* Get semantic enrichment data asset associated with the table.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.projectId] - enrichment project id.
* @param {string} [params.assetId] - enrichment data asset id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSalIntegrationEnrichmentDataAsset(params?: WatsonxDataV2.GetSalIntegrationEnrichmentDataAssetParams): Promise>;
/**
* Get semantic enrichment job run logs associated with the job run.
*
* Get semantic enrichment job run logs associated with the job run.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.jobId] - enrichment job id.
* @param {string} [params.jobRunId] - enrichment job run id.
* @param {string} [params.projectId] - enrichment project id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSalIntegrationEnrichmentJobRunLogs(params?: WatsonxDataV2.GetSalIntegrationEnrichmentJobRunLogsParams): Promise>;
/**
* Get semantic enrichment job runs associated with the schema.
*
* Get semantic enrichment job runs associated with the schema.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.jobId] - enrichment job id.
* @param {string} [params.projectId] - enrichment project id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSalIntegrationEnrichmentJobRuns(params?: WatsonxDataV2.GetSalIntegrationEnrichmentJobRunsParams): Promise>;
/**
* Get semantic enrichment jobs associated with the schema.
*
* Get semantic enrichment jobs associated with the schema.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.wkcProjectId] - ikc project id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSalIntegrationEnrichmentJobs(params?: WatsonxDataV2.GetSalIntegrationEnrichmentJobsParams): Promise>;
/**
* Get list of uploaded glossary terms.
*
* Get list of uploaded glossary terms.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSalIntegrationGlossaryTerms(params?: WatsonxDataV2.GetSalIntegrationGlossaryTermsParams): Promise>;
/**
* Get wkc catalog and project mapped to the schema.
*
* Get wkc catalog and project mapped to the schema.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.catalogName - catalog name.
* @param {string} params.schemaName - schema name.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSalIntegrationMappings(params: WatsonxDataV2.GetSalIntegrationMappingsParams): Promise>;
/**
* Get metadata enrichment global settings.
*
* Get metadata enrichment global settings.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSalIntegrationEnrichmentGlobalSettings(params?: WatsonxDataV2.GetSalIntegrationEnrichmentGlobalSettingsParams): Promise>;
/**
* Add metadata enrichment global settings.
*
* Add metadata enrichment global settings.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {SalIntegrationEnrichmentSettingsSemanticExpansion} [params.semanticExpansion] - semantic expansion.
* @param {SalIntegrationEnrichmentSettingsTermAssignment} [params.termAssignment] - semantic expansion.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createSalIntegrationEnrichmentGlobalSettings(params?: WatsonxDataV2.CreateSalIntegrationEnrichmentGlobalSettingsParams): Promise>;
/**
* get metadata enrichment settings for a project.
*
* get metadata enrichment settings for a project.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.projectId] - wkc project id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSalIntegrationEnrichmentSettings(params?: WatsonxDataV2.GetSalIntegrationEnrichmentSettingsParams): Promise>;
/**
* Add metadata enrichment settings for a project.
*
* Add metadata enrichment settings for a project.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {SalIntegrationEnrichmentSettingsSemanticExpansion} [params.semanticExpansion] - semantic expansion.
* @param {SalIntegrationEnrichmentSettingsTermAssignment} [params.termAssignment] - semantic expansion.
* @param {string} [params.projectId] - wkc project id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createSalIntegrationEnrichmentSettings(params?: WatsonxDataV2.CreateSalIntegrationEnrichmentSettingsParams): Promise>;
/**
* Upload semantic enrichment business terms glossary.
*
* Upload semantic enrichment business terms glossary.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.replaceOption - glossary upload replace option.
* @param {NodeJS.ReadableStream | Buffer} [params.glossaryCsv] - Glossary CSV file.
* @param {string} [params.glossaryCsvContentType] - The content type of glossaryCsv.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createSalIntegrationUploadGlossary(params: WatsonxDataV2.CreateSalIntegrationUploadGlossaryParams): Promise>;
/**
* Get status of upload glossary job.
*
* Get status of upload glossary job.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.processId] - upload process id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSalIntegrationUploadGlossaryStatus(params?: WatsonxDataV2.GetSalIntegrationUploadGlossaryStatusParams): Promise>;
/*************************
* sparkEngines
************************/
/**
* List all spark engines.
*
* List all spark engines.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listSparkEngines(params?: WatsonxDataV2.ListSparkEnginesParams): Promise>;
/**
* Create spark engine.
*
* Create a new spark engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.origin - Origin - created or registered.
* @param {string[]} [params.associatedCatalogs] - Associated catalogs.
* @param {string} [params.description] - Engine description.
* @param {SparkEngineDetailsPrototype} [params.engineDetails] - Node details.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string} [params.status] - Engine status.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.type] - spark type.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createSparkEngine(params: WatsonxDataV2.CreateSparkEngineParams): Promise>;
/**
* Get spark engine.
*
* Get spark engine by ID.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSparkEngine(params: WatsonxDataV2.GetSparkEngineParams): Promise>;
/**
* Delete spark engine.
*
* Delete a spark engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteSparkEngine(params: WatsonxDataV2.DeleteSparkEngineParams): Promise>;
/**
* Update spark engine.
*
* Update details of spark engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.description] - Modified description.
* @param {UpdateSparkEngineBodyEngineDetails} [params.engineDetails] - Engine details.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateSparkEngine(params: WatsonxDataV2.UpdateSparkEngineParams): Promise>;
/**
* List all applications in a spark engine.
*
* List all applications in a spark engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {string[]} [params.state] - state.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listSparkEngineApplications(params: WatsonxDataV2.ListSparkEngineApplicationsParams): Promise>;
/**
* Submit engine applications.
*
* Submit engine applications.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {SparkApplicationDetails} params.applicationDetails - Application details.
* @param {string} [params.jobEndpoint] - Job endpoint.
* @param {string} [params.serviceInstanceId] - Service Instance ID for POST.
* @param {string} [params.type] - Engine Type.
* @param {SparkVolumeDetails[]} [params.volumes] - Spark application volumes to mount.
* @param {string} [params.authInstanceId] - CRN.
* @param {string[]} [params.state] - state.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createSparkEngineApplication(params: WatsonxDataV2.CreateSparkEngineApplicationParams): Promise>;
/**
* Stop Spark Applications.
*
* Stop a running spark application.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.applicationId - Application id(s) to be stopped, comma separated.
* @param {string} [params.authInstanceId] - CRN.
* @param {string[]} [params.state] - state.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteSparkEngineApplications(params: WatsonxDataV2.DeleteSparkEngineApplicationsParams): Promise>;
/**
* Get spark application.
*
* Get status of spark application.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.applicationId - Application id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSparkEngineApplicationStatus(params: WatsonxDataV2.GetSparkEngineApplicationStatusParams): Promise>;
/**
* Get spark engine catalogs.
*
* Get list of all catalogs attached to a spark engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listSparkEngineCatalogs(params: WatsonxDataV2.ListSparkEngineCatalogsParams): Promise>;
/**
* Associate catalogs to spark engine.
*
* Associate one or more catalogs to a spark engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.catalogName] - catalog names.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createSparkEngineCatalogs(params: WatsonxDataV2.CreateSparkEngineCatalogsParams): Promise>;
/**
* Disassociate catalogs from a spark engine.
*
* Disassociate one or more catalogs from a spark engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogNames - Catalog id(s) to be stopped, comma separated.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteSparkEngineCatalogs(params: WatsonxDataV2.DeleteSparkEngineCatalogsParams): Promise>;
/**
* Get spark engine catalog.
*
* Get catalog attached to spark engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogId - catalog id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSparkEngineCatalog(params: WatsonxDataV2.GetSparkEngineCatalogParams): Promise>;
/**
* Get spark history server.
*
* Get spark history server.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getSparkEngineHistoryServer(params: WatsonxDataV2.GetSparkEngineHistoryServerParams): Promise>;
/**
* Start spark history server.
*
* Start spark history server.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.cores] - CPU count.
* @param {string} [params.memory] - Memory in GiB.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
startSparkEngineHistoryServer(params: WatsonxDataV2.StartSparkEngineHistoryServerParams): Promise>;
/**
* Stop spark history server.
*
* Stop spark history server.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteSparkEngineHistoryServer(params: WatsonxDataV2.DeleteSparkEngineHistoryServerParams): Promise>;
/**
* Pause engine.
*
* Pause engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {boolean} [params.force] - force spark engine pause.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
pauseSparkEngine(params: WatsonxDataV2.PauseSparkEngineParams): Promise>;
/**
* Resume engine.
*
* Resume engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
resumeSparkEngine(params: WatsonxDataV2.ResumeSparkEngineParams): Promise>;
/**
* Scale Spark engine.
*
* Scale Saprk engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {number} [params.numberOfNodes] - Node count.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
scaleSparkEngine(params: WatsonxDataV2.ScaleSparkEngineParams): Promise>;
/**
* List spark version.
*
* List spark version.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listSparkVersions(params?: WatsonxDataV2.ListSparkVersionsParams): Promise>;
/*************************
* catalogs
************************/
/**
* List all registered catalogs.
*
* List all registered catalogs.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listCatalogs(params?: WatsonxDataV2.ListCatalogsParams): Promise>;
/**
* Get catalog properties by catalog_id.
*
* Get catalog properties of a catalog identified by catalog_id.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.catalogId - catalog ID.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getCatalog(params: WatsonxDataV2.GetCatalogParams): Promise>;
/**
* List all schemas.
*
* List all schemas in catalog.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine name.
* @param {string} params.catalogId - Catalog name.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listSchemas(params: WatsonxDataV2.ListSchemasParams): Promise>;
/**
* Create schema.
*
* Create a new schema.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine name.
* @param {string} params.catalogId - Catalog name.
* @param {string} params.customPath - Path associated with bucket.
* @param {string} params.schemaName - Schema name.
* @param {string} [params.bucketName] - Bucket associated to metastore where schema will be added.
* @param {string} [params.hostname] - Host name.
* @param {number} [params.port] - Port.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createSchema(params: WatsonxDataV2.CreateSchemaParams): Promise>;
/**
* Delete schema.
*
* Delete a schema.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine name.
* @param {string} params.catalogId - Catalog name.
* @param {string} params.schemaId - URL encoded Schema name.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteSchema(params: WatsonxDataV2.DeleteSchemaParams): Promise>;
/**
* List all tables.
*
* List all tables in a schema in a catalog for a given engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.catalogId - catalog id.
* @param {string} params.schemaId - URL encoded schema name.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listTables(params: WatsonxDataV2.ListTablesParams): Promise>;
/**
* Get table details.
*
* Get details of a given table in a catalog and schema.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.catalogId - catalog id.
* @param {string} params.schemaId - URL encoded schema name.
* @param {string} params.tableId - URL encoded table name.
* @param {string} params.engineId - engine id.
* @param {string} [params.type] - URL encoded table type.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getTable(params: WatsonxDataV2.GetTableParams): Promise>;
/**
* Delete table.
*
* Delete table for a given schema and catalog.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.catalogId - catalog id.
* @param {string} params.schemaId - URL encoded schema name.
* @param {string} params.tableId - URL encoded table name.
* @param {string} params.engineId - engine id.
* @param {string} [params.type] - URL encoded table type.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteTable(params: WatsonxDataV2.DeleteTableParams): Promise>;
/**
* Rename table.
*
* Rename table.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.catalogId - catalog id.
* @param {string} params.schemaId - URL encoded schema name.
* @param {string} params.tableId - URL encoded table name.
* @param {string} params.engineId - engine id.
* @param {string} [params.tableName] - New table name.
* @param {string} [params.type] - URL encoded table type.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateTable(params: WatsonxDataV2.UpdateTableParams): Promise>;
/**
* List all columns of a table.
*
* List all columns of a table in a given a schema for a given catalog.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogId - catalog id.
* @param {string} params.schemaId - URL encoded schema name.
* @param {string} params.tableId - URL encoded schema name.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listColumns(params: WatsonxDataV2.ListColumnsParams): Promise>;
/**
* Add column(s).
*
* Add one or multiple columns to a table in a schema for a given catalog.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogId - catalog id.
* @param {string} params.schemaId - URL encoded schema name.
* @param {string} params.tableId - URL encoded schema name.
* @param {Column[]} [params.columns] - List of the tables present in the schema.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createColumns(params: WatsonxDataV2.CreateColumnsParams): Promise>;
/**
* Delete column.
*
* Delete column in a table for a given schema and catalog.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogId - catalog id.
* @param {string} params.schemaId - URL encoded schema name.
* @param {string} params.tableId - URL encoded schema name.
* @param {string} params.columnId - URL encoded schema name.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteColumn(params: WatsonxDataV2.DeleteColumnParams): Promise>;
/**
* Alter column.
*
* Update the given column - rename column.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogId - catalog id.
* @param {string} params.schemaId - URL encoded schema name.
* @param {string} params.tableId - URL encoded schema name.
* @param {string} params.columnId - URL encoded schema name.
* @param {string} [params.columnName] - Column name.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateColumn(params: WatsonxDataV2.UpdateColumnParams): Promise>;
/**
* Get table snapshots.
*
* List all table snapshots.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine name.
* @param {string} params.catalogId - Catalog ID.
* @param {string} params.schemaId - Schema ID.
* @param {string} params.tableId - Table ID.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listTableSnapshots(params: WatsonxDataV2.ListTableSnapshotsParams): Promise>;
/**
* Rollback table to snapshot.
*
* Rollback table to a snapshot.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine name.
* @param {string} params.catalogId - Catalog ID.
* @param {string} params.schemaId - Schema ID.
* @param {string} params.tableId - Table ID.
* @param {string} [params.snapshotId] - Snapshot Id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
rollbackTable(params: WatsonxDataV2.RollbackTableParams): Promise>;
/**
* External Iceberg table registration.
*
* Synchronize the external Iceberg table registration for a catalog identified by catalog_id.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.catalogId - catalog ID.
* @param {boolean} [params.autoAddNewTables] - Auto add new table.
* @param {boolean} [params.syncIcebergMd] - Sync iceberg metadata.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateSyncCatalog(params: WatsonxDataV2.UpdateSyncCatalogParams): Promise>;
/*************************
* services
************************/
/**
* Get list of milvus services.
*
* Get list milvus services.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listMilvusServices(params?: WatsonxDataV2.ListMilvusServicesParams): Promise